Ruby / GP-API Collection / TKA_2.5 CNP Tokenized Storage Model Version
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": "CNP",
# "capture_mode": "AUTO",
# "type": "SALE",
# "amount": "100",
# "currency": "USD",
# "reference": "{{reference}}",
# "country": "US",
# "payment_method": {
# "name": "Jane",
# "entry_mode": "ECOM",
# "card": {
# "number": "4242424242424242",
# "expiry_month": "09",
# "expiry_year": "22",
# "cvv": "940",
# "avs_address": "RD.asd'-' 17's Bogong",
# "avs_postal_code": "3699"
# },
# "storage_mode": "ALWAYS"
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("account_name","{{acc_name}}")
json.UpdateString("channel","CNP")
json.UpdateString("capture_mode","AUTO")
json.UpdateString("type","SALE")
json.UpdateString("amount","100")
json.UpdateString("currency","USD")
json.UpdateString("reference","{{reference}}")
json.UpdateString("country","US")
json.UpdateString("payment_method.name","Jane")
json.UpdateString("payment_method.entry_mode","ECOM")
json.UpdateString("payment_method.card.number","4242424242424242")
json.UpdateString("payment_method.card.expiry_month","09")
json.UpdateString("payment_method.card.expiry_year","22")
json.UpdateString("payment_method.card.cvv","940")
json.UpdateString("payment_method.card.avs_address","RD.asd'-' 17's Bogong")
json.UpdateString("payment_method.card.avs_postal_code","3699")
json.UpdateString("payment_method.storage_mode","ALWAYS")
http.SetRequestHeader("payment_method.storage_model","ALWAYS")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("X-GP-Idempotency","12348")
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}}"
-H "X-GP-Idempotency: 12348"
-H "payment_method.storage_model: ALWAYS"
-d '{
"account_name": "{{acc_name}}",
"channel": "CNP",
"capture_mode":"AUTO",
"type": "SALE",
"amount": "100",
"currency": "USD",
"reference": "{{reference}}",
"country": "US",
"payment_method": {
"name": "Jane",
"entry_mode": "ECOM",
"card": {
"number": "4242424242424242",
"expiry_month": "09",
"expiry_year": "22",
"cvv":"940",
"avs_address": "RD.asd\'-\' 17\'s Bogong",
"avs_postal_code": "3699"
},
"storage_mode": "ALWAYS"
}
}'
https://{{url}}/ucp/transactions
Postman Collection Item JSON
{
"name": "TKA_2.5 CNP Tokenized Storage Model Version",
"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(\"sale_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",
"type": "text",
"value": "{{version}}"
},
{
"key": "X-GP-Idempotency",
"type": "text",
"value": "12348",
"disabled": true
},
{
"key": "payment_method.storage_model",
"value": "ALWAYS",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_name\": \"{{acc_name}}\",\n \"channel\": \"CNP\",\n \"capture_mode\":\"AUTO\",\n \"type\": \"SALE\",\n \"amount\": \"100\",\n \"currency\": \"USD\",\n \"reference\": \"{{reference}}\",\n \"country\": \"US\",\n \"payment_method\": {\n \"name\": \"Jane\",\n \"entry_mode\": \"ECOM\",\n \"card\": {\n \"number\": \"4242424242424242\",\n \"expiry_month\": \"09\",\n \"expiry_year\": \"22\",\n \"cvv\":\"940\",\n \"avs_address\": \"RD.asd'-' 17's Bogong\",\n \"avs_postal_code\": \"3699\"\n },\n \"storage_mode\": \"ALWAYS\"\n }\n}"
},
"url": {
"raw": "https://{{url}}/ucp/transactions",
"protocol": "https",
"host": [
"{{url}}"
],
"path": [
"ucp",
"transactions"
],
"query": [
{
"key": "",
"value": "",
"disabled": true
}
]
},
"description": "This request tokenizes as part of a transaction. The field \"storage_model\" stores the card if the field is present and the merchant has a TKA account. This can be checked by seeing if TKA account is in access token response.\r\n\r\n- \"storage_model\" can be ALWAYS | ON_SUCCESS\r\n- ALWAYS= Always create a token even if card declines\r\n- ON_SUCCESS - Only tokenize card if authorized \r\n\r\nIf tokenized, a new field in \"payment_method\" called id is returned that contains the token \r\n\r\nFor more details on tokenization, please visit: https://developer.globalpay.com/api/payment-methods-tokenization#/Create/post_payment_methods"
},
"response": [
]
}
