Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.BasicAuth = true;
http.Login = "{{secretId}}";
http.Password = "{{secretPassword}}";
var sbResponseBody = new chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/api/transactions/:id/",sbResponseBody);
if (success == false) {
console.log(http.LastErrorText);
return;
}
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(http.LastHeader);
console.log("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "<uuid>",
// "account": {
// "id": "<uuid>",
// "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>"
// }
// },
// "collected_at": "<date>",
// "value_date": "<string>",
// "accounting_date": "<date>",
// "amount": "<number>",
// "balance": "<number>",
// "currency": "<string>",
// "description": "<string>",
// "observations": "<string>",
// "category": "<string>",
// "reference": "<string>",
// "type": "eiusmod veniam ea sint",
// "status": "est nostrud",
// "gig_data": {
// "pickup_at": "<dateTime>",
// "dropoff_at": "<dateTime>",
// "request_at": "<dateTime>",
// "pickup_address": "<string>",
// "dropoff_address": "<string>",
// "pickup_latitude": "<number>",
// "pickup_longitude": "<number>",
// "dropoff_latitude": "<number>",
// "dropoff_longitude": "<number>",
// "distance": "<number>",
// "payment_method": "<string>",
// "vehicle_type": "<string>",
// "merchant_type": "<string>",
// "breakdown": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "collected_at": "<dateTime>"
// },
// "credit_card_data": {
// "bill_name": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var value;
var id = jResp.StringOf("id");
var Id = jResp.StringOf("account.id");
var Value = jResp.StringOf("account.link.value");
var InstitutionValue = jResp.StringOf("account.institution.value");
var Collected_atValue = jResp.StringOf("account.collected_at.value");
var CategoryValue = jResp.StringOf("account.category.value");
var TypeValue = jResp.StringOf("account.type.value");
var NameValue = jResp.StringOf("account.name.value");
var NumberValue = jResp.StringOf("account.number.value");
var BalanceValue = jResp.StringOf("account.balance.value");
var CurrencyValue = jResp.StringOf("account.currency.value");
var Bank_product_idValue = jResp.StringOf("account.bank_product_id.value");
var Internal_identificationValue = jResp.StringOf("account.internal_identification.value");
var Public_identification_nameValue = jResp.StringOf("account.public_identification_name.value");
var Public_identification_valueValue = jResp.StringOf("account.public_identification_value.value");
var Last_accessed_atValue = jResp.StringOf("account.last_accessed_at.value");
var Credit_dataValue = jResp.StringOf("account.credit_data.value");
var Loan_dataValue = jResp.StringOf("account.loan_data.value");
var Funds_dataValue = jResp.StringOf("account.funds_data.value");
var Gig_payment_dataValue = jResp.StringOf("account.gig_payment_data.value");
var collected_at = jResp.StringOf("collected_at");
var value_date = jResp.StringOf("value_date");
var accounting_date = jResp.StringOf("accounting_date");
var amount = jResp.StringOf("amount");
var balance = jResp.StringOf("balance");
var v_currency = jResp.StringOf("currency");
var description = jResp.StringOf("description");
var observations = jResp.StringOf("observations");
var category = jResp.StringOf("category");
var reference = jResp.StringOf("reference");
var v_type = jResp.StringOf("type");
var status = jResp.StringOf("status");
var Pickup_at = jResp.StringOf("gig_data.pickup_at");
var Dropoff_at = jResp.StringOf("gig_data.dropoff_at");
var Request_at = jResp.StringOf("gig_data.request_at");
var Pickup_address = jResp.StringOf("gig_data.pickup_address");
var Dropoff_address = jResp.StringOf("gig_data.dropoff_address");
var Pickup_latitude = jResp.StringOf("gig_data.pickup_latitude");
var Pickup_longitude = jResp.StringOf("gig_data.pickup_longitude");
var Dropoff_latitude = jResp.StringOf("gig_data.dropoff_latitude");
var Dropoff_longitude = jResp.StringOf("gig_data.dropoff_longitude");
var Distance = jResp.StringOf("gig_data.distance");
var Payment_method = jResp.StringOf("gig_data.payment_method");
var Vehicle_type = jResp.StringOf("gig_data.vehicle_type");
var Merchant_type = jResp.StringOf("gig_data.merchant_type");
var Collected_at = jResp.StringOf("gig_data.collected_at");
var Bill_name = jResp.StringOf("credit_card_data.bill_name");
var i = 0;
var count_i = jResp.SizeOfArray("gig_data.breakdown");
while (i < count_i) {
jResp.I = i;
value = jResp.StringOf("gig_data.breakdown[i].value");
i = i+1;
}
}
chilkatExample();
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/transactions/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/transactions/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `transaction.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific transaction."
},
"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/transactions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
":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\"account\": {\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\"collected_at\": \"<date>\",\n\t\"value_date\": \"<string>\",\n\t\"accounting_date\": \"<date>\",\n\t\"amount\": \"<number>\",\n\t\"balance\": \"<number>\",\n\t\"currency\": \"<string>\",\n\t\"description\": \"<string>\",\n\t\"observations\": \"<string>\",\n\t\"category\": \"<string>\",\n\t\"reference\": \"<string>\",\n\t\"type\": \"eiusmod veniam ea sint\",\n\t\"status\": \"est nostrud\",\n\t\"gig_data\": {\n\t\t\"pickup_at\": \"<dateTime>\",\n\t\t\"dropoff_at\": \"<dateTime>\",\n\t\t\"request_at\": \"<dateTime>\",\n\t\t\"pickup_address\": \"<string>\",\n\t\t\"dropoff_address\": \"<string>\",\n\t\t\"pickup_latitude\": \"<number>\",\n\t\t\"pickup_longitude\": \"<number>\",\n\t\t\"dropoff_latitude\": \"<number>\",\n\t\t\"dropoff_longitude\": \"<number>\",\n\t\t\"distance\": \"<number>\",\n\t\t\"payment_method\": \"<string>\",\n\t\t\"vehicle_type\": \"<string>\",\n\t\t\"merchant_type\": \"<string>\",\n\t\t\"breakdown\": [\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t{\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\"collected_at\": \"<dateTime>\"\n\t},\n\t\"credit_card_data\": {\n\t\t\"bill_name\": \"<string>\"\n\t}\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/transactions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
":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/transactions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
":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]"
}
]
}
