Chilkat Online Tools

phpAx / Belvo API Docs / Retrieve

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}}';

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "date_from": "2021-01-01",
//   "date_to": "2021-03-30",
//   "link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
//   "token": "1234ab",
//   "save_data": true,
//   "account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('date_from','2021-01-01');
$json->UpdateString('date_to','2021-03-30');
$json->UpdateString('link','2ccd5e15-194a-4a19-a45a-e7223c7e6717');
$json->UpdateString('token','1234ab');
$json->UpdateBool('save_data',1);
$json->UpdateString('account','d4617561-1c01-4b2f-83b6-a594f7b3bc57');

$http->SetRequestHeader('Content-Type','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/api/balances/','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonArray')
$jarrResp = new COM("Chilkat.JsonArray");
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jarrResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// [
//   {
//     "id": "<uuid>",
//     "account": {
//       "id": "<uuid>",
//       "name": "<string>",
//       "category": "eu exercitation id ullamco",
//       "currency": "<string>"
//     },
//     "collected_at": "<dateTime>",
//     "value_date": "<date>",
//     "balance": "<number>",
//     "current_balance": "<number>",
//     "statement": "<string>"
//   },
//   {
//     "id": "<uuid>",
//     "account": {
//       "id": "<uuid>",
//       "name": "<string>",
//       "category": "eu tempor adipisicing",
//       "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

$i = 0;
$count_i = $jarrResp->Size;
while ($i < $count_i) {
    // json is a Chilkat.JsonObject
    $json = $jarrResp->ObjectAt($i);
    $id = $json->stringOf('id');
    $Id = $json->stringOf('account.id');
    $Name = $json->stringOf('account.name');
    $Category = $json->stringOf('account.category');
    $v_Currency = $json->stringOf('account.currency');
    $collected_at = $json->stringOf('collected_at');
    $value_date = $json->stringOf('value_date');
    $balance = $json->stringOf('balance');
    $current_balance = $json->stringOf('current_balance');
    $statement = $json->stringOf('statement');

    $i = $i + 1;
}


?>

Curl Command

curl -X POST
	-u '{{secretId}}:{{secretPassword}}'
	-H "Content-Type: application/json"
	-d '{
    "date_from": "2021-01-01",
    "date_to": "2021-03-30",
    "link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
    "token": "1234ab",
    "save_data": true,
    "account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
}'
https://domain.com/api/balances/

Postman Collection Item JSON

{
  "name": "Retrieve",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"date_from\": \"2021-01-01\",\n    \"date_to\": \"2021-03-30\",\n    \"link\": \"2ccd5e15-194a-4a19-a45a-e7223c7e6717\",\n    \"token\": \"1234ab\",\n    \"save_data\": true,\n    \"account\": \"d4617561-1c01-4b2f-83b6-a594f7b3bc57\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/balances/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "balances",
        ""
      ]
    },
    "description": "Retrieve balances from one or more accounts for a specific link within a specified date range."
  },
  "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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\"name\": \"<string>\",\n\t\t\t\"category\": \"eu exercitation id ullamco\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu tempor adipisicing\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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\"name\": \"<string>\",\n\t\t\t\"category\": \"eu exercitation id ullamco\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu tempor adipisicing\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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]"
    }
  ]
}