Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "{{secretId}}"
$oHttp.Password = "{{secretPassword}}"
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/api/balances/",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sId
Local $sId
Local $sName
Local $sCategory
Local $sV_Currency
Local $sCollected_at
Local $sValue_date
Local $sBalance
Local $sCurrent_balance
Local $statement
Local $sCount = $oJResp.StringOf("count")
Local $sV_next = $oJResp.StringOf("next")
Local $sPrevious = $oJResp.StringOf("previous")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("results")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("results[i].id")
$sId = $oJResp.StringOf("results[i].account.id")
$sName = $oJResp.StringOf("results[i].account.name")
$sCategory = $oJResp.StringOf("results[i].account.category")
$sV_Currency = $oJResp.StringOf("results[i].account.currency")
$sCollected_at = $oJResp.StringOf("results[i].collected_at")
$sValue_date = $oJResp.StringOf("results[i].value_date")
$sBalance = $oJResp.StringOf("results[i].balance")
$sCurrent_balance = $oJResp.StringOf("results[i].current_balance")
$statement = $oJResp.StringOf("results[i].statement")
$i = $i + 1
Wend
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]"
}
]
}
