Chilkat Online Tools

C# / Belvo API Docs / Retrieve

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "{{secretId}}";
http.Password = "{{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.

// {
//   "date_from": "2021-01-01",
//   "date_to": "2021-03-30",
//   "link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
//   "token": "1234ab",
//   "save_data": true,
//   "account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("date_from","2021-01-01");
json.UpdateString("date_to","2021-03-30");
json.UpdateString("link","2ccd5e15-194a-4a19-a45a-e7223c7e6717");
json.UpdateString("token","1234ab");
json.UpdateBool("save_data",true);
json.UpdateString("account","d4617561-1c01-4b2f-83b6-a594f7b3bc57");

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

Chilkat.HttpResponse resp = http.PostJson3("https://domain.com/api/balances/","application/json",json);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonArray jarrResp = new Chilkat.JsonArray();
jarrResp.LoadSb(sbResponseBody);
jarrResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jarrResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

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

// [
//   {
//     "id": "<uuid>",
//     "account": {
//       "id": "<uuid>",
//       "name": "<string>",
//       "category": "eu exercitation id ullamco",
//       "currency": "<string>"
//     },
//     "collected_at": "<dateTime>",
//     "value_date": "<date>",
//     "balance": "<number>",
//     "current_balance": "<number>",
//     "statement": "<string>"
//   },
//   {
//     "id": "<uuid>",
//     "account": {
//       "id": "<uuid>",
//       "name": "<string>",
//       "category": "eu tempor adipisicing",
//       "currency": "<string>"
//     },
//     "collected_at": "<dateTime>",
//     "value_date": "<date>",
//     "balance": "<number>",
//     "current_balance": "<number>",
//     "statement": "<string>"
//   }
// ]

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

Chilkat.JsonObject json = null;
string id;
string Id;
string Name;
string Category;
string v_Currency;
string collected_at;
string value_date;
string balance;
string current_balance;
string statement;

int i = 0;
int count_i = jarrResp.Size;
while (i < count_i) {
    json = jarrResp.ObjectAt(i);
    id = json.StringOf("id");
    Id = json.StringOf("account.id");
    Name = json.StringOf("account.name");
    Category = json.StringOf("account.category");
    v_Currency = json.StringOf("account.currency");
    collected_at = json.StringOf("collected_at");
    value_date = json.StringOf("value_date");
    balance = json.StringOf("balance");
    current_balance = json.StringOf("current_balance");
    statement = json.StringOf("statement");

    i = i + 1;
}

Curl Command

curl -X POST
	-u '{{secretId}}:{{secretPassword}}'
	-H "Content-Type: application/json"
	-d '{
    "date_from": "2021-01-01",
    "date_to": "2021-03-30",
    "link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
    "token": "1234ab",
    "save_data": true,
    "account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
}'
https://domain.com/api/balances/

Postman Collection Item JSON

{
  "name": "Retrieve",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"date_from\": \"2021-01-01\",\n    \"date_to\": \"2021-03-30\",\n    \"link\": \"2ccd5e15-194a-4a19-a45a-e7223c7e6717\",\n    \"token\": \"1234ab\",\n    \"save_data\": true,\n    \"account\": \"d4617561-1c01-4b2f-83b6-a594f7b3bc57\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/balances/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "balances",
        ""
      ]
    },
    "description": "Retrieve balances from one or more accounts for a specific link within a specified date range."
  },
  "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu exercitation id ullamco\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu tempor adipisicing\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu exercitation id ullamco\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu tempor adipisicing\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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    \"date_from\": \"<date>\",\n    \"date_to\": \"<date>\",\n    \"link\": \"<uuid>\",\n    \"encryption_key\": \"<string>\",\n    \"token\": \"<string>\",\n    \"save_data\": true,\n    \"account\": \"<uuid>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ]
        }
      },
      "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]"
    }
  ]
}