Objective-C / GP-API Collection / TRA_10.0 CNP Recurring
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// 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",
// "initiator": "MERCHANT",
// "stored_credential": {
// "model": "RECURRING",
// "reason": "INCREMENTAL",
// "sequence": "SUBSEQUENT"
// },
// "payment_method": {
// "name": "Jane",
// "entry_mode": "ECOM",
// "id": "{{pmt_id}}",
// "card": {
// "brand_reference": "GET BRAND REFERENCE FROM INITIAL AUTH"
// }
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"account_name" value: @"{{acc_name}}"];
[json UpdateString: @"channel" value: @"CNP"];
[json UpdateString: @"capture_mode" value: @"AUTO"];
[json UpdateString: @"type" value: @"SALE"];
[json UpdateString: @"amount" value: @"100"];
[json UpdateString: @"currency" value: @"USD"];
[json UpdateString: @"reference" value: @"{{reference}}"];
[json UpdateString: @"country" value: @"US"];
[json UpdateString: @"initiator" value: @"MERCHANT"];
[json UpdateString: @"stored_credential.model" value: @"RECURRING"];
[json UpdateString: @"stored_credential.reason" value: @"INCREMENTAL"];
[json UpdateString: @"stored_credential.sequence" value: @"SUBSEQUENT"];
[json UpdateString: @"payment_method.name" value: @"Jane"];
[json UpdateString: @"payment_method.entry_mode" value: @"ECOM"];
[json UpdateString: @"payment_method.id" value: @"{{pmt_id}}"];
[json UpdateString: @"payment_method.card.brand_reference" value: @"GET BRAND REFERENCE FROM INITIAL AUTH"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"X-GP-Idempotency" value: @"12348"];
[http SetRequestHeader: @"X-GP-Version" value: @"{{version}}"];
// Adds the "Authorization: Bearer {{token}}" header.
http.AuthToken = @"{{token}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://{{url}}/ucp/transactions" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);
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",
"capture_mode": "AUTO",
"type": "SALE",
"amount": "100",
"currency": "USD",
"reference": "{{reference}}",
"country": "US",
"initiator": "MERCHANT",
"stored_credential": {
"model": "RECURRING",
"reason": "INCREMENTAL",
"sequence": "SUBSEQUENT"
},
"payment_method": {
"name": "Jane",
"entry_mode": "ECOM",
"id": "{{pmt_id}}",
"card": {
"brand_reference": "GET BRAND REFERENCE FROM INITIAL AUTH"
}
}
}'
https://{{url}}/ucp/transactions
Postman Collection Item JSON
{
"name": "TRA_10.0 CNP Recurring",
"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
}
],
"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 \"initiator\": \"MERCHANT\",\n \"stored_credential\": {\n \"model\": \"RECURRING\",\n \"reason\": \"INCREMENTAL\",\n \"sequence\": \"SUBSEQUENT\"\n },\n \"payment_method\": {\n \"name\": \"Jane\",\n \"entry_mode\": \"ECOM\",\n \"id\": \"{{pmt_id}}\",\n \"card\": {\n \"brand_reference\": \"GET BRAND REFERENCE FROM INITIAL AUTH\"\n }\n }\n}"
},
"url": {
"raw": "https://{{url}}/ucp/transactions",
"protocol": "https",
"host": [
"{{url}}"
],
"path": [
"ucp",
"transactions"
]
},
"description": "This request is for authorising a CNP ECOM transaction (Customer not present).\r\n\r\n- Funds can either be captured (taken) from customer automatically or else at a later stage. \"capture_mode\" in body of request 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 CNP AUTH request, visit here: https://developer.globalpay.com/api/transactions#/Create/post_transactions"
},
"response": [
]
}
