Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkJsonArray.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "{{secretId}}")
CkHttp::setCkPassword(http, "{{secretPassword}}")
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "session": "39cd6a88-8ee3-4e59-a861-b8a2187e0f4c",
; "token": "1234ab",
; "link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
; "save_data": true
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"session","39cd6a88-8ee3-4e59-a861-b8a2187e0f4c")
CkJsonObject::ckUpdateString(json,"token","1234ab")
CkJsonObject::ckUpdateString(json,"link","683005d6-f45c-4adb-b289-f1a12f50f80c")
CkJsonObject::ckUpdateBool(json,"save_data",1)
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PATCH","https://domain.com/api/transactions/",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jarrResp.i = CkJsonArray::ckCreate()
If jarrResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonArray::ckLoadSb(jarrResp,sbResponseBody)
CkJsonArray::setCkEmitCompact(jarrResp, 0)
Debug "Response Body:"
Debug CkJsonArray::ckEmit(jarrResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonArray::ckDispose(jarrResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; [
; {
; "account": {
; "link": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "institution": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "collected_at": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "category": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "name": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "number": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "balance": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "currency": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "bank_product_id": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "internal_identification": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "public_identification_name": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "public_identification_value": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "last_accessed_at": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "credit_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "loan_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "funds_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "gig_payment_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; },
; "collected_at": "<date>",
; "value_date": "<string>",
; "accounting_date": "<date>",
; "amount": "<number>",
; "balance": "<number>",
; "currency": "<string>",
; "description": "<string>",
; "observations": "<string>",
; "category": "<string>",
; "reference": "<string>",
; "type": "in aliqua exercitation Ut ipsum",
; "status": "aliqua veniam in",
; "gig_data": {
; "pickup_at": "<dateTime>",
; "dropoff_at": "<dateTime>",
; "request_at": "<dateTime>",
; "pickup_address": "<string>",
; "dropoff_address": "<string>",
; "pickup_latitude": "<number>",
; "pickup_longitude": "<number>",
; "dropoff_latitude": "<number>",
; "dropoff_longitude": "<number>",
; "distance": "<number>",
; "payment_method": "<string>",
; "vehicle_type": "<string>",
; "merchant_type": "<string>",
; "breakdown": [
; {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; ],
; "collected_at": "<dateTime>"
; },
; "credit_card_data": {
; "bill_name": "<string>"
; }
; },
; {
; "account": {
; "link": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "institution": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "collected_at": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "category": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "name": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "number": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "balance": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "currency": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "bank_product_id": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "internal_identification": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "public_identification_name": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "public_identification_value": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "last_accessed_at": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "credit_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "loan_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "funds_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "gig_payment_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; },
; "collected_at": "<date>",
; "value_date": "<string>",
; "accounting_date": "<date>",
; "amount": "<number>",
; "balance": "<number>",
; "currency": "<string>",
; "description": "<string>",
; "observations": "<string>",
; "category": "<string>",
; "reference": "<string>",
; "type": "ad cupidatat nisi",
; "status": "eiusmod",
; "gig_data": {
; "pickup_at": "<dateTime>",
; "dropoff_at": "<dateTime>",
; "request_at": "<dateTime>",
; "pickup_address": "<string>",
; "dropoff_address": "<string>",
; "pickup_latitude": "<number>",
; "pickup_longitude": "<number>",
; "dropoff_latitude": "<number>",
; "dropoff_longitude": "<number>",
; "distance": "<number>",
; "payment_method": "<string>",
; "vehicle_type": "<string>",
; "merchant_type": "<string>",
; "breakdown": [
; {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; ],
; "collected_at": "<dateTime>"
; },
; "credit_card_data": {
; "bill_name": "<string>"
; }
; }
; ]
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
json.i
Value.s
InstitutionValue.s
Collected_atValue.s
CategoryValue.s
TypeValue.s
NameValue.s
NumberValue.s
BalanceValue.s
CurrencyValue.s
Bank_product_idValue.s
Internal_identificationValue.s
Public_identification_nameValue.s
Public_identification_valueValue.s
Last_accessed_atValue.s
Credit_dataValue.s
Loan_dataValue.s
Funds_dataValue.s
Gig_payment_dataValue.s
collected_at.s
value_date.s
accounting_date.s
amount.s
balance.s
v_currency.s
description.s
observations.s
category.s
reference.s
v_type.s
status.s
Pickup_at.s
Dropoff_at.s
Request_at.s
Pickup_address.s
Dropoff_address.s
Pickup_latitude.s
Pickup_longitude.s
Dropoff_latitude.s
Dropoff_longitude.s
Distance.s
Payment_method.s
Vehicle_type.s
Merchant_type.s
Collected_at.s
Bill_name.s
j.i
count_j.i
value.s
i.i = 0
count_i.i = CkJsonArray::ckSize(jarrResp)
While i < count_i
json = CkJsonArray::ckObjectAt(jarrResp,i)
Value = CkJsonObject::ckStringOf(json,"account.link.value")
InstitutionValue = CkJsonObject::ckStringOf(json,"account.institution.value")
Collected_atValue = CkJsonObject::ckStringOf(json,"account.collected_at.value")
CategoryValue = CkJsonObject::ckStringOf(json,"account.category.value")
TypeValue = CkJsonObject::ckStringOf(json,"account.type.value")
NameValue = CkJsonObject::ckStringOf(json,"account.name.value")
NumberValue = CkJsonObject::ckStringOf(json,"account.number.value")
BalanceValue = CkJsonObject::ckStringOf(json,"account.balance.value")
CurrencyValue = CkJsonObject::ckStringOf(json,"account.currency.value")
Bank_product_idValue = CkJsonObject::ckStringOf(json,"account.bank_product_id.value")
Internal_identificationValue = CkJsonObject::ckStringOf(json,"account.internal_identification.value")
Public_identification_nameValue = CkJsonObject::ckStringOf(json,"account.public_identification_name.value")
Public_identification_valueValue = CkJsonObject::ckStringOf(json,"account.public_identification_value.value")
Last_accessed_atValue = CkJsonObject::ckStringOf(json,"account.last_accessed_at.value")
Credit_dataValue = CkJsonObject::ckStringOf(json,"account.credit_data.value")
Loan_dataValue = CkJsonObject::ckStringOf(json,"account.loan_data.value")
Funds_dataValue = CkJsonObject::ckStringOf(json,"account.funds_data.value")
Gig_payment_dataValue = CkJsonObject::ckStringOf(json,"account.gig_payment_data.value")
collected_at = CkJsonObject::ckStringOf(json,"collected_at")
value_date = CkJsonObject::ckStringOf(json,"value_date")
accounting_date = CkJsonObject::ckStringOf(json,"accounting_date")
amount = CkJsonObject::ckStringOf(json,"amount")
balance = CkJsonObject::ckStringOf(json,"balance")
v_currency = CkJsonObject::ckStringOf(json,"currency")
description = CkJsonObject::ckStringOf(json,"description")
observations = CkJsonObject::ckStringOf(json,"observations")
category = CkJsonObject::ckStringOf(json,"category")
reference = CkJsonObject::ckStringOf(json,"reference")
v_type = CkJsonObject::ckStringOf(json,"type")
status = CkJsonObject::ckStringOf(json,"status")
Pickup_at = CkJsonObject::ckStringOf(json,"gig_data.pickup_at")
Dropoff_at = CkJsonObject::ckStringOf(json,"gig_data.dropoff_at")
Request_at = CkJsonObject::ckStringOf(json,"gig_data.request_at")
Pickup_address = CkJsonObject::ckStringOf(json,"gig_data.pickup_address")
Dropoff_address = CkJsonObject::ckStringOf(json,"gig_data.dropoff_address")
Pickup_latitude = CkJsonObject::ckStringOf(json,"gig_data.pickup_latitude")
Pickup_longitude = CkJsonObject::ckStringOf(json,"gig_data.pickup_longitude")
Dropoff_latitude = CkJsonObject::ckStringOf(json,"gig_data.dropoff_latitude")
Dropoff_longitude = CkJsonObject::ckStringOf(json,"gig_data.dropoff_longitude")
Distance = CkJsonObject::ckStringOf(json,"gig_data.distance")
Payment_method = CkJsonObject::ckStringOf(json,"gig_data.payment_method")
Vehicle_type = CkJsonObject::ckStringOf(json,"gig_data.vehicle_type")
Merchant_type = CkJsonObject::ckStringOf(json,"gig_data.merchant_type")
Collected_at = CkJsonObject::ckStringOf(json,"gig_data.collected_at")
Bill_name = CkJsonObject::ckStringOf(json,"credit_card_data.bill_name")
j = 0
count_j = CkJsonObject::ckSizeOfArray(json,"gig_data.breakdown")
While j < count_j
CkJsonObject::setCkJ(json, j)
value = CkJsonObject::ckStringOf(json,"gig_data.breakdown[j].value")
j = j + 1
Wend
CkJsonObject::ckDispose(json)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonArray::ckDispose(jarrResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PATCH
-u '{{secretId}}:{{secretPassword}}'
-H "Content-Type: application/json"
-d '{
"session": "39cd6a88-8ee3-4e59-a861-b8a2187e0f4c",
"token": "1234ab",
"link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
"save_data": true
}'
https://domain.com/api/transactions/
Postman Collection Item JSON
{
"name": "Resume",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"session\": \"39cd6a88-8ee3-4e59-a861-b8a2187e0f4c\",\n \"token\": \"1234ab\",\n \"link\": \"683005d6-f45c-4adb-b289-f1a12f50f80c\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/transactions/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
""
]
},
"description": "Used to resume a Transaction retrieve session that was paused because an MFA token was required by the institution."
},
"response": [
{
"name": "Ok (when save_data=false)",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/transactions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"account\": {\n\t\t\t\"link\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"institution\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"category\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"number\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"bank_product_id\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"last_accessed_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"credit_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"loan_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"funds_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"gig_payment_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t\"collected_at\": \"<date>\",\n\t\t\"value_date\": \"<string>\",\n\t\t\"accounting_date\": \"<date>\",\n\t\t\"amount\": \"<number>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"currency\": \"<string>\",\n\t\t\"description\": \"<string>\",\n\t\t\"observations\": \"<string>\",\n\t\t\"category\": \"<string>\",\n\t\t\"reference\": \"<string>\",\n\t\t\"type\": \"in aliqua exercitation Ut ipsum\",\n\t\t\"status\": \"aliqua veniam in\",\n\t\t\"gig_data\": {\n\t\t\t\"pickup_at\": \"<dateTime>\",\n\t\t\t\"dropoff_at\": \"<dateTime>\",\n\t\t\t\"request_at\": \"<dateTime>\",\n\t\t\t\"pickup_address\": \"<string>\",\n\t\t\t\"dropoff_address\": \"<string>\",\n\t\t\t\"pickup_latitude\": \"<number>\",\n\t\t\t\"pickup_longitude\": \"<number>\",\n\t\t\t\"dropoff_latitude\": \"<number>\",\n\t\t\t\"dropoff_longitude\": \"<number>\",\n\t\t\t\"distance\": \"<number>\",\n\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\"vehicle_type\": \"<string>\",\n\t\t\t\"merchant_type\": \"<string>\",\n\t\t\t\"breakdown\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"collected_at\": \"<dateTime>\"\n\t\t},\n\t\t\"credit_card_data\": {\n\t\t\t\"bill_name\": \"<string>\"\n\t\t}\n\t},\n\t{\n\t\t\"account\": {\n\t\t\t\"link\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"institution\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"category\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"number\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"bank_product_id\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"last_accessed_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"credit_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"loan_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"funds_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"gig_payment_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t\"collected_at\": \"<date>\",\n\t\t\"value_date\": \"<string>\",\n\t\t\"accounting_date\": \"<date>\",\n\t\t\"amount\": \"<number>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"currency\": \"<string>\",\n\t\t\"description\": \"<string>\",\n\t\t\"observations\": \"<string>\",\n\t\t\"category\": \"<string>\",\n\t\t\"reference\": \"<string>\",\n\t\t\"type\": \"ad cupidatat nisi\",\n\t\t\"status\": \"eiusmod\",\n\t\t\"gig_data\": {\n\t\t\t\"pickup_at\": \"<dateTime>\",\n\t\t\t\"dropoff_at\": \"<dateTime>\",\n\t\t\t\"request_at\": \"<dateTime>\",\n\t\t\t\"pickup_address\": \"<string>\",\n\t\t\t\"dropoff_address\": \"<string>\",\n\t\t\t\"pickup_latitude\": \"<number>\",\n\t\t\t\"pickup_longitude\": \"<number>\",\n\t\t\t\"dropoff_latitude\": \"<number>\",\n\t\t\t\"dropoff_longitude\": \"<number>\",\n\t\t\t\"distance\": \"<number>\",\n\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\"vehicle_type\": \"<string>\",\n\t\t\t\"merchant_type\": \"<string>\",\n\t\t\t\"breakdown\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"collected_at\": \"<dateTime>\"\n\t\t},\n\t\t\"credit_card_data\": {\n\t\t\t\"bill_name\": \"<string>\"\n\t\t}\n\t}\n]"
},
{
"name": "Created (when save_data=true)",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/transactions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"link\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"institution\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"category\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"number\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"bank_product_id\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"last_accessed_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"credit_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"loan_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"funds_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"gig_payment_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t\"collected_at\": \"<date>\",\n\t\t\"value_date\": \"<string>\",\n\t\t\"accounting_date\": \"<date>\",\n\t\t\"amount\": \"<number>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"currency\": \"<string>\",\n\t\t\"description\": \"<string>\",\n\t\t\"observations\": \"<string>\",\n\t\t\"category\": \"<string>\",\n\t\t\"reference\": \"<string>\",\n\t\t\"type\": \"deserun\",\n\t\t\"status\": \"elit tempor aliquip\",\n\t\t\"gig_data\": {\n\t\t\t\"pickup_at\": \"<dateTime>\",\n\t\t\t\"dropoff_at\": \"<dateTime>\",\n\t\t\t\"request_at\": \"<dateTime>\",\n\t\t\t\"pickup_address\": \"<string>\",\n\t\t\t\"dropoff_address\": \"<string>\",\n\t\t\t\"pickup_latitude\": \"<number>\",\n\t\t\t\"pickup_longitude\": \"<number>\",\n\t\t\t\"dropoff_latitude\": \"<number>\",\n\t\t\t\"dropoff_longitude\": \"<number>\",\n\t\t\t\"distance\": \"<number>\",\n\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\"vehicle_type\": \"<string>\",\n\t\t\t\"merchant_type\": \"<string>\",\n\t\t\t\"breakdown\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"collected_at\": \"<dateTime>\"\n\t\t},\n\t\t\"credit_card_data\": {\n\t\t\t\"bill_name\": \"<string>\"\n\t\t}\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"link\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"institution\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"category\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"number\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"bank_product_id\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"last_accessed_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"credit_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"loan_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"funds_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"gig_payment_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t\"collected_at\": \"<date>\",\n\t\t\"value_date\": \"<string>\",\n\t\t\"accounting_date\": \"<date>\",\n\t\t\"amount\": \"<number>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"currency\": \"<string>\",\n\t\t\"description\": \"<string>\",\n\t\t\"observations\": \"<string>\",\n\t\t\"category\": \"<string>\",\n\t\t\"reference\": \"<string>\",\n\t\t\"type\": \"amet eiusmod\",\n\t\t\"status\": \"amet exercitation\",\n\t\t\"gig_data\": {\n\t\t\t\"pickup_at\": \"<dateTime>\",\n\t\t\t\"dropoff_at\": \"<dateTime>\",\n\t\t\t\"request_at\": \"<dateTime>\",\n\t\t\t\"pickup_address\": \"<string>\",\n\t\t\t\"dropoff_address\": \"<string>\",\n\t\t\t\"pickup_latitude\": \"<number>\",\n\t\t\t\"pickup_longitude\": \"<number>\",\n\t\t\t\"dropoff_latitude\": \"<number>\",\n\t\t\t\"dropoff_longitude\": \"<number>\",\n\t\t\t\"distance\": \"<number>\",\n\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\"vehicle_type\": \"<string>\",\n\t\t\t\"merchant_type\": \"<string>\",\n\t\t\t\"breakdown\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"collected_at\": \"<dateTime>\"\n\t\t},\n\t\t\"credit_card_data\": {\n\t\t\t\"bill_name\": \"<string>\"\n\t\t}\n\t}\n]"
},
{
"name": "Bad request error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/transactions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/transactions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Request Timeout",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/transactions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions"
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "MFA Token Required",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/transactions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions"
]
}
},
"status": "Precondition Required",
"code": 428,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"code\": \"<string>\",\n\t\"message\": \"<string>\",\n\t\"request_id\": \"<uuid>\",\n\t\"session\": \"<uuid>\",\n\t\"expiry\": \"<integer>\",\n\t\"link\": \"<uuid>\",\n\t\"token_generation_data\": {\n\t\t\"instructions\": \"<string>\",\n\t\t\"type\": \"<string>\",\n\t\t\"value\": \"<string>\"\n\t}\n}"
},
{
"name": "Unexpected Error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/transactions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}