Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "{{secretId}}"
CkHttp_put_Password $http "{{secretPassword}}"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://domain.com/api/transactions/:id/" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set id [CkJsonObject_stringOf $jResp "id"]
set Id [CkJsonObject_stringOf $jResp "account.id"]
set Value [CkJsonObject_stringOf $jResp "account.link.value"]
set InstitutionValue [CkJsonObject_stringOf $jResp "account.institution.value"]
set Collected_atValue [CkJsonObject_stringOf $jResp "account.collected_at.value"]
set CategoryValue [CkJsonObject_stringOf $jResp "account.category.value"]
set TypeValue [CkJsonObject_stringOf $jResp "account.type.value"]
set NameValue [CkJsonObject_stringOf $jResp "account.name.value"]
set NumberValue [CkJsonObject_stringOf $jResp "account.number.value"]
set BalanceValue [CkJsonObject_stringOf $jResp "account.balance.value"]
set CurrencyValue [CkJsonObject_stringOf $jResp "account.currency.value"]
set Bank_product_idValue [CkJsonObject_stringOf $jResp "account.bank_product_id.value"]
set Internal_identificationValue [CkJsonObject_stringOf $jResp "account.internal_identification.value"]
set Public_identification_nameValue [CkJsonObject_stringOf $jResp "account.public_identification_name.value"]
set Public_identification_valueValue [CkJsonObject_stringOf $jResp "account.public_identification_value.value"]
set Last_accessed_atValue [CkJsonObject_stringOf $jResp "account.last_accessed_at.value"]
set Credit_dataValue [CkJsonObject_stringOf $jResp "account.credit_data.value"]
set Loan_dataValue [CkJsonObject_stringOf $jResp "account.loan_data.value"]
set Funds_dataValue [CkJsonObject_stringOf $jResp "account.funds_data.value"]
set Gig_payment_dataValue [CkJsonObject_stringOf $jResp "account.gig_payment_data.value"]
set collected_at [CkJsonObject_stringOf $jResp "collected_at"]
set value_date [CkJsonObject_stringOf $jResp "value_date"]
set accounting_date [CkJsonObject_stringOf $jResp "accounting_date"]
set amount [CkJsonObject_stringOf $jResp "amount"]
set balance [CkJsonObject_stringOf $jResp "balance"]
set v_currency [CkJsonObject_stringOf $jResp "currency"]
set description [CkJsonObject_stringOf $jResp "description"]
set observations [CkJsonObject_stringOf $jResp "observations"]
set category [CkJsonObject_stringOf $jResp "category"]
set reference [CkJsonObject_stringOf $jResp "reference"]
set v_type [CkJsonObject_stringOf $jResp "type"]
set status [CkJsonObject_stringOf $jResp "status"]
set Pickup_at [CkJsonObject_stringOf $jResp "gig_data.pickup_at"]
set Dropoff_at [CkJsonObject_stringOf $jResp "gig_data.dropoff_at"]
set Request_at [CkJsonObject_stringOf $jResp "gig_data.request_at"]
set Pickup_address [CkJsonObject_stringOf $jResp "gig_data.pickup_address"]
set Dropoff_address [CkJsonObject_stringOf $jResp "gig_data.dropoff_address"]
set Pickup_latitude [CkJsonObject_stringOf $jResp "gig_data.pickup_latitude"]
set Pickup_longitude [CkJsonObject_stringOf $jResp "gig_data.pickup_longitude"]
set Dropoff_latitude [CkJsonObject_stringOf $jResp "gig_data.dropoff_latitude"]
set Dropoff_longitude [CkJsonObject_stringOf $jResp "gig_data.dropoff_longitude"]
set Distance [CkJsonObject_stringOf $jResp "gig_data.distance"]
set Payment_method [CkJsonObject_stringOf $jResp "gig_data.payment_method"]
set Vehicle_type [CkJsonObject_stringOf $jResp "gig_data.vehicle_type"]
set Merchant_type [CkJsonObject_stringOf $jResp "gig_data.merchant_type"]
set Collected_at [CkJsonObject_stringOf $jResp "gig_data.collected_at"]
set Bill_name [CkJsonObject_stringOf $jResp "credit_card_data.bill_name"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "gig_data.breakdown"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set value [CkJsonObject_stringOf $jResp "gig_data.breakdown[i].value"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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]"
}
]
}