Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$http->put_BasicAuth(true);
$http->put_Login('{{secretId}}');
$http->put_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.
// {
// "session": "39cd6a88-8ee3-4e59-a861-b8a2187e0f4c",
// "token": "1234ab",
// "link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
// "save_data": true
// }
$json = new CkJsonObject();
$json->UpdateString('session','39cd6a88-8ee3-4e59-a861-b8a2187e0f4c');
$json->UpdateString('token','1234ab');
$json->UpdateString('link','683005d6-f45c-4adb-b289-f1a12f50f80c');
$json->UpdateBool('save_data',true);
$http->SetRequestHeader('Content-Type','application/json');
$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
// resp is a CkHttpResponse
$resp = $http->PTextSb('PATCH','https://domain.com/api/accounts/',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jarrResp = new CkJsonArray();
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jarrResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "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
$i = 0;
$count_i = $jarrResp->get_Size();
while ($i < $count_i) {
// json is a CkJsonObject
$json = $jarrResp->ObjectAt($i);
$Value = $json->stringOf('link.value');
$institutionValue = $json->stringOf('institution.value');
$collected_atValue = $json->stringOf('collected_at.value');
$categoryValue = $json->stringOf('category.value');
$typeValue = $json->stringOf('type.value');
$nameValue = $json->stringOf('name.value');
$numberValue = $json->stringOf('number.value');
$balanceValue = $json->stringOf('balance.value');
$currencyValue = $json->stringOf('currency.value');
$bank_product_idValue = $json->stringOf('bank_product_id.value');
$internal_identificationValue = $json->stringOf('internal_identification.value');
$public_identification_nameValue = $json->stringOf('public_identification_name.value');
$public_identification_valueValue = $json->stringOf('public_identification_value.value');
$last_accessed_atValue = $json->stringOf('last_accessed_at.value');
$credit_dataValue = $json->stringOf('credit_data.value');
$loan_dataValue = $json->stringOf('loan_data.value');
$funds_dataValue = $json->stringOf('funds_data.value');
$gig_payment_dataValue = $json->stringOf('gig_payment_data.value');
$i = $i + 1;
}
?>
Curl Command
curl -X PATCH
-u '{{secretId}}:{{secretPassword}}'
-H "Content-Type: application/json"
-d '{
"session": "39cd6a88-8ee3-4e59-a861-b8a2187e0f4c",
"token": "1234ab",
"link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
"save_data": true
}'
https://domain.com/api/accounts/
Postman Collection Item JSON
{
"name": "Resume",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"session\": \"39cd6a88-8ee3-4e59-a861-b8a2187e0f4c\",\n \"token\": \"1234ab\",\n \"link\": \"683005d6-f45c-4adb-b289-f1a12f50f80c\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/accounts/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts",
""
]
},
"description": "Used to resume an Account retrieve session that was paused because an MFA token was required by the institution."
},
"response": [
{
"name": "Ok (when save_data=false)",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"link\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"institution\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"collected_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"category\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"type\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"number\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"balance\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"currency\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"bank_product_id\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"internal_identification\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_value\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"last_accessed_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"credit_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"loan_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"funds_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"gig_payment_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t},\n\t{\n\t\t\"link\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"institution\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"collected_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"category\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"type\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"number\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"balance\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"currency\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"bank_product_id\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"internal_identification\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_value\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"last_accessed_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"credit_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"loan_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"funds_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"gig_payment_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t}\n]"
},
{
"name": "Created (when save_data=true)",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts"
]
}
},
"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\"link\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"institution\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"collected_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"category\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"type\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"number\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"balance\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"currency\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"bank_product_id\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"internal_identification\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_value\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"last_accessed_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"credit_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"loan_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"funds_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"gig_payment_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"link\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"institution\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"collected_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"category\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"type\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"number\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"balance\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"currency\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"bank_product_id\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"internal_identification\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_value\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"last_accessed_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"credit_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"loan_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"funds_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"gig_payment_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t}\n]"
},
{
"name": "Bad request error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts"
]
}
},
"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": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts"
]
}
},
"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": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts"
]
}
},
"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": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts"
]
}
},
"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": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"accounts"
]
}
},
"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]"
}
]
}
