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.
; {
; "link": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
; "account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
; "year": "magna nisi",
; "month": "dolor commodo esse do",
; "token": "1234ab",
; "attach_pdf": false,
; "save_data": true
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"link","d4617561-1c01-4b2f-83b6-a594f7b3bc57")
CkJsonObject::ckUpdateString(json,"account","d4617561-1c01-4b2f-83b6-a594f7b3bc57")
CkJsonObject::ckUpdateString(json,"year","magna nisi")
CkJsonObject::ckUpdateString(json,"month","dolor commodo esse do")
CkJsonObject::ckUpdateString(json,"token","1234ab")
CkJsonObject::ckUpdateBool(json,"attach_pdf",0)
CkJsonObject::ckUpdateBool(json,"save_data",1)
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/statements/","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
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(sbResponseBody)
CkJsonArray::ckDispose(jarrResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; [
; {
; "link": "<string>",
; "account": {
; "id": "<uuid>",
; "name": "<string>",
; "category": "laboris Ut laborum officia id",
; "currency": "<string>"
; },
; "collected_at": "<dateTime>",
; "account_number": "<string>",
; "client_number": "<string>",
; "RFC": "<string>",
; "CLABE": "<string>",
; "period_start_date": "<date>",
; "period_end_date": "<date>",
; "cut_date": "<string>",
; "final_balance": "<number>",
; "previous_balance": "<number>",
; "total_inflow_amount": "<number>",
; "total_outflow_amount": "<number>",
; "total_inflow_transactions": "<number>",
; "total_outflow_transactions": "<number>",
; "transactions": [
; {
; "collected_at": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "accounting_date": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "value_date": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "reference": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "observations": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "additional_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "balance": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "status": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "currency": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "description": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "internal_identification": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "account": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; },
; {
; "collected_at": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "accounting_date": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "value_date": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "reference": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "observations": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "additional_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "balance": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "status": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "currency": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "description": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "internal_identification": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "account": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; }
; ],
; "pdf": "<binary>"
; },
; {
; "link": "<string>",
; "account": {
; "id": "<uuid>",
; "name": "<string>",
; "category": "incididunt laboris",
; "currency": "<string>"
; },
; "collected_at": "<dateTime>",
; "account_number": "<string>",
; "client_number": "<string>",
; "RFC": "<string>",
; "CLABE": "<string>",
; "period_start_date": "<date>",
; "period_end_date": "<date>",
; "cut_date": "<string>",
; "final_balance": "<number>",
; "previous_balance": "<number>",
; "total_inflow_amount": "<number>",
; "total_outflow_amount": "<number>",
; "total_inflow_transactions": "<number>",
; "total_outflow_transactions": "<number>",
; "transactions": [
; {
; "collected_at": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "accounting_date": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "value_date": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "reference": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "observations": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "additional_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "balance": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "status": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "currency": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "description": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "internal_identification": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "account": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; },
; {
; "collected_at": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "accounting_date": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "value_date": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "reference": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "observations": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "additional_data": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "balance": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "status": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "currency": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "description": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "internal_identification": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "account": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; }
; ],
; "pdf": "<binary>"
; }
; ]
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
json.i
link.s
Id.s
Name.s
Category.s
v_Currency.s
collected_at.s
account_number.s
client_number.s
RFC.s
CLABE.s
period_start_date.s
period_end_date.s
cut_date.s
final_balance.s
previous_balance.s
total_inflow_amount.s
total_outflow_amount.s
total_inflow_transactions.s
total_outflow_transactions.s
pdf.s
j.i
count_j.i
Value.s
accounting_dateValue.s
value_dateValue.s
referenceValue.s
observationsValue.s
additional_dataValue.s
balanceValue.s
statusValue.s
typeValue.s
currencyValue.s
descriptionValue.s
internal_identificationValue.s
accountValue.s
i.i = 0
count_i.i = CkJsonArray::ckSize(jarrResp)
While i < count_i
json = CkJsonArray::ckObjectAt(jarrResp,i)
link = CkJsonObject::ckStringOf(json,"link")
Id = CkJsonObject::ckStringOf(json,"account.id")
Name = CkJsonObject::ckStringOf(json,"account.name")
Category = CkJsonObject::ckStringOf(json,"account.category")
v_Currency = CkJsonObject::ckStringOf(json,"account.currency")
collected_at = CkJsonObject::ckStringOf(json,"collected_at")
account_number = CkJsonObject::ckStringOf(json,"account_number")
client_number = CkJsonObject::ckStringOf(json,"client_number")
RFC = CkJsonObject::ckStringOf(json,"RFC")
CLABE = CkJsonObject::ckStringOf(json,"CLABE")
period_start_date = CkJsonObject::ckStringOf(json,"period_start_date")
period_end_date = CkJsonObject::ckStringOf(json,"period_end_date")
cut_date = CkJsonObject::ckStringOf(json,"cut_date")
final_balance = CkJsonObject::ckStringOf(json,"final_balance")
previous_balance = CkJsonObject::ckStringOf(json,"previous_balance")
total_inflow_amount = CkJsonObject::ckStringOf(json,"total_inflow_amount")
total_outflow_amount = CkJsonObject::ckStringOf(json,"total_outflow_amount")
total_inflow_transactions = CkJsonObject::ckStringOf(json,"total_inflow_transactions")
total_outflow_transactions = CkJsonObject::ckStringOf(json,"total_outflow_transactions")
pdf = CkJsonObject::ckStringOf(json,"pdf")
j = 0
count_j = CkJsonObject::ckSizeOfArray(json,"transactions")
While j < count_j
CkJsonObject::setCkJ(json, j)
Value = CkJsonObject::ckStringOf(json,"transactions[j].collected_at.value")
accounting_dateValue = CkJsonObject::ckStringOf(json,"transactions[j].accounting_date.value")
value_dateValue = CkJsonObject::ckStringOf(json,"transactions[j].value_date.value")
referenceValue = CkJsonObject::ckStringOf(json,"transactions[j].reference.value")
observationsValue = CkJsonObject::ckStringOf(json,"transactions[j].observations.value")
additional_dataValue = CkJsonObject::ckStringOf(json,"transactions[j].additional_data.value")
balanceValue = CkJsonObject::ckStringOf(json,"transactions[j].balance.value")
statusValue = CkJsonObject::ckStringOf(json,"transactions[j].status.value")
typeValue = CkJsonObject::ckStringOf(json,"transactions[j].type.value")
currencyValue = CkJsonObject::ckStringOf(json,"transactions[j].currency.value")
descriptionValue = CkJsonObject::ckStringOf(json,"transactions[j].description.value")
internal_identificationValue = CkJsonObject::ckStringOf(json,"transactions[j].internal_identification.value")
accountValue = CkJsonObject::ckStringOf(json,"transactions[j].account.value")
j = j + 1
Wend
CkJsonObject::ckDispose(json)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonArray::ckDispose(jarrResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-u '{{secretId}}:{{secretPassword}}'
-H "Content-Type: application/json"
-d '{
"link": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
"account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
"year": "magna nisi",
"month": "dolor commodo esse do",
"token": "1234ab",
"attach_pdf": false,
"save_data": true
}'
https://domain.com/api/statements/
Postman Collection Item JSON
{
"name": "Retrieve",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"link\": \"d4617561-1c01-4b2f-83b6-a594f7b3bc57\",\n \"account\": \"d4617561-1c01-4b2f-83b6-a594f7b3bc57\",\n \"year\": \"magna nisi\",\n \"month\": \"dolor commodo esse do\",\n \"token\": \"1234ab\",\n \"attach_pdf\": false,\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/statements/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
""
]
},
"description": "Retrieve statements information for a specific banking link.\n"
},
"response": [
{
"name": "Ok (when save_data=false)",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"link\": \"<uuid>\",\n \"account\": \"<uuid>\",\n \"year\": \"<string>\",\n \"month\": \"<string>\",\n \"token\": \"<string>\",\n \"attach_pdf\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/statements",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"link\": \"<string>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"laboris Ut laborum officia id\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account_number\": \"<string>\",\n\t\t\"client_number\": \"<string>\",\n\t\t\"RFC\": \"<string>\",\n\t\t\"CLABE\": \"<string>\",\n\t\t\"period_start_date\": \"<date>\",\n\t\t\"period_end_date\": \"<date>\",\n\t\t\"cut_date\": \"<string>\",\n\t\t\"final_balance\": \"<number>\",\n\t\t\"previous_balance\": \"<number>\",\n\t\t\"total_inflow_amount\": \"<number>\",\n\t\t\"total_outflow_amount\": \"<number>\",\n\t\t\"total_inflow_transactions\": \"<number>\",\n\t\t\"total_outflow_transactions\": \"<number>\",\n\t\t\"transactions\": [\n\t\t\t{\n\t\t\t\t\"collected_at\": {\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\"accounting_date\": {\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\"value_date\": {\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\"reference\": {\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\"observations\": {\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\"additional_data\": {\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\"balance\": {\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\"status\": {\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\"type\": {\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\"currency\": {\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\"description\": {\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\"internal_identification\": {\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\"account\": {\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{\n\t\t\t\t\"collected_at\": {\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\"accounting_date\": {\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\"value_date\": {\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\"reference\": {\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\"observations\": {\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\"additional_data\": {\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\"balance\": {\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\"status\": {\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\"type\": {\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\"currency\": {\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\"description\": {\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\"internal_identification\": {\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\"account\": {\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],\n\t\t\"pdf\": \"<binary>\"\n\t},\n\t{\n\t\t\"link\": \"<string>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"incididunt laboris\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account_number\": \"<string>\",\n\t\t\"client_number\": \"<string>\",\n\t\t\"RFC\": \"<string>\",\n\t\t\"CLABE\": \"<string>\",\n\t\t\"period_start_date\": \"<date>\",\n\t\t\"period_end_date\": \"<date>\",\n\t\t\"cut_date\": \"<string>\",\n\t\t\"final_balance\": \"<number>\",\n\t\t\"previous_balance\": \"<number>\",\n\t\t\"total_inflow_amount\": \"<number>\",\n\t\t\"total_outflow_amount\": \"<number>\",\n\t\t\"total_inflow_transactions\": \"<number>\",\n\t\t\"total_outflow_transactions\": \"<number>\",\n\t\t\"transactions\": [\n\t\t\t{\n\t\t\t\t\"collected_at\": {\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\"accounting_date\": {\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\"value_date\": {\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\"reference\": {\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\"observations\": {\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\"additional_data\": {\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\"balance\": {\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\"status\": {\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\"type\": {\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\"currency\": {\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\"description\": {\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\"internal_identification\": {\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\"account\": {\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{\n\t\t\t\t\"collected_at\": {\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\"accounting_date\": {\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\"value_date\": {\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\"reference\": {\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\"observations\": {\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\"additional_data\": {\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\"balance\": {\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\"status\": {\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\"type\": {\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\"currency\": {\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\"description\": {\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\"internal_identification\": {\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\"account\": {\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],\n\t\t\"pdf\": \"<binary>\"\n\t}\n]"
},
{
"name": "Created (when save_data=true)",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"link\": \"<uuid>\",\n \"account\": \"<uuid>\",\n \"year\": \"<string>\",\n \"month\": \"<string>\",\n \"token\": \"<string>\",\n \"attach_pdf\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/statements",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements"
]
}
},
"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\"link\": \"<string>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"in anim \",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account_number\": \"<string>\",\n\t\t\"client_number\": \"<string>\",\n\t\t\"RFC\": \"<string>\",\n\t\t\"CLABE\": \"<string>\",\n\t\t\"period_start_date\": \"<date>\",\n\t\t\"period_end_date\": \"<date>\",\n\t\t\"cut_date\": \"<string>\",\n\t\t\"final_balance\": \"<number>\",\n\t\t\"previous_balance\": \"<number>\",\n\t\t\"total_inflow_amount\": \"<number>\",\n\t\t\"total_outflow_amount\": \"<number>\",\n\t\t\"total_inflow_transactions\": \"<number>\",\n\t\t\"total_outflow_transactions\": \"<number>\",\n\t\t\"transactions\": [\n\t\t\t{\n\t\t\t\t\"collected_at\": {\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\"accounting_date\": {\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\"value_date\": {\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\"reference\": {\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\"observations\": {\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\"additional_data\": {\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\"balance\": {\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\"status\": {\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\"type\": {\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\"currency\": {\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\"description\": {\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\"internal_identification\": {\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\"account\": {\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{\n\t\t\t\t\"collected_at\": {\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\"accounting_date\": {\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\"value_date\": {\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\"reference\": {\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\"observations\": {\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\"additional_data\": {\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\"balance\": {\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\"status\": {\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\"type\": {\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\"currency\": {\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\"description\": {\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\"internal_identification\": {\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\"account\": {\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],\n\t\t\"pdf\": \"<binary>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"link\": \"<string>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"ut minim exercitat\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account_number\": \"<string>\",\n\t\t\"client_number\": \"<string>\",\n\t\t\"RFC\": \"<string>\",\n\t\t\"CLABE\": \"<string>\",\n\t\t\"period_start_date\": \"<date>\",\n\t\t\"period_end_date\": \"<date>\",\n\t\t\"cut_date\": \"<string>\",\n\t\t\"final_balance\": \"<number>\",\n\t\t\"previous_balance\": \"<number>\",\n\t\t\"total_inflow_amount\": \"<number>\",\n\t\t\"total_outflow_amount\": \"<number>\",\n\t\t\"total_inflow_transactions\": \"<number>\",\n\t\t\"total_outflow_transactions\": \"<number>\",\n\t\t\"transactions\": [\n\t\t\t{\n\t\t\t\t\"collected_at\": {\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\"accounting_date\": {\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\"value_date\": {\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\"reference\": {\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\"observations\": {\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\"additional_data\": {\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\"balance\": {\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\"status\": {\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\"type\": {\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\"currency\": {\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\"description\": {\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\"internal_identification\": {\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\"account\": {\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{\n\t\t\t\t\"collected_at\": {\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\"accounting_date\": {\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\"value_date\": {\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\"reference\": {\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\"observations\": {\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\"additional_data\": {\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\"balance\": {\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\"status\": {\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\"type\": {\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\"currency\": {\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\"description\": {\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\"internal_identification\": {\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\"account\": {\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],\n\t\t\"pdf\": \"<binary>\"\n\t}\n]"
},
{
"name": "Bad request error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"link\": \"<uuid>\",\n \"account\": \"<uuid>\",\n \"year\": \"<string>\",\n \"month\": \"<string>\",\n \"token\": \"<string>\",\n \"attach_pdf\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/statements",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements"
]
}
},
"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": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"link\": \"<uuid>\",\n \"account\": \"<uuid>\",\n \"year\": \"<string>\",\n \"month\": \"<string>\",\n \"token\": \"<string>\",\n \"attach_pdf\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/statements",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements"
]
}
},
"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": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"link\": \"<uuid>\",\n \"account\": \"<uuid>\",\n \"year\": \"<string>\",\n \"month\": \"<string>\",\n \"token\": \"<string>\",\n \"attach_pdf\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/statements",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements"
]
}
},
"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": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"link\": \"<uuid>\",\n \"account\": \"<uuid>\",\n \"year\": \"<string>\",\n \"month\": \"<string>\",\n \"token\": \"<string>\",\n \"attach_pdf\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/statements",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements"
]
}
},
"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": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"link\": \"<uuid>\",\n \"account\": \"<uuid>\",\n \"year\": \"<string>\",\n \"month\": \"<string>\",\n \"token\": \"<string>\",\n \"attach_pdf\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/statements",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements"
]
}
},
"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]"
}
]
}