Chilkat Online Tools

delphiAx / Belvo API Docs / Detail

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
value: WideString;
id: WideString;
Id: WideString;
Value: WideString;
InstitutionValue: WideString;
Collected_atValue: WideString;
CategoryValue: WideString;
TypeValue: WideString;
NameValue: WideString;
NumberValue: WideString;
BalanceValue: WideString;
CurrencyValue: WideString;
Bank_product_idValue: WideString;
Internal_identificationValue: WideString;
Public_identification_nameValue: WideString;
Public_identification_valueValue: WideString;
Last_accessed_atValue: WideString;
Credit_dataValue: WideString;
Loan_dataValue: WideString;
Funds_dataValue: WideString;
Gig_payment_dataValue: WideString;
collected_at: WideString;
value_date: WideString;
accounting_date: WideString;
amount: WideString;
balance: WideString;
v_currency: WideString;
description: WideString;
observations: WideString;
category: WideString;
reference: WideString;
v_type: WideString;
status: WideString;
Pickup_at: WideString;
Dropoff_at: WideString;
Request_at: WideString;
Pickup_address: WideString;
Dropoff_address: WideString;
Pickup_latitude: WideString;
Pickup_longitude: WideString;
Dropoff_latitude: WideString;
Dropoff_longitude: WideString;
Distance: WideString;
Payment_method: WideString;
Vehicle_type: WideString;
Merchant_type: WideString;
Collected_at: WideString;
Bill_name: WideString;
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 := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := '{{secretId}}';
http.Password := '{{secretPassword}}';

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://domain.com/api/transactions/:id/',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

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

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

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "<uuid>",
//   "account": {
//     "id": "<uuid>",
//     "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>"
//     }
//   },
//   "collected_at": "<date>",
//   "value_date": "<string>",
//   "accounting_date": "<date>",
//   "amount": "<number>",
//   "balance": "<number>",
//   "currency": "<string>",
//   "description": "<string>",
//   "observations": "<string>",
//   "category": "<string>",
//   "reference": "<string>",
//   "type": "eiusmod veniam ea sint",
//   "status": "est nostrud",
//   "gig_data": {
//     "pickup_at": "<dateTime>",
//     "dropoff_at": "<dateTime>",
//     "request_at": "<dateTime>",
//     "pickup_address": "<string>",
//     "dropoff_address": "<string>",
//     "pickup_latitude": "<number>",
//     "pickup_longitude": "<number>",
//     "dropoff_latitude": "<number>",
//     "dropoff_longitude": "<number>",
//     "distance": "<number>",
//     "payment_method": "<string>",
//     "vehicle_type": "<string>",
//     "merchant_type": "<string>",
//     "breakdown": [
//       {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       }
//     ],
//     "collected_at": "<dateTime>"
//   },
//   "credit_card_data": {
//     "bill_name": "<string>"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

id := jResp.StringOf('id');
Id := jResp.StringOf('account.id');
Value := jResp.StringOf('account.link.value');
InstitutionValue := jResp.StringOf('account.institution.value');
Collected_atValue := jResp.StringOf('account.collected_at.value');
CategoryValue := jResp.StringOf('account.category.value');
TypeValue := jResp.StringOf('account.type.value');
NameValue := jResp.StringOf('account.name.value');
NumberValue := jResp.StringOf('account.number.value');
BalanceValue := jResp.StringOf('account.balance.value');
CurrencyValue := jResp.StringOf('account.currency.value');
Bank_product_idValue := jResp.StringOf('account.bank_product_id.value');
Internal_identificationValue := jResp.StringOf('account.internal_identification.value');
Public_identification_nameValue := jResp.StringOf('account.public_identification_name.value');
Public_identification_valueValue := jResp.StringOf('account.public_identification_value.value');
Last_accessed_atValue := jResp.StringOf('account.last_accessed_at.value');
Credit_dataValue := jResp.StringOf('account.credit_data.value');
Loan_dataValue := jResp.StringOf('account.loan_data.value');
Funds_dataValue := jResp.StringOf('account.funds_data.value');
Gig_payment_dataValue := jResp.StringOf('account.gig_payment_data.value');
collected_at := jResp.StringOf('collected_at');
value_date := jResp.StringOf('value_date');
accounting_date := jResp.StringOf('accounting_date');
amount := jResp.StringOf('amount');
balance := jResp.StringOf('balance');
v_currency := jResp.StringOf('currency');
description := jResp.StringOf('description');
observations := jResp.StringOf('observations');
category := jResp.StringOf('category');
reference := jResp.StringOf('reference');
v_type := jResp.StringOf('type');
status := jResp.StringOf('status');
Pickup_at := jResp.StringOf('gig_data.pickup_at');
Dropoff_at := jResp.StringOf('gig_data.dropoff_at');
Request_at := jResp.StringOf('gig_data.request_at');
Pickup_address := jResp.StringOf('gig_data.pickup_address');
Dropoff_address := jResp.StringOf('gig_data.dropoff_address');
Pickup_latitude := jResp.StringOf('gig_data.pickup_latitude');
Pickup_longitude := jResp.StringOf('gig_data.pickup_longitude');
Dropoff_latitude := jResp.StringOf('gig_data.dropoff_latitude');
Dropoff_longitude := jResp.StringOf('gig_data.dropoff_longitude');
Distance := jResp.StringOf('gig_data.distance');
Payment_method := jResp.StringOf('gig_data.payment_method');
Vehicle_type := jResp.StringOf('gig_data.vehicle_type');
Merchant_type := jResp.StringOf('gig_data.merchant_type');
Collected_at := jResp.StringOf('gig_data.collected_at');
Bill_name := jResp.StringOf('credit_card_data.bill_name');
i := 0;
count_i := jResp.SizeOfArray('gig_data.breakdown');
while i < count_i do
  begin
    jResp.I := i;
    value := jResp.StringOf('gig_data.breakdown[i].value');
    i := i + 1;
  end;

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/transactions/:id/

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/transactions/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "transactions",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `transaction.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific transaction."
  },
  "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/transactions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "transactions",
            ":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\"account\": {\n\t\t\"id\": \"<uuid>\",\n\t\t\"link\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"institution\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"collected_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"category\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"type\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"number\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"balance\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"currency\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"bank_product_id\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"internal_identification\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_value\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"last_accessed_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"credit_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"loan_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"funds_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"gig_payment_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t},\n\t\"collected_at\": \"<date>\",\n\t\"value_date\": \"<string>\",\n\t\"accounting_date\": \"<date>\",\n\t\"amount\": \"<number>\",\n\t\"balance\": \"<number>\",\n\t\"currency\": \"<string>\",\n\t\"description\": \"<string>\",\n\t\"observations\": \"<string>\",\n\t\"category\": \"<string>\",\n\t\"reference\": \"<string>\",\n\t\"type\": \"eiusmod veniam ea sint\",\n\t\"status\": \"est nostrud\",\n\t\"gig_data\": {\n\t\t\"pickup_at\": \"<dateTime>\",\n\t\t\"dropoff_at\": \"<dateTime>\",\n\t\t\"request_at\": \"<dateTime>\",\n\t\t\"pickup_address\": \"<string>\",\n\t\t\"dropoff_address\": \"<string>\",\n\t\t\"pickup_latitude\": \"<number>\",\n\t\t\"pickup_longitude\": \"<number>\",\n\t\t\"dropoff_latitude\": \"<number>\",\n\t\t\"dropoff_longitude\": \"<number>\",\n\t\t\"distance\": \"<number>\",\n\t\t\"payment_method\": \"<string>\",\n\t\t\"vehicle_type\": \"<string>\",\n\t\t\"merchant_type\": \"<string>\",\n\t\t\"breakdown\": [\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t{\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\"collected_at\": \"<dateTime>\"\n\t},\n\t\"credit_card_data\": {\n\t\t\"bill_name\": \"<string>\"\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/transactions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "transactions",
            ":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/transactions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "transactions",
            ":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]"
    }
  ]
}