Chilkat Online Tools

PowerBuilder / Belvo API Docs / Detail

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Value
string ls_InstitutionValue
string ls_Collected_atValue
string ls_CategoryValue
string ls_TypeValue
string ls_NameValue
string ls_NumberValue
string ls_BalanceValue
string ls_CurrencyValue
string ls_Bank_product_idValue
string ls_Internal_identificationValue
string ls_Public_identification_nameValue
string ls_Public_identification_valueValue
string ls_Last_accessed_atValue
string ls_Credit_dataValue
string ls_Loan_dataValue
string ls_Funds_dataValue
string ls_Gig_payment_dataValue

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.BasicAuth = 1
loo_Http.Login = "{{secretId}}"
loo_Http.Password = "{{secretPassword}}"

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://domain.com/api/accounts/:id/",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
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

ls_Id = loo_JResp.StringOf("id")
ls_Value = loo_JResp.StringOf("link.value")
ls_InstitutionValue = loo_JResp.StringOf("institution.value")
ls_Collected_atValue = loo_JResp.StringOf("collected_at.value")
ls_CategoryValue = loo_JResp.StringOf("category.value")
ls_TypeValue = loo_JResp.StringOf("type.value")
ls_NameValue = loo_JResp.StringOf("name.value")
ls_NumberValue = loo_JResp.StringOf("number.value")
ls_BalanceValue = loo_JResp.StringOf("balance.value")
ls_CurrencyValue = loo_JResp.StringOf("currency.value")
ls_Bank_product_idValue = loo_JResp.StringOf("bank_product_id.value")
ls_Internal_identificationValue = loo_JResp.StringOf("internal_identification.value")
ls_Public_identification_nameValue = loo_JResp.StringOf("public_identification_name.value")
ls_Public_identification_valueValue = loo_JResp.StringOf("public_identification_value.value")
ls_Last_accessed_atValue = loo_JResp.StringOf("last_accessed_at.value")
ls_Credit_dataValue = loo_JResp.StringOf("credit_data.value")
ls_Loan_dataValue = loo_JResp.StringOf("loan_data.value")
ls_Funds_dataValue = loo_JResp.StringOf("funds_data.value")
ls_Gig_payment_dataValue = loo_JResp.StringOf("gig_payment_data.value")


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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