Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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",
# "currency": "USD",
# "reference": "{{reference}}",
# "country": "US",
# "payment_method": {
# "first_name": "Jane",
# "last_name": "Doe",
# "entry_mode": "SWIPE",
# "card": {
# "number": "",
# "track": "%B4012002000060016^VI TEST CREDIT^251210118039000000000396?;4012002000060016=25121011803939600000?"
# }
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("account_name","{{acc_name}}")
json.UpdateString("channel","CP")
json.UpdateString("type","SALE")
json.UpdateString("capture_mode","AUTO")
json.UpdateString("amount","10000")
json.UpdateString("currency","USD")
json.UpdateString("reference","{{reference}}")
json.UpdateString("country","US")
json.UpdateString("payment_method.first_name","Jane")
json.UpdateString("payment_method.last_name","Doe")
json.UpdateString("payment_method.entry_mode","SWIPE")
json.UpdateString("payment_method.card.number","")
json.UpdateString("payment_method.card.track","%B4012002000060016^VI TEST CREDIT^251210118039000000000396?;4012002000060016=25121011803939600000?")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("X-GP-Version","{{version}}")
# Adds the "Authorization: Bearer {{token}}" header.
http.put_AuthToken("{{token}}")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://{{url}}/ucp/transactions","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";
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",
"currency": "USD",
"reference": "{{reference}}",
"country": "US",
"payment_method": {
"first_name": "Jane",
"last_name": "Doe",
"entry_mode": "SWIPE",
"card": {
"number": "",
"track": "%B4012002000060016^VI TEST CREDIT^251210118039000000000396?;4012002000060016=25121011803939600000?"
}
}
}'
https://{{url}}/ucp/transactions
Postman Collection Item JSON
{
"name": "TRA_2.2 CP SWIPE",
"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(\"sale_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 \"currency\": \"USD\",\n \"reference\": \"{{reference}}\",\n \"country\": \"US\",\n \"payment_method\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"entry_mode\": \"SWIPE\",\n \"card\": {\n \"number\": \"\",\n \"track\": \"%B4012002000060016^VI TEST CREDIT^251210118039000000000396?;4012002000060016=25121011803939600000?\"\n }\n }\n}"
},
"url": {
"raw": "https://{{url}}/ucp/transactions",
"protocol": "https",
"host": [
"{{url}}"
],
"path": [
"ucp",
"transactions"
]
},
"description": "This request is for authorising a CP Swipe transaction (Customer present eg. in shop at terminal).\r\n\r\n- Funds can either be captured (taken) from customer automatically or else at a later stage. \"capture_mode\" is where you can edit the capture status. \r\n - \"LATER\" = funds will be taken from customer at a later stage. A Successful response should return a transaction id (TRN_....) and should indicate that transaction status is 'preauthorized'.\r\n A 'Complete Capture' request is required to complete transaction.\r\n - \"AUTO\" = funds will be taken from the customer automatically. A Successful response should return a transaction id (TRN_....) and should indicate that transaction status is 'captured'. \r\n No additional request is necessary.\r\n\r\n- Account name is which account of the api you want to send the request to, so in this case it is Transactions. Other accounts available include Disputes, Settlements and Tokenizations.\r\n- Amount is the amount of money being charged to the customers card. How the amount is written is that \"100\" equates to $1.00, not $100.\r\n- Payment Method is how the customer has paid for the transaction. Here we see if it was ECOM (website), MOTO (over the phone) and their card details.\r\n- Reference is a specific unique reference for each transaction given by the merchant. This could be an order number or an invoice number etc.\r\n\r\nFor more details on a CP AUTH request, visit: https://developer.globalpay.com/api/transactions#/Create/post_transactions"
},
"response": [
]
}
