phpAx / GP-API Collection / TRA_7.0 APM Paypal Initiate
Back to Collection Items
<?php
// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("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": "CNP",
// "type": "SALE",
// "amount": "20045",
// "currency": "EUR",
// "reference": "{{reference}}",
// "country": "GB",
// "payment_method": {
// "name": "Doe",
// "entry_mode": "ECOM",
// "apm": {
// "provider": "paypal"
// }
// },
// "notifications": {
// "return_url": "REPLACE WITH YOUR OWN URL",
// "cancel_url": "REPLACE WITH YOUR OWN URL"
// }
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('account_name','{{acc_name}}');
$json->UpdateString('channel','CNP');
$json->UpdateString('type','SALE');
$json->UpdateString('amount','20045');
$json->UpdateString('currency','EUR');
$json->UpdateString('reference','{{reference}}');
$json->UpdateString('country','GB');
$json->UpdateString('payment_method.name','Doe');
$json->UpdateString('payment_method.entry_mode','ECOM');
$json->UpdateString('payment_method.apm.provider','paypal');
$json->UpdateString('notifications.return_url','REPLACE WITH YOUR OWN URL');
$json->UpdateString('notifications.cancel_url','REPLACE WITH YOUR OWN URL');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('X-GP-Version','{{version}}');
// Adds the "Authorization: Bearer {{token}}" header.
$http->AuthToken = '{{token}}';
$http->SetRequestHeader('idempotency-key','12345');
$http->SetRequestHeader('Accept','application/json');
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://{{url}}/ucp/transactions','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
print $resp->StatusCode . "\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 "idempotency-key: 12345"
-d '{
"account_name": "{{acc_name}}",
"channel": "CNP",
"type": "SALE",
"amount": "20045",
"currency": "EUR",
"reference": "{{reference}}",
"country": "GB",
"payment_method": {
"name": "Doe",
"entry_mode": "ECOM",
"apm": {
"provider": "paypal"
}
},
"notifications": {
"return_url": "REPLACE WITH YOUR OWN URL",
"cancel_url": "REPLACE WITH YOUR OWN URL"
}
}'
https://{{url}}/ucp/transactions
Postman Collection Item JSON
{
"name": "TRA_7.0 APM Paypal Initiate",
"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(\"reference\", jsonData.reference);\r",
"var redirect_url = jsonData.payment_method.apm.redirect_url; \r",
"\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",
"});\r",
"\r",
"pm.test(\"set html\",function(){\r",
" var template='<!DOCTYPE html> <html> <head> <title>Sample 3DSecure Page</title> </head> <body><form action='+redirect_url+' method=\"POST\"> <input type=\"submit\" value=\"Submit\"> </form> </body> </html>' // save your html in the template and then \r",
" pm.visualizer.set(template); // set that template to pm.visualizer\r",
"});\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": "idempotency-key",
"type": "text",
"value": "12345",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_name\": \"{{acc_name}}\",\n \"channel\": \"CNP\",\n \"type\": \"SALE\",\n \"amount\": \"20045\",\n \"currency\": \"EUR\",\n \"reference\": \"{{reference}}\",\n \"country\": \"GB\",\n \"payment_method\": {\n \"name\": \"Doe\",\n \"entry_mode\": \"ECOM\",\n \"apm\": {\n \"provider\": \"paypal\"\n }\n },\n \"notifications\": {\n \"return_url\": \"REPLACE WITH YOUR OWN URL\",\n \"cancel_url\": \"REPLACE WITH YOUR OWN URL\"\n }\n}"
},
"url": {
"raw": "https://{{url}}/ucp/transactions",
"protocol": "https",
"host": [
"{{url}}"
],
"path": [
"ucp",
"transactions"
]
},
"description": "This request initiates a paypal payment for a transaction. It will return the url that the merchant will need to redirect the customer to in order to log in to paypal and complete the purchase.\r\n\r\nFor more information on this request, please visit the following Dev Portal link: https://developer.globalpay.com/ecommerce/paypal#api"
},
"response": [
]
}
