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/statements/:id/",$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)
; {
; "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
Local $sValue
Local $sAccounting_dateValue
Local $sValue_dateValue
Local $sReferenceValue
Local $sObservationsValue
Local $sAdditional_dataValue
Local $sBalanceValue
Local $statusValue
Local $sTypeValue
Local $sCurrencyValue
Local $sDescriptionValue
Local $sInternal_identificationValue
Local $sAccountValue
Local $sId = $oJResp.StringOf("id")
Local $sLink = $oJResp.StringOf("link")
Local $sId = $oJResp.StringOf("account.id")
Local $sName = $oJResp.StringOf("account.name")
Local $sCategory = $oJResp.StringOf("account.category")
Local $sV_Currency = $oJResp.StringOf("account.currency")
Local $sCollected_at = $oJResp.StringOf("collected_at")
Local $sAccount_number = $oJResp.StringOf("account_number")
Local $sClient_number = $oJResp.StringOf("client_number")
Local $sRFC = $oJResp.StringOf("RFC")
Local $sCLABE = $oJResp.StringOf("CLABE")
Local $sPeriod_start_date = $oJResp.StringOf("period_start_date")
Local $sPeriod_end_date = $oJResp.StringOf("period_end_date")
Local $sCut_date = $oJResp.StringOf("cut_date")
Local $sFinal_balance = $oJResp.StringOf("final_balance")
Local $sPrevious_balance = $oJResp.StringOf("previous_balance")
Local $sTotal_inflow_amount = $oJResp.StringOf("total_inflow_amount")
Local $sTotal_outflow_amount = $oJResp.StringOf("total_outflow_amount")
Local $sTotal_inflow_transactions = $oJResp.StringOf("total_inflow_transactions")
Local $sTotal_outflow_transactions = $oJResp.StringOf("total_outflow_transactions")
Local $sPdf = $oJResp.StringOf("pdf")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("transactions")
While $i < $iCount_i
$oJResp.I = $i
$sValue = $oJResp.StringOf("transactions[i].collected_at.value")
$sAccounting_dateValue = $oJResp.StringOf("transactions[i].accounting_date.value")
$sValue_dateValue = $oJResp.StringOf("transactions[i].value_date.value")
$sReferenceValue = $oJResp.StringOf("transactions[i].reference.value")
$sObservationsValue = $oJResp.StringOf("transactions[i].observations.value")
$sAdditional_dataValue = $oJResp.StringOf("transactions[i].additional_data.value")
$sBalanceValue = $oJResp.StringOf("transactions[i].balance.value")
$statusValue = $oJResp.StringOf("transactions[i].status.value")
$sTypeValue = $oJResp.StringOf("transactions[i].type.value")
$sCurrencyValue = $oJResp.StringOf("transactions[i].currency.value")
$sDescriptionValue = $oJResp.StringOf("transactions[i].description.value")
$sInternal_identificationValue = $oJResp.StringOf("transactions[i].internal_identification.value")
$sAccountValue = $oJResp.StringOf("transactions[i].account.value")
$i = $i + 1
Wend
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]"
}
]
}
