Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
http.put_BasicAuth(true)
http.put_Login("{{secretId}}")
http.put_Password("{{secretPassword}}")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/api/statements/",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "count": "<integer>",
# "next": "<string>",
# "previous": "<string>",
# "results": [
# {
# "id": "<uuid>",
# "link": "<string>",
# "account": {
# "id": "<uuid>",
# "name": "<string>",
# "category": "minim amet pariatur",
# "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>"
# },
# {
# "id": "<uuid>",
# "link": "<string>",
# "account": {
# "id": "<uuid>",
# "name": "<string>",
# "category": "veniam occaecat",
# "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
count = jResp.stringOf("count")
v_next = jResp.stringOf("next")
previous = jResp.stringOf("previous")
i = 0
count_i = jResp.SizeOfArray("results")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("results[i].id")
link = jResp.stringOf("results[i].link")
Id = jResp.stringOf("results[i].account.id")
Name = jResp.stringOf("results[i].account.name")
Category = jResp.stringOf("results[i].account.category")
v_Currency = jResp.stringOf("results[i].account.currency")
collected_at = jResp.stringOf("results[i].collected_at")
account_number = jResp.stringOf("results[i].account_number")
client_number = jResp.stringOf("results[i].client_number")
RFC = jResp.stringOf("results[i].RFC")
CLABE = jResp.stringOf("results[i].CLABE")
period_start_date = jResp.stringOf("results[i].period_start_date")
period_end_date = jResp.stringOf("results[i].period_end_date")
cut_date = jResp.stringOf("results[i].cut_date")
final_balance = jResp.stringOf("results[i].final_balance")
previous_balance = jResp.stringOf("results[i].previous_balance")
total_inflow_amount = jResp.stringOf("results[i].total_inflow_amount")
total_outflow_amount = jResp.stringOf("results[i].total_outflow_amount")
total_inflow_transactions = jResp.stringOf("results[i].total_inflow_transactions")
total_outflow_transactions = jResp.stringOf("results[i].total_outflow_transactions")
pdf = jResp.stringOf("results[i].pdf")
j = 0
count_j = jResp.SizeOfArray("results[i].transactions")
while j < count_j
jResp.put_J(j)
Value = jResp.stringOf("results[i].transactions[j].collected_at.value")
accounting_dateValue = jResp.stringOf("results[i].transactions[j].accounting_date.value")
value_dateValue = jResp.stringOf("results[i].transactions[j].value_date.value")
referenceValue = jResp.stringOf("results[i].transactions[j].reference.value")
observationsValue = jResp.stringOf("results[i].transactions[j].observations.value")
additional_dataValue = jResp.stringOf("results[i].transactions[j].additional_data.value")
balanceValue = jResp.stringOf("results[i].transactions[j].balance.value")
statusValue = jResp.stringOf("results[i].transactions[j].status.value")
typeValue = jResp.stringOf("results[i].transactions[j].type.value")
currencyValue = jResp.stringOf("results[i].transactions[j].currency.value")
descriptionValue = jResp.stringOf("results[i].transactions[j].description.value")
internal_identificationValue = jResp.stringOf("results[i].transactions[j].internal_identification.value")
accountValue = jResp.stringOf("results[i].transactions[j].account.value")
j = j + 1
end
i = i + 1
end
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/statements/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/statements/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
""
]
},
"description": "Get a paginated list of all existing statements in your Belvo account. We return up to 100 results per page."
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"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\"count\": \"<integer>\",\n\t\"next\": \"<string>\",\n\t\"previous\": \"<string>\",\n\t\"results\": [\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"link\": \"<string>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"category\": \"minim amet pariatur\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"account_number\": \"<string>\",\n\t\t\t\"client_number\": \"<string>\",\n\t\t\t\"RFC\": \"<string>\",\n\t\t\t\"CLABE\": \"<string>\",\n\t\t\t\"period_start_date\": \"<date>\",\n\t\t\t\"period_end_date\": \"<date>\",\n\t\t\t\"cut_date\": \"<string>\",\n\t\t\t\"final_balance\": \"<number>\",\n\t\t\t\"previous_balance\": \"<number>\",\n\t\t\t\"total_inflow_amount\": \"<number>\",\n\t\t\t\"total_outflow_amount\": \"<number>\",\n\t\t\t\"total_inflow_transactions\": \"<number>\",\n\t\t\t\"total_outflow_transactions\": \"<number>\",\n\t\t\t\"transactions\": [\n\t\t\t\t{\n\t\t\t\t\t\"collected_at\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"accounting_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"value_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"reference\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"observations\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"additional_data\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"balance\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"currency\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"description\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"internal_identification\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"account\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"collected_at\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"accounting_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"value_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"reference\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"observations\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"additional_data\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"balance\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"currency\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"description\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"internal_identification\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"account\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"pdf\": \"<binary>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"link\": \"<string>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"category\": \"veniam occaecat\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"account_number\": \"<string>\",\n\t\t\t\"client_number\": \"<string>\",\n\t\t\t\"RFC\": \"<string>\",\n\t\t\t\"CLABE\": \"<string>\",\n\t\t\t\"period_start_date\": \"<date>\",\n\t\t\t\"period_end_date\": \"<date>\",\n\t\t\t\"cut_date\": \"<string>\",\n\t\t\t\"final_balance\": \"<number>\",\n\t\t\t\"previous_balance\": \"<number>\",\n\t\t\t\"total_inflow_amount\": \"<number>\",\n\t\t\t\"total_outflow_amount\": \"<number>\",\n\t\t\t\"total_inflow_transactions\": \"<number>\",\n\t\t\t\"total_outflow_transactions\": \"<number>\",\n\t\t\t\"transactions\": [\n\t\t\t\t{\n\t\t\t\t\t\"collected_at\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"accounting_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"value_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"reference\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"observations\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"additional_data\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"balance\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"currency\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"description\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"internal_identification\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"account\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"collected_at\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"accounting_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"value_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"reference\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"observations\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"additional_data\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"balance\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"currency\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"description\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"internal_identification\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"account\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"pdf\": \"<binary>\"\n\t\t}\n\t]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"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]"
}
]
}
