Chilkat Online Tools

unicodeCpp / Belvo API Docs / Detail

Back to Collection Items

#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttpW http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login(L"{{secretId}}");
    http.put_Password(L"{{secretPassword}}");

    CkStringBuilderW sbResponseBody;
    success = http.QuickGetSb(L"https://domain.com/api/transactions/:id/",sbResponseBody);
    if (success == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = http.get_LastStatus();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",http.lastHeader());
        wprintf(L"Failed.\n");
        return;
    }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const wchar_t *value = 0;

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

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]"
    }
  ]
}