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.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "{{secretId}}"
$oHttp.Password = "{{secretPassword}}"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/api/accounts/",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.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": [
; {
; "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>"
; }
; },
; {
; "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>"
; }
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sValue
Local $sInstitutionValue
Local $sCollected_atValue
Local $sCategoryValue
Local $sTypeValue
Local $sNameValue
Local $sNumberValue
Local $sBalanceValue
Local $sCurrencyValue
Local $sBank_product_idValue
Local $sInternal_identificationValue
Local $sPublic_identification_nameValue
Local $sPublic_identification_valueValue
Local $sLast_accessed_atValue
Local $sCredit_dataValue
Local $sLoan_dataValue
Local $sFunds_dataValue
Local $sGig_payment_dataValue
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
$sValue = $oJResp.StringOf("results[i].link.value")
$sInstitutionValue = $oJResp.StringOf("results[i].institution.value")
$sCollected_atValue = $oJResp.StringOf("results[i].collected_at.value")
$sCategoryValue = $oJResp.StringOf("results[i].category.value")
$sTypeValue = $oJResp.StringOf("results[i].type.value")
$sNameValue = $oJResp.StringOf("results[i].name.value")
$sNumberValue = $oJResp.StringOf("results[i].number.value")
$sBalanceValue = $oJResp.StringOf("results[i].balance.value")
$sCurrencyValue = $oJResp.StringOf("results[i].currency.value")
$sBank_product_idValue = $oJResp.StringOf("results[i].bank_product_id.value")
$sInternal_identificationValue = $oJResp.StringOf("results[i].internal_identification.value")
$sPublic_identification_nameValue = $oJResp.StringOf("results[i].public_identification_name.value")
$sPublic_identification_valueValue = $oJResp.StringOf("results[i].public_identification_value.value")
$sLast_accessed_atValue = $oJResp.StringOf("results[i].last_accessed_at.value")
$sCredit_dataValue = $oJResp.StringOf("results[i].credit_data.value")
$sLoan_dataValue = $oJResp.StringOf("results[i].loan_data.value")
$sFunds_dataValue = $oJResp.StringOf("results[i].funds_data.value")
$sGig_payment_dataValue = $oJResp.StringOf("results[i].gig_payment_data.value")
$i = $i + 1
Wend
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/accounts/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/accounts/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set.",
"disabled": true
}
]
},
"description": "Get a paginated list of all existing accounts in your Belvo account. We return up to 100 results per page.\n\n**Filterable fields**\n\nPlease see the table below for an alphabetized list of fields that you can filter your responses by. For more information on how to use filters, see our [Filtering responses](https://developers.belvo.com/docs/searching-and-filtering) article.\n\n|Field| Available Filters|\n|---|---|\n|`balance__available`|`=`, `gt`, `gte`, `lt`, `lte`, `range`|\n|`balance__current`|`=`, `gt`, `gte`, `lt`, `lte`, `range`|\n|`bank_product_id`|`=`|\n|`category`|`=`, `in`|\n|`collected_at`|`=`, `gt`, `gte`, `lt`, `lte`, `range`|\n|`currency`|`=`, `in`|\n|`id`|`=`, `in`|\n|`institution`|`=`, `in`|\n|`internal_identification`|`=`|\n|`link`|`=`, `in`|\n|`name`|`=`, `icontains`|\n|`number`|`=`, `in`|\n|`public_identification_name`|`=`|\n|`public_identification_value`|`=`|\n|`type`|`=`, `in`|"
},
"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/accounts?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts"
],
"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\"link\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"institution\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"category\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"number\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"bank_product_id\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"last_accessed_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"credit_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"loan_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"funds_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"gig_payment_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"link\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"institution\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"category\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"number\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"bank_product_id\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"last_accessed_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"credit_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"loan_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"funds_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"gig_payment_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\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/accounts?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts"
],
"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]"
}
]
}
