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}}")
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateInt("page",1)
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/api/transactions/",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\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>",
# "account": {
# "id": "<uuid>",
# "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": "ipsum quis",
# "status": "nostrud",
# "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>"
# }
# },
# {
# "id": "<uuid>",
# "account": {
# "id": "<uuid>",
# "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": "labore sunt ad",
# "status": "commodo",
# "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
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")
Id = jResp.stringOf("results[i].account.id")
Value = jResp.stringOf("results[i].account.link.value")
InstitutionValue = jResp.stringOf("results[i].account.institution.value")
Collected_atValue = jResp.stringOf("results[i].account.collected_at.value")
CategoryValue = jResp.stringOf("results[i].account.category.value")
TypeValue = jResp.stringOf("results[i].account.type.value")
NameValue = jResp.stringOf("results[i].account.name.value")
NumberValue = jResp.stringOf("results[i].account.number.value")
BalanceValue = jResp.stringOf("results[i].account.balance.value")
CurrencyValue = jResp.stringOf("results[i].account.currency.value")
Bank_product_idValue = jResp.stringOf("results[i].account.bank_product_id.value")
Internal_identificationValue = jResp.stringOf("results[i].account.internal_identification.value")
Public_identification_nameValue = jResp.stringOf("results[i].account.public_identification_name.value")
Public_identification_valueValue = jResp.stringOf("results[i].account.public_identification_value.value")
Last_accessed_atValue = jResp.stringOf("results[i].account.last_accessed_at.value")
Credit_dataValue = jResp.stringOf("results[i].account.credit_data.value")
Loan_dataValue = jResp.stringOf("results[i].account.loan_data.value")
Funds_dataValue = jResp.stringOf("results[i].account.funds_data.value")
Gig_payment_dataValue = jResp.stringOf("results[i].account.gig_payment_data.value")
collected_at = jResp.stringOf("results[i].collected_at")
value_date = jResp.stringOf("results[i].value_date")
accounting_date = jResp.stringOf("results[i].accounting_date")
amount = jResp.stringOf("results[i].amount")
balance = jResp.stringOf("results[i].balance")
v_currency = jResp.stringOf("results[i].currency")
description = jResp.stringOf("results[i].description")
observations = jResp.stringOf("results[i].observations")
category = jResp.stringOf("results[i].category")
reference = jResp.stringOf("results[i].reference")
v_type = jResp.stringOf("results[i].type")
status = jResp.stringOf("results[i].status")
Pickup_at = jResp.stringOf("results[i].gig_data.pickup_at")
Dropoff_at = jResp.stringOf("results[i].gig_data.dropoff_at")
Request_at = jResp.stringOf("results[i].gig_data.request_at")
Pickup_address = jResp.stringOf("results[i].gig_data.pickup_address")
Dropoff_address = jResp.stringOf("results[i].gig_data.dropoff_address")
Pickup_latitude = jResp.stringOf("results[i].gig_data.pickup_latitude")
Pickup_longitude = jResp.stringOf("results[i].gig_data.pickup_longitude")
Dropoff_latitude = jResp.stringOf("results[i].gig_data.dropoff_latitude")
Dropoff_longitude = jResp.stringOf("results[i].gig_data.dropoff_longitude")
Distance = jResp.stringOf("results[i].gig_data.distance")
Payment_method = jResp.stringOf("results[i].gig_data.payment_method")
Vehicle_type = jResp.stringOf("results[i].gig_data.vehicle_type")
Merchant_type = jResp.stringOf("results[i].gig_data.merchant_type")
Collected_at = jResp.stringOf("results[i].gig_data.collected_at")
Bill_name = jResp.stringOf("results[i].credit_card_data.bill_name")
j = 0
count_j = jResp.SizeOfArray("results[i].gig_data.breakdown")
while j < count_j
jResp.put_J(j)
value = jResp.stringOf("results[i].gig_data.breakdown[j].value")
j = j + 1
end
i = i + 1
end
Curl Command
curl -G -d "page=1"
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/transactions/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/transactions/?page=1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set."
}
]
},
"description": "Get a paginated list of all existing transactions 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/transactions?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions"
],
"query": [
{
"key": "page",
"value": "<integer>"
}
]
}
},
"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\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"link\": {\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\"institution\": {\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\"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\"category\": {\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\"name\": {\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\"number\": {\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\"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\"bank_product_id\": {\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\"public_identification_name\": {\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\"public_identification_value\": {\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\"last_accessed_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\"credit_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\"loan_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\"funds_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\"gig_payment_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},\n\t\t\t\"collected_at\": \"<date>\",\n\t\t\t\"value_date\": \"<string>\",\n\t\t\t\"accounting_date\": \"<date>\",\n\t\t\t\"amount\": \"<number>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"description\": \"<string>\",\n\t\t\t\"observations\": \"<string>\",\n\t\t\t\"category\": \"<string>\",\n\t\t\t\"reference\": \"<string>\",\n\t\t\t\"type\": \"ipsum quis\",\n\t\t\t\"status\": \"nostrud\",\n\t\t\t\"gig_data\": {\n\t\t\t\t\"pickup_at\": \"<dateTime>\",\n\t\t\t\t\"dropoff_at\": \"<dateTime>\",\n\t\t\t\t\"request_at\": \"<dateTime>\",\n\t\t\t\t\"pickup_address\": \"<string>\",\n\t\t\t\t\"dropoff_address\": \"<string>\",\n\t\t\t\t\"pickup_latitude\": \"<number>\",\n\t\t\t\t\"pickup_longitude\": \"<number>\",\n\t\t\t\t\"dropoff_latitude\": \"<number>\",\n\t\t\t\t\"dropoff_longitude\": \"<number>\",\n\t\t\t\t\"distance\": \"<number>\",\n\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\"vehicle_type\": \"<string>\",\n\t\t\t\t\"merchant_type\": \"<string>\",\n\t\t\t\t\"breakdown\": [\n\t\t\t\t\t{\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{\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\"collected_at\": \"<dateTime>\"\n\t\t\t},\n\t\t\t\"credit_card_data\": {\n\t\t\t\t\"bill_name\": \"<string>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"link\": {\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\"institution\": {\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\"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\"category\": {\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\"name\": {\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\"number\": {\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\"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\"bank_product_id\": {\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\"public_identification_name\": {\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\"public_identification_value\": {\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\"last_accessed_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\"credit_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\"loan_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\"funds_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\"gig_payment_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},\n\t\t\t\"collected_at\": \"<date>\",\n\t\t\t\"value_date\": \"<string>\",\n\t\t\t\"accounting_date\": \"<date>\",\n\t\t\t\"amount\": \"<number>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"description\": \"<string>\",\n\t\t\t\"observations\": \"<string>\",\n\t\t\t\"category\": \"<string>\",\n\t\t\t\"reference\": \"<string>\",\n\t\t\t\"type\": \"labore sunt ad\",\n\t\t\t\"status\": \"commodo\",\n\t\t\t\"gig_data\": {\n\t\t\t\t\"pickup_at\": \"<dateTime>\",\n\t\t\t\t\"dropoff_at\": \"<dateTime>\",\n\t\t\t\t\"request_at\": \"<dateTime>\",\n\t\t\t\t\"pickup_address\": \"<string>\",\n\t\t\t\t\"dropoff_address\": \"<string>\",\n\t\t\t\t\"pickup_latitude\": \"<number>\",\n\t\t\t\t\"pickup_longitude\": \"<number>\",\n\t\t\t\t\"dropoff_latitude\": \"<number>\",\n\t\t\t\t\"dropoff_longitude\": \"<number>\",\n\t\t\t\t\"distance\": \"<number>\",\n\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\"vehicle_type\": \"<string>\",\n\t\t\t\t\"merchant_type\": \"<string>\",\n\t\t\t\t\"breakdown\": [\n\t\t\t\t\t{\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{\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\"collected_at\": \"<dateTime>\"\n\t\t\t},\n\t\t\t\"credit_card_data\": {\n\t\t\t\t\"bill_name\": \"<string>\"\n\t\t\t}\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/transactions?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions"
],
"query": [
{
"key": "page",
"value": "<integer>"
}
]
}
},
"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]"
}
]
}
