Chilkat Online Tools

Go / Belvo API Docs / Retrieve

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

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
    //   "token": "1234ab",
    //   "save_data": true,
    //   "date_from": "Optional start date, in YYYY-MM-DD format",
    //   "date_to": "Optional end date, in YYYY-MM-DD format"
    // }

    json := chilkat.NewJsonObject()
    json.UpdateString("link","2ccd5e15-194a-4a19-a45a-e7223c7e6717")
    json.UpdateString("token","1234ab")
    json.UpdateBool("save_data",true)
    json.UpdateString("date_from","Optional start date, in YYYY-MM-DD format")
    json.UpdateString("date_to","Optional end date, in YYYY-MM-DD format")

    http.SetRequestHeader("Content-Type","application/json")

    resp := http.PostJson3("https://domain.com/api/incomes/","application/json",json)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        json.DisposeJsonObject()
        return
    }

    sbResponseBody := chilkat.NewStringBuilder()
    resp.GetBodySb(sbResponseBody)

    jarrResp := chilkat.NewJsonArray()
    jarrResp.LoadSb(sbResponseBody)
    jarrResp.SetEmitCompact(false)

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

    respStatusCode := resp.StatusCode()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(resp.Header())
        fmt.Println("Failed.")
        resp.DisposeHttpResponse()
        http.DisposeHttp()
        json.DisposeJsonObject()
        sbResponseBody.DisposeStringBuilder()
        jarrResp.DisposeJsonArray()
        return
    }

    resp.DisposeHttpResponse()

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

    // [
    //   {
    //     "collected_at": "<dateTime>",
    //     "account": {
    //       "name": "<string>",
    //       "currency": "<string>",
    //       "category": "aliqua Excepteur laboris fugiat do"
    //     },
    //     "currency": "<string>",
    //     "sources": [
    //       {
    //         "transactions": [
    //           {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           }
    //         ],
    //         "confidence": "<string>",
    //         "type": "<string>"
    //       },
    //       {
    //         "transactions": [
    //           {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           }
    //         ],
    //         "confidence": "<string>",
    //         "type": "<string>"
    //       }
    //     ]
    //   },
    //   {
    //     "collected_at": "<dateTime>",
    //     "account": {
    //       "name": "<string>",
    //       "currency": "<string>",
    //       "category": "ad est aliqua aute"
    //     },
    //     "currency": "<string>",
    //     "sources": [
    //       {
    //         "transactions": [
    //           {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           }
    //         ],
    //         "confidence": "<string>",
    //         "type": "<string>"
    //       },
    //       {
    //         "transactions": [
    //           {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           }
    //         ],
    //         "confidence": "<string>",
    //         "type": "<string>"
    //       }
    //     ]
    //   }
    // ]

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // json is a JsonObject_Ref.html">JsonObject
    var collected_at *string = new(string)
    var Name *string = new(string)
    var v_Currency *string = new(string)
    var Category *string = new(string)
    var v_currency *string = new(string)
    var j int
    var count_j int
    var confidence *string = new(string)
    var v_type *string = new(string)
    var k int
    var count_k int
    var value *string = new(string)

    i := 0
    count_i := jarrResp.Size()
    for i < count_i {
        json := jarrResp.ObjectAt(i)
        collected_at = json.StringOf("collected_at")
        Name = json.StringOf("account.name")
        v_Currency = json.StringOf("account.currency")
        Category = json.StringOf("account.category")
        v_currency = json.StringOf("currency")
        j = 0
        count_j = json.SizeOfArray("sources")
        for j < count_j {
            json.SetJ(j)
            confidence = json.StringOf("sources[j].confidence")
            v_type = json.StringOf("sources[j].type")
            k = 0
            count_k = json.SizeOfArray("sources[j].transactions")
            for k < count_k {
                json.SetK(k)
                value = json.StringOf("sources[j].transactions[k].value")
                k = k + 1
            }

            j = j + 1
        }

        json.DisposeJsonObject()
        i = i + 1
    }


    http.DisposeHttp()
    json.DisposeJsonObject()
    sbResponseBody.DisposeStringBuilder()
    jarrResp.DisposeJsonArray()

Curl Command

curl -X POST
	-u '{{secretId}}:{{secretPassword}}'
	-H "Content-Type: application/json"
	-d '{
    "link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
    "token": "1234ab",
    "save_data": true,
    "date_from": "Optional start date, in YYYY-MM-DD format",
    "date_to": "Optional end date, in YYYY-MM-DD format"
}'
https://domain.com/api/incomes/

Postman Collection Item JSON

{
  "name": "Retrieve",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"link\": \"2ccd5e15-194a-4a19-a45a-e7223c7e6717\",\n    \"token\": \"1234ab\",\n    \"save_data\": true,\n    \"date_from\": \"Optional start date, in YYYY-MM-DD format\",\n    \"date_to\": \"Optional end date, in YYYY-MM-DD format\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/incomes/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "incomes",
        ""
      ]
    },
    "description": "Retrieve income insights for <b>checking and savings accounts</b> from a specific link. You can receive insights for a period of up to 365 days, depending on the transaction history available for each [bank](https://developers.belvo.com/docs/institution)."
  },
  "response": [
    {
      "name": "Ok (when save_data=false)",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"b314af95-5eb7-1b56-4de7-4bb2c7766fce\",\n    \"encryption_key\": \"nostrud esse sint adipisicing\",\n    \"token\": \"elit eu magna\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/incomes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"aliqua Excepteur laboris fugiat do\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t}\n\t\t]\n\t},\n\t{\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"ad est aliqua aute\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t}\n\t\t]\n\t}\n]"
    },
    {
      "name": "Created (when save_data=true)",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"b314af95-5eb7-1b56-4de7-4bb2c7766fce\",\n    \"encryption_key\": \"nostrud esse sint adipisicing\",\n    \"token\": \"elit eu magna\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/incomes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"tempor\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t}\n\t\t]\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"mollit dolor ex in\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t}\n\t\t]\n\t}\n]"
    },
    {
      "name": "Bad request error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"b314af95-5eb7-1b56-4de7-4bb2c7766fce\",\n    \"encryption_key\": \"nostrud esse sint adipisicing\",\n    \"token\": \"elit eu magna\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/incomes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_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": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"b314af95-5eb7-1b56-4de7-4bb2c7766fce\",\n    \"encryption_key\": \"nostrud esse sint adipisicing\",\n    \"token\": \"elit eu magna\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/incomes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes"
          ]
        }
      },
      "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": "Request Timeout",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"b314af95-5eb7-1b56-4de7-4bb2c7766fce\",\n    \"encryption_key\": \"nostrud esse sint adipisicing\",\n    \"token\": \"elit eu magna\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/incomes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes"
          ]
        }
      },
      "status": "Request Timeout",
      "code": 408,
      "_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": "MFA Token Required",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"b314af95-5eb7-1b56-4de7-4bb2c7766fce\",\n    \"encryption_key\": \"nostrud esse sint adipisicing\",\n    \"token\": \"elit eu magna\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/incomes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes"
          ]
        }
      },
      "status": "Precondition Required",
      "code": 428,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"code\": \"<string>\",\n\t\"message\": \"<string>\",\n\t\"request_id\": \"<uuid>\",\n\t\"session\": \"<uuid>\",\n\t\"expiry\": \"<integer>\",\n\t\"link\": \"<uuid>\",\n\t\"token_generation_data\": {\n\t\t\"instructions\": \"<string>\",\n\t\t\"type\": \"<string>\",\n\t\t\"value\": \"<string>\"\n\t}\n}"
    },
    {
      "name": "Unexpected Error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"b314af95-5eb7-1b56-4de7-4bb2c7766fce\",\n    \"encryption_key\": \"nostrud esse sint adipisicing\",\n    \"token\": \"elit eu magna\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/incomes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_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]"
    }
  ]
}