Chilkat Online Tools

VB.NET / Belvo API Docs / Detail

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "{{secretId}}"
http.Password = "{{secretPassword}}"


Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://domain.com/api/accounts/:id/",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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




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