Chilkat Online Tools

delphiDll / Belvo API Docs / Detail

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Value: PWideChar;
accounting_dateValue: PWideChar;
value_dateValue: PWideChar;
referenceValue: PWideChar;
observationsValue: PWideChar;
additional_dataValue: PWideChar;
balanceValue: PWideChar;
statusValue: PWideChar;
typeValue: PWideChar;
currencyValue: PWideChar;
descriptionValue: PWideChar;
internal_identificationValue: PWideChar;
accountValue: PWideChar;
id: PWideChar;
link: PWideChar;
Id: PWideChar;
Name: PWideChar;
Category: PWideChar;
v_Currency: PWideChar;
collected_at: PWideChar;
account_number: PWideChar;
client_number: PWideChar;
RFC: PWideChar;
CLABE: PWideChar;
period_start_date: PWideChar;
period_end_date: PWideChar;
cut_date: PWideChar;
final_balance: PWideChar;
previous_balance: PWideChar;
total_inflow_amount: PWideChar;
total_outflow_amount: PWideChar;
total_inflow_transactions: PWideChar;
total_outflow_transactions: PWideChar;
pdf: PWideChar;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'{{secretId}}');
CkHttp_putPassword(http,'{{secretPassword}}');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/api/statements/:id/',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

id := CkJsonObject__stringOf(jResp,'id');
link := CkJsonObject__stringOf(jResp,'link');
Id := CkJsonObject__stringOf(jResp,'account.id');
Name := CkJsonObject__stringOf(jResp,'account.name');
Category := CkJsonObject__stringOf(jResp,'account.category');
v_Currency := CkJsonObject__stringOf(jResp,'account.currency');
collected_at := CkJsonObject__stringOf(jResp,'collected_at');
account_number := CkJsonObject__stringOf(jResp,'account_number');
client_number := CkJsonObject__stringOf(jResp,'client_number');
RFC := CkJsonObject__stringOf(jResp,'RFC');
CLABE := CkJsonObject__stringOf(jResp,'CLABE');
period_start_date := CkJsonObject__stringOf(jResp,'period_start_date');
period_end_date := CkJsonObject__stringOf(jResp,'period_end_date');
cut_date := CkJsonObject__stringOf(jResp,'cut_date');
final_balance := CkJsonObject__stringOf(jResp,'final_balance');
previous_balance := CkJsonObject__stringOf(jResp,'previous_balance');
total_inflow_amount := CkJsonObject__stringOf(jResp,'total_inflow_amount');
total_outflow_amount := CkJsonObject__stringOf(jResp,'total_outflow_amount');
total_inflow_transactions := CkJsonObject__stringOf(jResp,'total_inflow_transactions');
total_outflow_transactions := CkJsonObject__stringOf(jResp,'total_outflow_transactions');
pdf := CkJsonObject__stringOf(jResp,'pdf');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'transactions');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    Value := CkJsonObject__stringOf(jResp,'transactions[i].collected_at.value');
    accounting_dateValue := CkJsonObject__stringOf(jResp,'transactions[i].accounting_date.value');
    value_dateValue := CkJsonObject__stringOf(jResp,'transactions[i].value_date.value');
    referenceValue := CkJsonObject__stringOf(jResp,'transactions[i].reference.value');
    observationsValue := CkJsonObject__stringOf(jResp,'transactions[i].observations.value');
    additional_dataValue := CkJsonObject__stringOf(jResp,'transactions[i].additional_data.value');
    balanceValue := CkJsonObject__stringOf(jResp,'transactions[i].balance.value');
    statusValue := CkJsonObject__stringOf(jResp,'transactions[i].status.value');
    typeValue := CkJsonObject__stringOf(jResp,'transactions[i].type.value');
    currencyValue := CkJsonObject__stringOf(jResp,'transactions[i].currency.value');
    descriptionValue := CkJsonObject__stringOf(jResp,'transactions[i].description.value');
    internal_identificationValue := CkJsonObject__stringOf(jResp,'transactions[i].internal_identification.value');
    accountValue := CkJsonObject__stringOf(jResp,'transactions[i].account.value');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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]"
    }
  ]
}