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}}"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://domain.com/api/statements/:id/" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "id": "<uuid>",
# "link": "<string>",
# "account": {
# "id": "<uuid>",
# "name": "<string>",
# "category": "non consequat",
# "currency": "<string>"
# },
# "collected_at": "<dateTime>",
# "account_number": "<string>",
# "client_number": "<string>",
# "RFC": "<string>",
# "CLABE": "<string>",
# "period_start_date": "<date>",
# "period_end_date": "<date>",
# "cut_date": "<string>",
# "final_balance": "<number>",
# "previous_balance": "<number>",
# "total_inflow_amount": "<number>",
# "total_outflow_amount": "<number>",
# "total_inflow_transactions": "<number>",
# "total_outflow_transactions": "<number>",
# "transactions": [
# {
# "collected_at": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "accounting_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "value_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "reference": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "observations": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "additional_data": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "balance": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "status": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "type": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "currency": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "description": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "internal_identification": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "account": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# {
# "collected_at": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "accounting_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "value_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "reference": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "observations": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "additional_data": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "balance": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "status": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "type": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "currency": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "description": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "internal_identification": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "account": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# }
# ],
# "pdf": "<binary>"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set id [CkJsonObject_stringOf $jResp "id"]
set link [CkJsonObject_stringOf $jResp "link"]
set Id [CkJsonObject_stringOf $jResp "account.id"]
set Name [CkJsonObject_stringOf $jResp "account.name"]
set Category [CkJsonObject_stringOf $jResp "account.category"]
set v_Currency [CkJsonObject_stringOf $jResp "account.currency"]
set collected_at [CkJsonObject_stringOf $jResp "collected_at"]
set account_number [CkJsonObject_stringOf $jResp "account_number"]
set client_number [CkJsonObject_stringOf $jResp "client_number"]
set RFC [CkJsonObject_stringOf $jResp "RFC"]
set CLABE [CkJsonObject_stringOf $jResp "CLABE"]
set period_start_date [CkJsonObject_stringOf $jResp "period_start_date"]
set period_end_date [CkJsonObject_stringOf $jResp "period_end_date"]
set cut_date [CkJsonObject_stringOf $jResp "cut_date"]
set final_balance [CkJsonObject_stringOf $jResp "final_balance"]
set previous_balance [CkJsonObject_stringOf $jResp "previous_balance"]
set total_inflow_amount [CkJsonObject_stringOf $jResp "total_inflow_amount"]
set total_outflow_amount [CkJsonObject_stringOf $jResp "total_outflow_amount"]
set total_inflow_transactions [CkJsonObject_stringOf $jResp "total_inflow_transactions"]
set total_outflow_transactions [CkJsonObject_stringOf $jResp "total_outflow_transactions"]
set pdf [CkJsonObject_stringOf $jResp "pdf"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "transactions"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Value [CkJsonObject_stringOf $jResp "transactions[i].collected_at.value"]
set accounting_dateValue [CkJsonObject_stringOf $jResp "transactions[i].accounting_date.value"]
set value_dateValue [CkJsonObject_stringOf $jResp "transactions[i].value_date.value"]
set referenceValue [CkJsonObject_stringOf $jResp "transactions[i].reference.value"]
set observationsValue [CkJsonObject_stringOf $jResp "transactions[i].observations.value"]
set additional_dataValue [CkJsonObject_stringOf $jResp "transactions[i].additional_data.value"]
set balanceValue [CkJsonObject_stringOf $jResp "transactions[i].balance.value"]
set statusValue [CkJsonObject_stringOf $jResp "transactions[i].status.value"]
set typeValue [CkJsonObject_stringOf $jResp "transactions[i].type.value"]
set currencyValue [CkJsonObject_stringOf $jResp "transactions[i].currency.value"]
set descriptionValue [CkJsonObject_stringOf $jResp "transactions[i].description.value"]
set internal_identificationValue [CkJsonObject_stringOf $jResp "transactions[i].internal_identification.value"]
set accountValue [CkJsonObject_stringOf $jResp "transactions[i].account.value"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/statements/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/statements/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `statement.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific statement."
},
"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/statements/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": \"<string>\",\n\t\"account\": {\n\t\t\"id\": \"<uuid>\",\n\t\t\"name\": \"<string>\",\n\t\t\"category\": \"non consequat\",\n\t\t\"currency\": \"<string>\"\n\t},\n\t\"collected_at\": \"<dateTime>\",\n\t\"account_number\": \"<string>\",\n\t\"client_number\": \"<string>\",\n\t\"RFC\": \"<string>\",\n\t\"CLABE\": \"<string>\",\n\t\"period_start_date\": \"<date>\",\n\t\"period_end_date\": \"<date>\",\n\t\"cut_date\": \"<string>\",\n\t\"final_balance\": \"<number>\",\n\t\"previous_balance\": \"<number>\",\n\t\"total_inflow_amount\": \"<number>\",\n\t\"total_outflow_amount\": \"<number>\",\n\t\"total_inflow_transactions\": \"<number>\",\n\t\"total_outflow_transactions\": \"<number>\",\n\t\"transactions\": [\n\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\"accounting_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_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\"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\"status\": {\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\"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\"description\": {\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\"account\": {\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\"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\"accounting_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_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\"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\"status\": {\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\"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\"description\": {\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\"account\": {\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\t\"pdf\": \"<binary>\"\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/statements/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"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": "Too Many Sessions",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/statements/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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]"
}
]
}
