Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"{{secretId}}"); http.put_Password(L"{{secretPassword}}"); json.UpdateString(L"institution",L"erebor_mx_retail"); json.UpdateString(L"username",L"username"); json.UpdateString(L"password",L"password"); json.UpdateString(L"username2",L"secondusername"); json.UpdateString(L"username3",L"thirdusername"); json.UpdateString(L"password2",L"pin"); json.UpdateString(L"token",L"1234ab"); json.UpdateString(L"access_mode",L"recurrent"); json.UpdateString(L"username_type",L"001"); json.UpdateString(L"certificate",L"1234567890abcd="); json.UpdateString(L"private_key",L"1234567890abcd="); resp->GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false);
}
Curl Command
curl -X POST
-u '{{secretId}}:{{secretPassword}}'
-H "Content-Type: application/json"
-d '{
"institution": "erebor_mx_retail",
"username": "username",
"password": "password",
"username2": "secondusername",
"username3": "thirdusername",
"password2": "pin",
"token": "1234ab",
"access_mode": "recurrent",
"username_type": "001",
"certificate": "1234567890abcd=",
"private_key": "1234567890abcd="
}'
https://domain.com/api/links/
Postman Collection Item JSON
{
"name": "Register",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"institution\": \"erebor_mx_retail\",\n \"username\": \"username\",\n \"password\": \"password\",\n \"username2\": \"secondusername\",\n \"username3\": \"thirdusername\",\n \"password2\": \"pin\",\n \"token\": \"1234ab\",\n \"access_mode\": \"recurrent\",\n \"username_type\": \"001\",\n \"certificate\": \"1234567890abcd=\",\n \"private_key\": \"1234567890abcd=\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links",
""
]
},
"description": "Register a new link with your Belvo account."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"institution\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"username2\": \"<string>\",\n \"username3\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"access_mode\": \"recurrent\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"institution\": \"<string>\",\n\t\"access_mode\": \"<string>\",\n\t\"last_accessed_at\": \"<dateTime>\",\n\t\"status\": \"<string>\",\n\t\"created_by\": \"<uuid>\",\n\t\"refresh_rate\": \"<string>\"\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 \"institution\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"username2\": \"<string>\",\n \"username3\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"access_mode\": \"recurrent\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links"
]
}
},
"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 \"institution\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"username2\": \"<string>\",\n \"username3\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"access_mode\": \"recurrent\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links"
]
}
},
"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": "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 \"institution\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"username2\": \"<string>\",\n \"username3\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"access_mode\": \"recurrent\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links"
]
}
},
"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 \"institution\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"username2\": \"<string>\",\n \"username3\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"access_mode\": \"recurrent\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links"
]
}
},
"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]"
}
]
}