Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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": "MANUAL",
* "card": {
* "number": "4242424242424242",
* "expiry_month": "09",
* "expiry_year": "22"
* }
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("account_name","{{acc_name}}")
loJson.UpdateString("channel","CP")
loJson.UpdateString("type","SALE")
loJson.UpdateString("capture_mode","AUTO")
loJson.UpdateString("amount","10000")
loJson.UpdateString("currency","USD")
loJson.UpdateString("reference","{{reference}}")
loJson.UpdateString("country","US")
loJson.UpdateString("payment_method.first_name","Jane")
loJson.UpdateString("payment_method.last_name","Doe")
loJson.UpdateString("payment_method.entry_mode","MANUAL")
loJson.UpdateString("payment_method.card.number","4242424242424242")
loJson.UpdateString("payment_method.card.expiry_month","09")
loJson.UpdateString("payment_method.card.expiry_year","22")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("X-GP-Version","{{version}}")
* Adds the "Authorization: Bearer {{token}}" header.
loHttp.AuthToken = "{{token}}"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://{{url}}/ucp/transactions","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp
RELEASE loHttp
RELEASE loJson
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": "MANUAL",
"card": {
"number": "4242424242424242",
"expiry_month": "09",
"expiry_year": "22"
}
}
}'
https://{{url}}/ucp/transactions
Postman Collection Item JSON
{
"name": "TRA_2.3 CP MANUAL",
"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\": \"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 is for authorising a CP Manual 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": [
]
}
