Chilkat Online Tools

Go / Belvo API Docs / List

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("{{secretId}}")
    http.SetPassword("{{secretPassword}}")

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://domain.com/api/accounts/",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

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

    // {
    //   "count": "<integer>",
    //   "next": "<string>",
    //   "previous": "<string>",
    //   "results": [
    //     {
    //       "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>"
    //       }
    //     },
    //     {
    //       "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

    var Value *string = new(string)
institution    var Value *string = new(string)
    var collected_atValue *string = new(string)
    var categoryValue *string = new(string)
    var typeValue *string = new(string)
    var nameValue *string = new(string)
number    var Value *string = new(string)
balance    var Value *string = new(string)
    var currencyValue *string = new(string)
    var bank_product_idValue *string = new(string)
    var internal_identificationValue *string = new(string)
    var public_identification_nameValue *string = new(string)
    var public_identification_valueValue *string = new(string)
    var last_accessed_atValue *string = new(string)
    var credit_dataValue *string = new(string)
    var loan_dataValue *string = new(string)
    var funds_dataValue *string = new(string)
    var gig_payment_dataValue *string = new(string)

    count := jResp.StringOf("count")
    v_next := jResp.StringOf("next")
    previous := jResp.StringOf("previous")
    i := 0
    count_i := jResp.SizeOfArray("results")
    for i < count_i {
        jResp.SetI(i)
        Value = jResp.StringOf("results[i].link.value")
        institutionValue = jResp.StringOf("results[i].institution.value")
        collected_atValue = jResp.StringOf("results[i].collected_at.value")
        categoryValue = jResp.StringOf("results[i].category.value")
        typeValue = jResp.StringOf("results[i].type.value")
        nameValue = jResp.StringOf("results[i].name.value")
        numberValue = jResp.StringOf("results[i].number.value")
        balanceValue = jResp.StringOf("results[i].balance.value")
        currencyValue = jResp.StringOf("results[i].currency.value")
        bank_product_idValue = jResp.StringOf("results[i].bank_product_id.value")
        internal_identificationValue = jResp.StringOf("results[i].internal_identification.value")
        public_identification_nameValue = jResp.StringOf("results[i].public_identification_name.value")
        public_identification_valueValue = jResp.StringOf("results[i].public_identification_value.value")
        last_accessed_atValue = jResp.StringOf("results[i].last_accessed_at.value")
        credit_dataValue = jResp.StringOf("results[i].credit_data.value")
        loan_dataValue = jResp.StringOf("results[i].loan_data.value")
        funds_dataValue = jResp.StringOf("results[i].funds_data.value")
        gig_payment_dataValue = jResp.StringOf("results[i].gig_payment_data.value")
        i = i + 1
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

Curl Command

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

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/accounts/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "accounts",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "1",
          "description": "A page number within the paginated result set.",
          "disabled": true
        }
      ]
    },
    "description": "Get a paginated list of all existing accounts in your Belvo account. We return up to 100 results per page.\n\n**Filterable fields**\n\nPlease see the table below for an alphabetized list of fields that you can filter your responses by. For more information on how to use filters, see our [Filtering responses](https://developers.belvo.com/docs/searching-and-filtering) article.\n\n|Field| Available Filters|\n|---|---|\n|`balance__available`|`=`, `gt`, `gte`, `lt`, `lte`, `range`|\n|`balance__current`|`=`, `gt`, `gte`, `lt`, `lte`, `range`|\n|`bank_product_id`|`=`|\n|`category`|`=`, `in`|\n|`collected_at`|`=`, `gt`, `gte`, `lt`, `lte`, `range`|\n|`currency`|`=`, `in`|\n|`id`|`=`, `in`|\n|`institution`|`=`, `in`|\n|`internal_identification`|`=`|\n|`link`|`=`, `in`|\n|`name`|`=`, `icontains`|\n|`number`|`=`, `in`|\n|`public_identification_name`|`=`|\n|`public_identification_value`|`=`|\n|`type`|`=`, `in`|"
  },
  "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?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts"
          ],
          "query": [
            {
              "key": "page",
              "value": "<integer>"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"count\": \"<integer>\",\n\t\"next\": \"<string>\",\n\t\"previous\": \"<string>\",\n\t\"results\": [\n\t\t{\n\t\t\t\"link\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"institution\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"category\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"number\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"bank_product_id\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"last_accessed_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"credit_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"loan_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"funds_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"gig_payment_data\": {\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{\n\t\t\t\"link\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"institution\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"category\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"number\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"bank_product_id\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"public_identification_value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"last_accessed_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"credit_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"loan_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"funds_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"gig_payment_data\": {\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]\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?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts"
          ],
          "query": [
            {
              "key": "page",
              "value": "<integer>"
            }
          ]
        }
      },
      "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]"
    }
  ]
}