Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
$http->BasicAuth = 1;
$http->Login = '{{secretId}}';
$http->Password = '{{secretPassword}}';
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://domain.com/api/balances/',$sbResponseBody);
if ($success == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $http->LastHeader . "\n";
print 'Failed.' . "\n";
exit;
}
// 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>",
// "name": "<string>",
// "category": "irure",
// "currency": "<string>"
// },
// "collected_at": "<dateTime>",
// "value_date": "<date>",
// "balance": "<number>",
// "current_balance": "<number>",
// "statement": "<string>"
// },
// {
// "id": "<uuid>",
// "account": {
// "id": "<uuid>",
// "name": "<string>",
// "category": "in culpa cupidatat ullamco",
// "currency": "<string>"
// },
// "collected_at": "<dateTime>",
// "value_date": "<date>",
// "balance": "<number>",
// "current_balance": "<number>",
// "statement": "<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->I = $i;
$id = $jResp->stringOf('results[i].id');
$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');
$value_date = $jResp->stringOf('results[i].value_date');
$balance = $jResp->stringOf('results[i].balance');
$current_balance = $jResp->stringOf('results[i].current_balance');
$statement = $jResp->stringOf('results[i].statement');
$i = $i + 1;
}
?>
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/balances/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/balances/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set.",
"disabled": true
}
]
},
"description": "Get a paginated list of all existing balances 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/balances?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
],
"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\"name\": \"<string>\",\n\t\t\t\t\"category\": \"irure\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"value_date\": \"<date>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"current_balance\": \"<number>\",\n\t\t\t\"statement\": \"<string>\"\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\"name\": \"<string>\",\n\t\t\t\t\"category\": \"in culpa cupidatat ullamco\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"value_date\": \"<date>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"current_balance\": \"<number>\",\n\t\t\t\"statement\": \"<string>\"\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/balances?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
],
"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]"
}
]
}
