Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcValue
LOCAL lcInstitutionValue
LOCAL lcCollected_atValue
LOCAL lcCategoryValue
LOCAL lcTypeValue
LOCAL lcNameValue
LOCAL lcNumberValue
LOCAL lcBalanceValue
LOCAL lcCurrencyValue
LOCAL lcBank_product_idValue
LOCAL lcInternal_identificationValue
LOCAL lcPublic_identification_nameValue
LOCAL lcPublic_identification_valueValue
LOCAL lcLast_accessed_atValue
LOCAL lcCredit_dataValue
LOCAL lcLoan_dataValue
LOCAL lcFunds_dataValue
LOCAL lcGig_payment_dataValue
LOCAL lcCount
LOCAL lcV_next
LOCAL lcPrevious
LOCAL i
LOCAL lnCount_i
* 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 CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "{{secretId}}"
loHttp.Password = "{{secretPassword}}"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/api/accounts/",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcCount = loJResp.StringOf("count")
lcV_next = loJResp.StringOf("next")
lcPrevious = loJResp.StringOf("previous")
i = 0
lnCount_i = loJResp.SizeOfArray("results")
DO WHILE i < lnCount_i
loJResp.I = i
lcValue = loJResp.StringOf("results[i].link.value")
lcInstitutionValue = loJResp.StringOf("results[i].institution.value")
lcCollected_atValue = loJResp.StringOf("results[i].collected_at.value")
lcCategoryValue = loJResp.StringOf("results[i].category.value")
lcTypeValue = loJResp.StringOf("results[i].type.value")
lcNameValue = loJResp.StringOf("results[i].name.value")
lcNumberValue = loJResp.StringOf("results[i].number.value")
lcBalanceValue = loJResp.StringOf("results[i].balance.value")
lcCurrencyValue = loJResp.StringOf("results[i].currency.value")
lcBank_product_idValue = loJResp.StringOf("results[i].bank_product_id.value")
lcInternal_identificationValue = loJResp.StringOf("results[i].internal_identification.value")
lcPublic_identification_nameValue = loJResp.StringOf("results[i].public_identification_name.value")
lcPublic_identification_valueValue = loJResp.StringOf("results[i].public_identification_value.value")
lcLast_accessed_atValue = loJResp.StringOf("results[i].last_accessed_at.value")
lcCredit_dataValue = loJResp.StringOf("results[i].credit_data.value")
lcLoan_dataValue = loJResp.StringOf("results[i].loan_data.value")
lcFunds_dataValue = loJResp.StringOf("results[i].funds_data.value")
lcGig_payment_dataValue = loJResp.StringOf("results[i].gig_payment_data.value")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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]"
}
]
}
