Chilkat Online Tools

Python / Belvo API Docs / Detail

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

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

sbResponseBody = chilkat.CkStringBuilder()
success = http.QuickGetSb("https://domain.com/api/accounts/:id/",sbResponseBody)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = http.get_LastStatus()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(http.lastHeader())
    print("Failed.")
    sys.exit()

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

# {
#   "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>"
#   }
# }

# 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")
Value = jResp.stringOf("link.value")
institutionValue = jResp.stringOf("institution.value")
collected_atValue = jResp.stringOf("collected_at.value")
categoryValue = jResp.stringOf("category.value")
typeValue = jResp.stringOf("type.value")
nameValue = jResp.stringOf("name.value")
numberValue = jResp.stringOf("number.value")
balanceValue = jResp.stringOf("balance.value")
currencyValue = jResp.stringOf("currency.value")
bank_product_idValue = jResp.stringOf("bank_product_id.value")
internal_identificationValue = jResp.stringOf("internal_identification.value")
public_identification_nameValue = jResp.stringOf("public_identification_name.value")
public_identification_valueValue = jResp.stringOf("public_identification_value.value")
last_accessed_atValue = jResp.stringOf("last_accessed_at.value")
credit_dataValue = jResp.stringOf("credit_data.value")
loan_dataValue = jResp.stringOf("loan_data.value")
funds_dataValue = jResp.stringOf("funds_data.value")
gig_payment_dataValue = jResp.stringOf("gig_payment_data.value")

Curl Command

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

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/accounts/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "accounts",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `account.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific account."
  },
  "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/accounts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts",
            ":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\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"institution\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"collected_at\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"category\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"type\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"name\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"number\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"balance\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"currency\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"bank_product_id\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"internal_identification\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"public_identification_name\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"public_identification_value\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"last_accessed_at\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"credit_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"loan_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"funds_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"gig_payment_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\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/accounts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts",
            ":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/accounts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts",
            ":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]"
    }
  ]
}