Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "{{secretId}}"
$oHttp.Password = "{{secretPassword}}"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/api/transactions/:id/",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sValue
Local $sId = $oJResp.StringOf("id")
Local $sId = $oJResp.StringOf("account.id")
Local $sValue = $oJResp.StringOf("account.link.value")
Local $sInstitutionValue = $oJResp.StringOf("account.institution.value")
Local $sCollected_atValue = $oJResp.StringOf("account.collected_at.value")
Local $sCategoryValue = $oJResp.StringOf("account.category.value")
Local $sTypeValue = $oJResp.StringOf("account.type.value")
Local $sNameValue = $oJResp.StringOf("account.name.value")
Local $sNumberValue = $oJResp.StringOf("account.number.value")
Local $sBalanceValue = $oJResp.StringOf("account.balance.value")
Local $sCurrencyValue = $oJResp.StringOf("account.currency.value")
Local $sBank_product_idValue = $oJResp.StringOf("account.bank_product_id.value")
Local $sInternal_identificationValue = $oJResp.StringOf("account.internal_identification.value")
Local $sPublic_identification_nameValue = $oJResp.StringOf("account.public_identification_name.value")
Local $sPublic_identification_valueValue = $oJResp.StringOf("account.public_identification_value.value")
Local $sLast_accessed_atValue = $oJResp.StringOf("account.last_accessed_at.value")
Local $sCredit_dataValue = $oJResp.StringOf("account.credit_data.value")
Local $sLoan_dataValue = $oJResp.StringOf("account.loan_data.value")
Local $sFunds_dataValue = $oJResp.StringOf("account.funds_data.value")
Local $sGig_payment_dataValue = $oJResp.StringOf("account.gig_payment_data.value")
Local $sCollected_at = $oJResp.StringOf("collected_at")
Local $sValue_date = $oJResp.StringOf("value_date")
Local $sAccounting_date = $oJResp.StringOf("accounting_date")
Local $sAmount = $oJResp.StringOf("amount")
Local $sBalance = $oJResp.StringOf("balance")
Local $sV_currency = $oJResp.StringOf("currency")
Local $sDescription = $oJResp.StringOf("description")
Local $sObservations = $oJResp.StringOf("observations")
Local $sCategory = $oJResp.StringOf("category")
Local $sReference = $oJResp.StringOf("reference")
Local $sV_type = $oJResp.StringOf("type")
Local $status = $oJResp.StringOf("status")
Local $sPickup_at = $oJResp.StringOf("gig_data.pickup_at")
Local $sDropoff_at = $oJResp.StringOf("gig_data.dropoff_at")
Local $sRequest_at = $oJResp.StringOf("gig_data.request_at")
Local $sPickup_address = $oJResp.StringOf("gig_data.pickup_address")
Local $sDropoff_address = $oJResp.StringOf("gig_data.dropoff_address")
Local $sPickup_latitude = $oJResp.StringOf("gig_data.pickup_latitude")
Local $sPickup_longitude = $oJResp.StringOf("gig_data.pickup_longitude")
Local $sDropoff_latitude = $oJResp.StringOf("gig_data.dropoff_latitude")
Local $sDropoff_longitude = $oJResp.StringOf("gig_data.dropoff_longitude")
Local $sDistance = $oJResp.StringOf("gig_data.distance")
Local $sPayment_method = $oJResp.StringOf("gig_data.payment_method")
Local $sVehicle_type = $oJResp.StringOf("gig_data.vehicle_type")
Local $sMerchant_type = $oJResp.StringOf("gig_data.merchant_type")
Local $sCollected_at = $oJResp.StringOf("gig_data.collected_at")
Local $sBill_name = $oJResp.StringOf("credit_card_data.bill_name")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("gig_data.breakdown")
While $i < $iCount_i
$oJResp.I = $i
$sValue = $oJResp.StringOf("gig_data.breakdown[i].value")
$i = $i + 1
Wend
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]"
}
]
}
