Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
$http->BasicAuth = 1;
$http->Login = '{{secretId}}';
$http->Password = '{{secretPassword}}';
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://domain.com/api/statements/:id/',$sbResponseBody);
if ($success == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $http->LastHeader . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "<uuid>",
// "link": "<string>",
// "account": {
// "id": "<uuid>",
// "name": "<string>",
// "category": "non consequat",
// "currency": "<string>"
// },
// "collected_at": "<dateTime>",
// "account_number": "<string>",
// "client_number": "<string>",
// "RFC": "<string>",
// "CLABE": "<string>",
// "period_start_date": "<date>",
// "period_end_date": "<date>",
// "cut_date": "<string>",
// "final_balance": "<number>",
// "previous_balance": "<number>",
// "total_inflow_amount": "<number>",
// "total_outflow_amount": "<number>",
// "total_inflow_transactions": "<number>",
// "total_outflow_transactions": "<number>",
// "transactions": [
// {
// "collected_at": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "accounting_date": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "value_date": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "reference": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "observations": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "additional_data": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "balance": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "status": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "currency": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "description": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "internal_identification": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "account": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// {
// "collected_at": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "accounting_date": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "value_date": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "reference": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "observations": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "additional_data": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "balance": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "status": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "currency": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "description": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "internal_identification": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "account": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// ],
// "pdf": "<binary>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$id = $jResp->stringOf('id');
$link = $jResp->stringOf('link');
$Id = $jResp->stringOf('account.id');
$Name = $jResp->stringOf('account.name');
$Category = $jResp->stringOf('account.category');
$v_Currency = $jResp->stringOf('account.currency');
$collected_at = $jResp->stringOf('collected_at');
$account_number = $jResp->stringOf('account_number');
$client_number = $jResp->stringOf('client_number');
$RFC = $jResp->stringOf('RFC');
$CLABE = $jResp->stringOf('CLABE');
$period_start_date = $jResp->stringOf('period_start_date');
$period_end_date = $jResp->stringOf('period_end_date');
$cut_date = $jResp->stringOf('cut_date');
$final_balance = $jResp->stringOf('final_balance');
$previous_balance = $jResp->stringOf('previous_balance');
$total_inflow_amount = $jResp->stringOf('total_inflow_amount');
$total_outflow_amount = $jResp->stringOf('total_outflow_amount');
$total_inflow_transactions = $jResp->stringOf('total_inflow_transactions');
$total_outflow_transactions = $jResp->stringOf('total_outflow_transactions');
$pdf = $jResp->stringOf('pdf');
$i = 0;
$count_i = $jResp->SizeOfArray('transactions');
while ($i < $count_i) {
$jResp->I = $i;
$Value = $jResp->stringOf('transactions[i].collected_at.value');
$accounting_dateValue = $jResp->stringOf('transactions[i].accounting_date.value');
$value_dateValue = $jResp->stringOf('transactions[i].value_date.value');
$referenceValue = $jResp->stringOf('transactions[i].reference.value');
$observationsValue = $jResp->stringOf('transactions[i].observations.value');
$additional_dataValue = $jResp->stringOf('transactions[i].additional_data.value');
$balanceValue = $jResp->stringOf('transactions[i].balance.value');
$statusValue = $jResp->stringOf('transactions[i].status.value');
$typeValue = $jResp->stringOf('transactions[i].type.value');
$currencyValue = $jResp->stringOf('transactions[i].currency.value');
$descriptionValue = $jResp->stringOf('transactions[i].description.value');
$internal_identificationValue = $jResp->stringOf('transactions[i].internal_identification.value');
$accountValue = $jResp->stringOf('transactions[i].account.value');
$i = $i + 1;
}
?>
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/statements/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/statements/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `statement.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific statement."
},
"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/statements/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": \"<string>\",\n\t\"account\": {\n\t\t\"id\": \"<uuid>\",\n\t\t\"name\": \"<string>\",\n\t\t\"category\": \"non consequat\",\n\t\t\"currency\": \"<string>\"\n\t},\n\t\"collected_at\": \"<dateTime>\",\n\t\"account_number\": \"<string>\",\n\t\"client_number\": \"<string>\",\n\t\"RFC\": \"<string>\",\n\t\"CLABE\": \"<string>\",\n\t\"period_start_date\": \"<date>\",\n\t\"period_end_date\": \"<date>\",\n\t\"cut_date\": \"<string>\",\n\t\"final_balance\": \"<number>\",\n\t\"previous_balance\": \"<number>\",\n\t\"total_inflow_amount\": \"<number>\",\n\t\"total_outflow_amount\": \"<number>\",\n\t\"total_inflow_transactions\": \"<number>\",\n\t\"total_outflow_transactions\": \"<number>\",\n\t\"transactions\": [\n\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\"accounting_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_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\"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\"status\": {\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\"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\"description\": {\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\"account\": {\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\"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\"accounting_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_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\"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\"status\": {\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\"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\"description\": {\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\"account\": {\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\t\"pdf\": \"<binary>\"\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/statements/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"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": "Too Many Sessions",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/statements/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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]"
}
]
}
