Chilkat Online Tools

Ruby / Belvo API Docs / Detail

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/api/transactions/:id/",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    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
    jResp.put_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]"
    }
  ]
}