Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "{{secretId}}"
CkHttp_put_Password $http "{{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"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "date_from" "2021-01-01"
CkJsonObject_UpdateString $json "date_to" "2021-03-30"
CkJsonObject_UpdateString $json "link" "2ccd5e15-194a-4a19-a45a-e7223c7e6717"
CkJsonObject_UpdateString $json "token" "1234ab"
CkJsonObject_UpdateBool $json "save_data" 1
CkJsonObject_UpdateString $json "account" "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/api/balances/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jarrResp [new_CkJsonArray]
CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0
puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
exit
}
delete_CkHttpResponse $resp
# 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
# json is a CkJsonObject
set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
set json [CkJsonArray_ObjectAt $jarrResp $i]
set id [CkJsonObject_stringOf $json "id"]
set Id [CkJsonObject_stringOf $json "account.id"]
set Name [CkJsonObject_stringOf $json "account.name"]
set Category [CkJsonObject_stringOf $json "account.category"]
set v_Currency [CkJsonObject_stringOf $json "account.currency"]
set collected_at [CkJsonObject_stringOf $json "collected_at"]
set value_date [CkJsonObject_stringOf $json "value_date"]
set balance [CkJsonObject_stringOf $json "balance"]
set current_balance [CkJsonObject_stringOf $json "current_balance"]
set statement [CkJsonObject_stringOf $json "statement"]
delete_CkJsonObject $json
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
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]"
}
]
}
