PowerBuilder / GP-API Collection / TRA_2.4 CP Gratuity
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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": "CP",
// "type": "SALE",
// "capture_mode": "AUTO",
// "amount": "10000",
// "gratuity_amount": "100",
// "currency": "USD",
// "reference": "{{reference}}",
// "country": "US",
// "payment_method": {
// "first_name": "Jane",
// "last_name": "Doe",
// "entry_mode": "MANUAL",
// "card": {
// "number": "4242424242424242",
// "expiry_month": "09",
// "expiry_year": "22"
// }
// }
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("account_name","{{acc_name}}")
loo_Json.UpdateString("channel","CP")
loo_Json.UpdateString("type","SALE")
loo_Json.UpdateString("capture_mode","AUTO")
loo_Json.UpdateString("amount","10000")
loo_Json.UpdateString("gratuity_amount","100")
loo_Json.UpdateString("currency","USD")
loo_Json.UpdateString("reference","{{reference}}")
loo_Json.UpdateString("country","US")
loo_Json.UpdateString("payment_method.first_name","Jane")
loo_Json.UpdateString("payment_method.last_name","Doe")
loo_Json.UpdateString("payment_method.entry_mode","MANUAL")
loo_Json.UpdateString("payment_method.card.number","4242424242424242")
loo_Json.UpdateString("payment_method.card.expiry_month","09")
loo_Json.UpdateString("payment_method.card.expiry_year","22")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("X-GP-Version","{{version}}")
// Adds the "Authorization: Bearer {{token}}" header.
loo_Http.AuthToken = "{{token}}"
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.PostJson3("https://{{url}}/ucp/transactions","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp
destroy loo_Http
destroy loo_Json
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Authorization: Bearer {{token}}"
-H "Accept: application/json"
-H "X-GP-Version: {{version}}"
-d '{
"account_name": "{{acc_name}}",
"channel": "CP",
"type": "SALE",
"capture_mode": "AUTO",
"amount": "10000",
"gratuity_amount": "100",
"currency": "USD",
"reference": "{{reference}}",
"country": "US",
"payment_method": {
"first_name": "Jane",
"last_name": "Doe",
"entry_mode": "MANUAL",
"card": {
"number": "4242424242424242",
"expiry_month": "09",
"expiry_year": "22"
}
}
}'
https://{{url}}/ucp/transactions
Postman Collection Item JSON
{
"name": "TRA_2.4 CP Gratuity",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.environment.unset(\"trn_id\");\r",
"var jsonData = JSON.parse(responseBody);\r",
"postman.setEnvironmentVariable(\"trn_id\", jsonData.id);\r",
"postman.setEnvironmentVariable(\"batch_id\", jsonData.batch_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",
"type": "text",
"value": "{{version}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_name\": \"{{acc_name}}\",\n \"channel\": \"CP\",\n \"type\": \"SALE\",\n \"capture_mode\": \"AUTO\",\n \"amount\": \"10000\",\n \"gratuity_amount\": \"100\",\n \"currency\": \"USD\",\n \"reference\": \"{{reference}}\",\n \"country\": \"US\",\n \"payment_method\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"entry_mode\": \"MANUAL\",\n \"card\": {\n \"number\": \"4242424242424242\",\n \"expiry_month\": \"09\",\n \"expiry_year\": \"22\"\n }\n }\n}"
},
"url": {
"raw": "https://{{url}}/ucp/transactions",
"protocol": "https",
"host": [
"{{url}}"
],
"path": [
"ucp",
"transactions"
]
},
"description": "This request allows the merchant to specify what part of the original transaction amount is gratuity e.g For a $50 transaction, $5 of this transaction amount is gratuity. Insert gratuity amount in the gratuity_amount field in the body of the request."
},
"response": [
]
}
