Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "account_name": "{{acc_name}}",
; "channel": "CNP",
; "type": "REFUND",
; "amount": "12345",
; "currency": "USD",
; "reference": "{{reference}}",
; "country": "US",
; "payment_method": {
; "name": "ANGELA SMITH",
; "entry_mode": "ECOM",
; "bank_transfer": {
; "number": "1234567890",
; "number_type": "SAVING",
; "check_reference": "123",
; "sec_code": "WEB",
; "merchant_notes": "123",
; "bank": {
; "code": "083908420",
; "name": "First Union",
; "address": {
; "line_1": "12000 Smoketown Rd",
; "line_2": "Apt 3B",
; "line_3": "X",
; "city": "Mesa",
; "state": "AZ",
; "postal_code": "22192",
; "country": "USA"
; }
; }
; }
; },
; "payer": {
; "name": "ANGELA SMITH",
; "reference": "123",
; "date_of_birth": "1967-08-13",
; "landline_phone": "235555",
; "mobile_phone": "222222",
; "billing_address": {
; "line_1": "Address Line 1",
; "line_2": "Address Line 2",
; "city": "PUNE",
; "state": "AZ",
; "postal_code": "411015",
; "country": "USA"
; }
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"account_name","{{acc_name}}")
CkJsonObject::ckUpdateString(json,"channel","CNP")
CkJsonObject::ckUpdateString(json,"type","REFUND")
CkJsonObject::ckUpdateString(json,"amount","12345")
CkJsonObject::ckUpdateString(json,"currency","USD")
CkJsonObject::ckUpdateString(json,"reference","{{reference}}")
CkJsonObject::ckUpdateString(json,"country","US")
CkJsonObject::ckUpdateString(json,"payment_method.name","ANGELA SMITH")
CkJsonObject::ckUpdateString(json,"payment_method.entry_mode","ECOM")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.number","1234567890")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.number_type","SAVING")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.check_reference","123")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.sec_code","WEB")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.merchant_notes","123")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.bank.code","083908420")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.bank.name","First Union")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.bank.address.line_1","12000 Smoketown Rd")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.bank.address.line_2","Apt 3B")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.bank.address.line_3","X")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.bank.address.city","Mesa")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.bank.address.state","AZ")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.bank.address.postal_code","22192")
CkJsonObject::ckUpdateString(json,"payment_method.bank_transfer.bank.address.country","USA")
CkJsonObject::ckUpdateString(json,"payer.name","ANGELA SMITH")
CkJsonObject::ckUpdateString(json,"payer.reference","123")
CkJsonObject::ckUpdateString(json,"payer.date_of_birth","1967-08-13")
CkJsonObject::ckUpdateString(json,"payer.landline_phone","235555")
CkJsonObject::ckUpdateString(json,"payer.mobile_phone","222222")
CkJsonObject::ckUpdateString(json,"payer.billing_address.line_1","Address Line 1")
CkJsonObject::ckUpdateString(json,"payer.billing_address.line_2","Address Line 2")
CkJsonObject::ckUpdateString(json,"payer.billing_address.city","PUNE")
CkJsonObject::ckUpdateString(json,"payer.billing_address.state","AZ")
CkJsonObject::ckUpdateString(json,"payer.billing_address.postal_code","411015")
CkJsonObject::ckUpdateString(json,"payer.billing_address.country","USA")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"X-GP-Idempotency","12348")
CkHttp::ckSetRequestHeader(http,"X-GP-Version","{{version}}")
; Adds the "Authorization: Bearer {{token}}" header.
CkHttp::setCkAuthToken(http, "{{token}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://{{url}}/ucp/transactions","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Authorization: Bearer {{token}}"
-H "Accept: application/json"
-H "X-GP-Version: {{version}}"
-H "X-GP-Idempotency: 12348"
-d '{
"account_name": "{{acc_name}}",
"channel": "CNP",
"type": "REFUND",
"amount": "12345",
"currency": "USD",
"reference": "{{reference}}",
"country": "US",
"payment_method": {
"name": "ANGELA SMITH",
"entry_mode": "ECOM",
"bank_transfer": {
"number": "1234567890",
"number_type": "SAVING",
"check_reference": "123",
"sec_code": "WEB",
"merchant_notes": "123",
"bank": {
"code": "083908420",
"name": "First Union",
"address": {
"line_1": "12000 Smoketown Rd",
"line_2": "Apt 3B",
"line_3": "X",
"city": "Mesa",
"state": "AZ",
"postal_code": "22192",
"country": "USA"
}
}
}
},
"payer": {
"name": "ANGELA SMITH",
"reference": "123",
"date_of_birth": "1967-08-13",
"landline_phone": "235555",
"mobile_phone": "222222",
"billing_address": {
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"city": "PUNE",
"state": "AZ",
"postal_code": "411015",
"country": "USA"
}
}
}'
https://{{url}}/ucp/transactions
Postman Collection Item JSON
{
"name": "TRA_11.2 ACH Refund",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.environment.unset(\"trn_id\");\r",
"\r",
"var jsonData = JSON.parse(responseBody);\r",
"postman.setEnvironmentVariable(\"trn_id\", jsonData.id);\r",
"postman.setEnvironmentVariable(\"reference\", jsonData.reference);\r",
"postman.setEnvironmentVariable(\"batch_id\", jsonData.batch_id);\r",
"postman.setEnvironmentVariable(\"act_id\", jsonData.action.id);\r",
"\r",
"tests[\"Transaction ID \" + pm.environment.get(\"trn_id\")] = true;\r",
"\r",
"tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \r",
"\r",
"\r",
"pm.test(\"Successful POST request\", function () {\r",
" pm.expect(pm.response.code).to.be.oneOf([200,201,202]);\r",
"});\r",
"\r",
"pm.test(\"Status code name has string\", function () {\r",
" pm.response.to.have.status(\"OK\");\r",
"});"
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var str = String(\"00000000\"+ Math.floor(Math.random()*100000000) + 1).slice(-8);",
"",
"pm.environment.set(\"reference\",str);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{token}}"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-GP-Version",
"value": "{{version}}",
"type": "text"
},
{
"key": "X-GP-Idempotency",
"value": "12348",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_name\": \"{{acc_name}}\",\n \"channel\": \"CNP\",\n \"type\": \"REFUND\",\n \"amount\": \"12345\",\n \"currency\": \"USD\",\n \"reference\": \"{{reference}}\",\n \"country\": \"US\",\n \"payment_method\": {\n \"name\": \"ANGELA SMITH\",\n \"entry_mode\": \"ECOM\",\n \"bank_transfer\": {\n \"number\": \"1234567890\",\n \"number_type\": \"SAVING\",\n \"check_reference\": \"123\",\n \"sec_code\": \"WEB\",\n \"merchant_notes\": \"123\",\n \"bank\": {\n \"code\": \"083908420\",\n \"name\": \"First Union\",\n \"address\": {\n \"line_1\": \"12000 Smoketown Rd\",\n \"line_2\": \"Apt 3B\",\n \"line_3\": \"X\",\n \"city\": \"Mesa\",\n \"state\": \"AZ\",\n \"postal_code\": \"22192\",\n \"country\": \"USA\"\n }\n }\n }\n },\n \"payer\": {\n \"name\": \"ANGELA SMITH\",\n \"reference\": \"123\",\n \"date_of_birth\": \"1967-08-13\",\n \"landline_phone\": \"235555\",\n \"mobile_phone\": \"222222\",\n \"billing_address\": {\n \"line_1\": \"Address Line 1\",\n \"line_2\": \"Address Line 2\",\n \"city\": \"PUNE\",\n \"state\": \"AZ\",\n \"postal_code\": \"411015\",\n \"country\": \"USA\"\n }\n }\n}\n"
},
"url": {
"raw": "https://{{url}}/ucp/transactions",
"protocol": "https",
"host": [
"{{url}}"
],
"path": [
"ucp",
"transactions"
]
}
},
"response": [
]
}
