Request Example (POST)

$url="https://secure.staging.paypipes.net/api/v1/tokenize/customers";

$param = [
"request" => [
  "api_id" => "449f11a438853bb84bd7193fd6bceb0886d083d0a8d5e583a7f92fc55573854d",
  "order_id" => "123456789123",
  "ip_address" => "123.123.123.1",
  "reference_id" => "123456789", //optional
  "curfex_id" => "123456789", //optional
  "customer" => [
      "first_name"=> "Paul",
      "last_name"=> "King",
      "street"=> "761 Kelly Forge",
      "city"=> "Martinstad",
      "state"=> "New Karliebury",
      "country"=> "AT",
      "post_code"=> "SN2 7TE",
      "phone_code"=> "+43",
      "phone"=> "0306587799",
      "email"=> "k.paul@example.com"
  ],
  "card"=>[
      "holder" => "Test Card",
      "number"=> "4012000300001003 ",
      "exp_month"=> "01",
      "exp_year"=> "2019"
  ]
]
];

$ch2 = curl_init();
curl_setopt($ch2, CURLOPT_URL, $url);
curl_setopt($ch2, CURLOPT_TIMEOUT, 30);
curl_setopt($ch2, CURLOPT_POST, true);
curl_setopt($ch2, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
$ch2,
CURLOPT_HTTPHEADER,
[
  "Content-type: application/json",
  "Accept: application/json",
  "Cache-Control: no-cache",
  "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
  "Authorization: Bearer ". $auth->access_token
]
);
$response2 = curl_exec($ch2);
curl_close($ch2);

var_dump(json_decode($response2));

Request Example (PATCH)

$url="https://secure.staging.paypipes.net/api/v1/tokenize/customers/10cd5c0a-0832-4de1-9091-bb5199b439f1";

$param = [
"request" => [
  "api_id" => "449f11a438853bb84bd7193fd6bceb0886d083d0a8d5e583a7f92fc55573854d",
  "order_id" => "123456789123",
  "ip_address" => "123.123.123.1",
  "reference_id" => "123456789", //optional
  "curfex_id" => "123456789", //optional
  "customer" => [
      "first_name"=> "Paul",
      "last_name"=> "King",
      "street"=> "761 Kelly Forge",
      "city"=> "Martinstad",
      "state"=> "New Karliebury",
      "country"=> "AT",
      "post_code"=> "SN2 7TE",
      "phone_code"=> "+43",
      "phone"=> "0306587799",
      "email"=> "k.paul@example.com"
  ]
]
];

$ch2 = curl_init();
curl_setopt($ch2, CURLOPT_URL, $url);
curl_setopt($ch2, CURLOPT_TIMEOUT, 30);
curl_setopt($ch2, CURLOPT_POST, true);
curl_setopt($ch2, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
$ch2,
CURLOPT_HTTPHEADER,
[
  "Content-type: application/json",
  "Accept: application/json",
  "Cache-Control: no-cache",
  "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
  "Authorization: Bearer ". $auth->access_token
]
);
$response2 = curl_exec($ch2);
curl_close($ch2);

var_dump(json_decode($response2));

Response Example (200 OK)

{"data":{"customer_token":"c3139eaf-ceaa-4de5-a76d-c9eb6286df45","order_id":"123456789123","first_name":"Paul","last_name":"King","street":"761 Kelly Forge","city":"Martinstad","state":"New Karliebury","post_code":"SN27TE","country":"Austria","phone_code":"+43","phone":"0306587799","email":"k.paul@example.com","reference_id": "123456789","curfex_id":"123456789","status":"Active","created":"2018-04-23 10:10:40","updated":"2018-04-23 10:10:40","expired":"2021-04-23 10:10:40","cards":{"data":[{"card_token":"2A586F3A652F80A58C99A87B1003","holder":"Test Card","bin":"401200","digit":"1003","brand":"visa","created":"2018-04-23 10:10:40","updated":"2018-04-23 10:10:40","expired":"2019-01-23 10:10:40"}]}‌}}

Response Example (Validation)

{"error":{"phone_code":["The phone code field is required."]},"code":"422"}

{"error":"Invalid Order Id","code":"422"}

Request Example (POST)

$url="https://secure.staging.paypipes.net/api/v1/tokenize/customers/34490389-d609-46f7-9c29-f0bbd396b968/cards";
            $param = [
                "request" => [
                    "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
                    "order_id" => "123456789123",
                    "ip_address" => "123.123.123.1",
                    "holder" => "Test Card",
                    "number"=> "4012000300001003 ",
                    "exp_month"=> "01",
                    "exp_year"=> "2023"
                    ]
                ]
            ];

            $ch2 = curl_init();
            curl_setopt($ch2, CURLOPT_URL, $url);
            curl_setopt($ch2, CURLOPT_TIMEOUT, 30);
            curl_setopt($ch2, CURLOPT_POST, true);
            curl_setopt($ch2, CURLOPT_POSTFIELDS, json_encode($param));
            curl_setopt(
                $ch2,
                CURLOPT_HTTPHEADER,
                [
                    "Content-type: application/json",
                    "Accept: application/json",
                    "Cache-Control: no-cache",
                    "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
                    "Authorization: Bearer ". $auth->access_token
                ]
            );
            $response2 = curl_exec($ch2);
            curl_close($ch2);

            var_dump(json_decode($response2));
            

Request Example (PATCH)

$url="https://secure.staging.paypipes.net/api/v1/tokenize/customers/34490389-d609-46f7-9c29-f0bbd396b968/cards/073FCFCECFDD7468F83B60901003";
            $param = [
                "request" => [
                    "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
                    "order_id" => "123456789123",
                    "ip_address" => "123.123.123.1",
                    "holder" => "Test Card Update",
                    "exp_month"=> "01",
                    "exp_year"=> "2023"
                    ]
                ]
            ];

            $ch2 = curl_init();
            curl_setopt($ch2, CURLOPT_URL, $url);
            curl_setopt($ch2, CURLOPT_TIMEOUT, 30);
            curl_setopt($ch2, CURLOPT_POST, true);
            curl_setopt($ch2, CURLOPT_CUSTOMREQUEST, 'PATCH');
            curl_setopt($ch2, CURLOPT_POSTFIELDS, json_encode($param));
            curl_setopt(
                $ch2,
                CURLOPT_HTTPHEADER,
                [
                    "Content-type: application/json",
                    "Accept: application/json",
                    "Cache-Control: no-cache",
                    "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
                    "Authorization: Bearer ". $auth->access_token
                ]
            );
            $response2 = curl_exec($ch2);
            curl_close($ch2);

            var_dump(json_decode($response2));
            

PCI Response Example (200 OK)

              {"data":{"card_token":"2A586F3A652F80A58C99A87B1003","holder":"Test Card","bin":"401200","digit":"1003","brand":"visa","created":"2018-04-23 10:10:40","updated":"2018-04-23 10:10:40","expired":"2019-01-23 10:10:40"}}
            

PCI Response Example (Validation)

{"error":{"holder":["The holder field is required."]},"code":"422"}

            {"error":"Invalid Order Id","code":"422"}
            

NON PCI Response Example (200 OK)

              {"data":{"redirect_url":"https://secure.staging.paypipes.net/v1/tokenize/cards/redirect/34490389-d609-46f7-9c29-f0bbd396b968"}}
            

NON PCI Response Example (Validation)

{"error":"Invalid Order Id","code":"422"}
            

NON-PCI Response Example (200 OK)

              {"code":"201","status":"success","card_token":"2A586F3A652F80A58C99A87B1003"}
            

NON-PCI Response Example

{"code":"422","status":"fail","card_token":"Record not found"}
            

Request Example

$url="https://secure.staging.paypipes.net/api/v1/authorize";

$param = [
    "request" => [
        "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
        "order_id" => "660217c4fb6cd1efe16e0f8b",
        "ip_address" => "123.123.123.1",
        "card_token"=> "62BD76A3E29725481C076A1B1003",
        //"customer_token"=> "1540e474-39c6-491a-b872-48453930ea3a",  //either card_token or customer_token can be used
        "amount"=> "1.00",
        "currency"=> "EUR",
        "description"=> "Test Purchase",
        "gateway"=> "unlimint",
        "callback_url" => "https://localhost/callback",
        "return_url"=> "https://localhost/return",
        //"security_code"=> "123" // security_code is dependency with card_token and SAQ-D sign
    ]
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
    "data": {
        "order_id": "660217c4fb6cd1efe16e0f8b",
        "transaction_id": "4ad78bba-635b-4ad6-a74c-de7126a7341b",
        "transaction_type": "Authorize",
        "amount": "1.00",
        "currency": "EUR",
        "status": "Approved",
        "status_code": "201.0000",
        "status_description": "3d-acquirer:The resource was successfully created.",
        "created": "2018-04-23 10:35:43",
        "card_token": "4BB998B580AEE2036C397F8C1003",
        "description": "test purchase",
        "gateway": "unlimint",
        "mask_number": "4012 00XX XXXX 1003"
    }
}

Response Example (Validation)

{"error":{"currency":["The currency field is required."]},"code":"422"}

{"error":"Invalid Order Id","code":"422"}

Request Example

$url="https://secure.staging.paypipes.net/api/v1/capture";

$param = [
    "request" => [
        "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
        "order_id" => "a35436ba5641c035e9b5af38",
        "transaction_id" => "4ad78bba-635b-4ad6-a74c-de7126a7341b",
        "description" => "Capture Request",
        "ip_address" => "123.123.123.1",
        "callback_url" => "https://localhost/callback",
    ]
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
    "data": {
        "order_id": "a35436ba5641c035e9b5af38",
        "transaction_id": "5bb872f3-c9b1-47ea-807d-a1a8643dc171",
        "transaction_type": "Capture",
        "amount": "57.82",
        "currency": "EUR",
        "status": "Approved",
        "status_code": "201.0000",
        "status_description": "3d-acquirer:The resource was successfully created.",
        "created": "2018-04-23 10:57:55",
        "card_token": "4BB998B580AEE2036C397F8C1003",
        "description": "test purchase",
        "gateway": "unlimint",
        "mask_number": "4012 00XX XXXX 1003"
    }
}

Response Example (Validation)

{"error":{"transaction_id":["The transaction_id field is required."]},"code":"422"}

{"error":"This transaction already requested","code":"422"}

Request Example

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
     "request" => [
        "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57023",
        "ip_address" => "123.123.123.1",
        "card_token"=> "62BD76A3E29725481C076A1B1003",
        //"customer_token"=> "1540e474-39c6-491a-b872-48453930ea3a",  //either card_token or customer_token can be used
        "amount"=> "14.92",
        "currency"=> "EUR",
        "description"=> "Test Purchase",
        "gateway"=> "unlimint",
        "return_url"=> "https://localhost/return",
        "callback_url"=>"https://localhost/callback",
        "card"=> true,
        //"security_code"=> "123" // security_code is dependency with card_token and SAQ-D sign
        "extra_param"=> [];
    ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Request Example (ThunderXpay)

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
    "request" => [
        "api_id" => "3031022drc61c64a74f8fcece40a648c17a73379ccc373095acb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57023",
        "ip_address" => "123.123.123.1",
        "customer_token"=> "1540e474-39c6-491a-b872-48453930ea3a",
        "amount"=> "14.92",
        "currency"=> "USD",
        "description"=> "Test Purchase",
        "gateway"=> "thunderxpay",
        "return_url"=> "https://localhost/return",
        "callback_url"=>"https://localhost/callback",
        "extra_param"=> [
          "bank"=>  [
            "bank_code" => "BAY"
            "bank_name" => "Bank of Ayudhya (Krungsri)"
            "account_currency" => "THB"
            "account_number" => "111111111111"
            "trade_number" => "23232323"
            "id_number" => "33333333333333"
          ]
        ]
    ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Request Example (ZotaPay)

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
    "request" => [
        "api_id" => "3031022drc61c64a74f8fcece40a648c17a73379ccc373095acb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57023",
        "ip_address" => "123.123.123.1",
        "customer_token"=> "1540e474-39c6-491a-b872-48434930ea3a",
        "amount"=> "14.92",
        "currency"=> "THB",
        "description"=> "Test Purchase",
        "gateway"=> "zotapay",
        "return_url"=> "https://localhost/return",
        "callback_url"=>"https://localhost/callback",
        "extra_param" => ["endpoint" => "503968"]
    ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Request Example (MaxConnect)

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
    "request" => [
        "api_id" => "3031022drc61c64a74f8fcece40a648c17a73379ccc373095acb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57023",
        "ip_address" => "123.123.123.1",
        "customer_token"=> "1540e474-39c6-491a-b872-48434930ea3a",
        "amount"=> "5000.00",
        "currency"=> "JPY",
        "description"=> "Test Purchase",
        "gateway"=> "maxconnect",
        "return_url"=> "https://localhost/return",
        "callback_url"=>"https://localhost/callback"

    ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Request Example (Curfex)

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
"request" => [
    "api_id" => "3031022drc61c64a74f8fcece40a648c17a73379ccc373095acb617fb163a81e",
    "order_id" => "8c5ca6d32567f89034c57023",
    "ip_address" => "123.123.123.1",
    "customer_token"=> "1540e474-39c6-491a-b872-48434930ea3a",
    "amount"=> "5000.00",
    "currency"=> "JPY",
    "description"=> "Test Purchase",
    "gateway"=> "curfex",
    "return_url"=> "https://localhost/return",
    "callback_url"=>"https://localhost/callback"
]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
$ch,
CURLOPT_HTTPHEADER,
[
    "Content-type: application/json",
    "Accept: application/json",
    "Cache-Control: no-cache",
    "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
    "Authorization: Bearer ". $auth->access_token
]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
    "data": {
        "order_id": "8c5ca6d32567f89034c57023",
        "transaction_id": "47adb6a1-ace6-469e-8ffc-25416fb5e7a0",
        "transaction_type": "Purchase",
        "amount": "14.92",
        "currency": "EUR",
        "status": "Approved",
        "status_code": "201.0000",
        "status_description": "3d-acquirer:The resource was successfully created.",
        "created": "2018-04-23 10:39:38",
        "card_token": "4BB998B580AEE2036C397F8C1003",
        "description": "test purchase",
        "gateway": "unlimint",
        "mask_number": "4012 00XX XXXX 1003"
    }
}

Response Example (Validation)

{"error":{"currency":["The currency field is required."]},"code":"422"}

{"error":"Invalid Order Id","code":"422"}

Request Example (Redirect)

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
"request" => [
    "api_id" => "3031022drc61c64a74f8fcece40a648c17a73379ccc373095acb617fb163a81e",
    "order_id" => "8c5ca6d32567f89034c57023",
    "ip_address" => "123.123.123.1",
    "customer_token"=> "1540e474-39c6-491a-b872-48434930ea3a",
    "amount"=> "5000.00",
    "currency"=> "JPY",
    "description"=> "Test Purchase",
    "gateway"=> "curfex",
    "rest"=> 1,
    "return_url"=> "https://localhost/return",
    "callback_url"=>"https://localhost/callback"
]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
$ch,
CURLOPT_HTTPHEADER,
[
    "Content-type: application/json",
    "Accept: application/json",
    "Cache-Control: no-cache",
    "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
    "Authorization: Bearer ". $auth->access_token
]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Redirect Response Example (200 OK)

{
      "redirect_url": "https://secure.staging.paypipes.net/v1/redirect/4b0836b9-32df-4904-afe3-02ac8704d743",
      "expires_at": "2021-10-14 10:22:05",
      "code": "200"
}

Open to App Redirect example (origin=ios)

https://secure.staging.paypipes.net/backtoapp?_token=hW0tWJ3afnYDYNskZf1lP7eUslTeP5qPcNvWSDeg&order_id=20230125091954&transaction_id=23bd5df4-3e2f-4e85-9488-6130d9a07040&status=Cancelled&status_code=503&language=en

Apple app site association (origin=ios)

https://secure.staging.paypipes.net.well-known/apple-app-site-association

Request Example

$url="https://secure.staging.paypipes.net/api/v1/reverse/authorize";

$param = [
    "request" => [
        "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c5702",
        "transaction_id" => "4ad78bba-635b-4ad6-a74c-de7126a7341b",
        "description" => "Reverse Request",
        "ip_address" => "123.123.123.1",
        "callback_url" => "https://localhost/callback",
    ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
    "data": {
        "order_id": "8c5ca6d32567f89034c5702",
        "transaction_id": "47adb6a1-ace6-469e-8ffc-25416fb5e7a0",
        "transaction_type": "ReverseAuthorize",
        "amount": "14.92",
        "currency": "EUR",
        "status": "Approved",
        "status_code": "201.0000",
        "status_description": "3d-acquirer:The resource was successfully created.",
        "created": "2018-04-23 10:39:38",
        "card_token": "4BB998B580AEE2036C397F8C1003",
        "description": "test reverse",
        "gateway": "unlimint",
        "mask_number": "4012 00XX XXXX 1003"
    }
}

Response Example (Validation)

{"error":{"transaction_id":["The transaction_id field is required."]},"code":"422"}

{"error":"Invalid Order Id","code":"422"}

Request Example

$url="https://secure.staging.paypipes.net/api/v1/reverse/capture";

$param = [
    "request" => [
        "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57029",
        "transaction_id" => "4ad78bba-635b-4ad6-a74c-de7126a7341b",
        "description" => "Reverse Request",
        "ip_address" => "123.123.123.1",
        "callback_url" => "https://localhost/callback",
    ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
    "data": {
        "order_id": "8c5ca6d32567f89034c57029",
        "transaction_id": "47adb6a1-ace6-469e-8ffc-25416fb5e7a0",
        "transaction_type": "ReverseCapture",
        "amount": "14.92",
        "currency": "EUR",
        "status": "Approved",
        "status_code": "201.0000",
        "status_description": "3d-acquirer:The resource was successfully created.",
        "created": "2018-04-23 10:39:38",
        "card_token": "4BB998B580AEE2036C397F8C1003",
        "description": "test reverse",
        "gateway": "unlimint",
        "mask_number": "4012 00XX XXXX 1003"
    }
}

Response Example (Validation)

{"error":{"phone_code":["The phone code field is required."]},"code":"422"}

{"error":"Invalid Order Id","code":"422"}

Request Example

$url="https://secure.staging.paypipes.net/api/v1/reverse/purchase";

$param = [
    "request" => [
        "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57028",
        "transaction_id" => "1652757c-4a98-4f90-8fce-d19cebb3fd5f",
        "description" => "Reverse Request",
        "ip_address" => "123.123.123.1",
        "callback_url" => "https://localhost/callback",
    ]
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
    "data": {
        "order_id": "8c5ca6d32567f89034c57028",
        "transaction_id": "47adb6a1-ace6-469e-8ffc-25416fb5e7a0",
        "transaction_type": "ReversePurchase",
        "amount": "14.92",
        "currency": "EUR",
        "status": "Approved",
        "status_code": "201.0000",
        "status_description": "3d-acquirer:The resource was successfully created.",
        "created": "2018-04-23 10:39:38",
        "card_token": "4BB998B580AEE2036C397F8C1003",
        "description": "test reverse",
        "gateway": "unlimint",
        "mask_number": "4012 00XX XXXX 1003"
    }
}

Response Example (Validation)

{"error":{"phone_code":["The phone code field is required."]},"code":"422"}

{"error":"Invalid Order Id","code":"422"}

Request Example

$url="https://secure.staging.paypipes.net/api/v1/refund";

$param = [
    "request" => [
        "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57027",
        "transaction_id" => "1652757c-4a98-4f90-8fce-d19cebb3fd5f",
        "amount" => "10.00",
        "description" => "Reverse Request",
        "ip_address" => "123.123.123.1",
        "callback_url" => "https://localhost/callback",
    ]
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
    "data": {
        "order_id": "8c5ca6d32567f89034c57027",
        "transaction_id": "47adb6a1-ace6-469e-8ffc-25416fb5e7a0",
        "transaction_type": "Refund",
        "amount": "14.92",
        "currency": "EUR",
        "status": "Approved",
        "status_code": "201.0000",
        "status_description": "3d-acquirer:The resource was successfully created.",
        "created": "2018-04-23 10:39:38",
        "card_token": "4BB998B580AEE2036C397F8C1003",
        "description": "test refund",
        "gateway": "unlimint",
        "mask_number": "4012 00XX XXXX 1003"
    }
}

Response Example (Validation)

{"error":{"phone_code":["The phone code field is required."]},"code":"422"}

{"error":"Invalid Order Id","code":"422"}

Request Example

$url="https://secure.staging.paypipes.net/api/v1/credit";

$param = [
    "request" => [
        "api_id" => "3031022dfc91b64a73f8fcece40a648c17a73379ccc373095abb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57025",
        "transaction_id" => "66cb692d-2282-4a92-a641-ff537ae08341",
        "amount"=> "14.92",
        "description"=> "Original Credit",
        "ip_address" => "123.123.123.1"
        "callback_url" => "https://localhost/callback",
    ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Request Example (ThunderXpay)

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
    "request" => [
        "api_id" => "3031022drc61c64a74f8fcece40a648c17a73379ccc373095acb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57023",
        "ip_address" => "123.123.123.1",
        "customer_token"=> "1540e474-39c6-491a-b872-48434930ea3a",
        "amount"=> "14.92",
        "currency"=> "THB",
        "description"=> "Test Purchase",
        "gateway"=> "thunderxpay",
        "callback_url" => "https://localhost/callback",
        "extra_param" => [
                            "bank" => [
                                "bank_account" => "1234567890",
                                "mt_account" => "2352356",
                                "bank_code" => "BBL",
                                "card_image" => "" // image - proof of payment
                            ]
                         ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Request Example (ZotaPay)

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
    "request" => [
        "api_id" => "3031022drc61c64a74f8fcece40a648c17a73379ccc373095acb617fb163a81e",
        "order_id" => "8c5ca6d32567f89034c57023",
        "ip_address" => "123.123.123.1",
        "customer_token"=> "1540e474-39c6-491a-b872-48434930ea3a",
        "amount"=> "14.92",
        "currency"=> "THB",
        "description"=> "Test Purchase",
        "gateway"=> "zotapay",
        "callback_url" => "https://localhost/callback",
        "extra_param" => [
                          "endpoint" => "503968",
                            "bank" => [
                                "customerBankAccountNumber" => "1234567890",
                                "customerBankAccountName" => "John Doe",
                                "customerBankCode" => "BBL",
                                "bank_name" => "Bangkok Bank"

                                // other extra params are optional based on country
                            ]
                         ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Request Example (Curfex)

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
  "request" => [
    "api_id" => "3031022drc61c64a74f8fcece40a648c17a73379ccc373095acb617fb163a81e",
    "order_id" => "8c5ca6d32567f89034c57023",
    "ip_address" => "123.123.123.1",
    "customer_token"=> "1540e474-39c6-491a-b872-48434930ea3a",
    "amount"=> "1500.00",
    "currency"=> "JPY",
    "description"=> "Test Purchase",
    "gateway"=> "curfex",
    "extra_param" => [
      "bank" => [
        "bank_account" => "1234567890",
        "bank_code" => "1013",
        "bank_name" => "OSHIMA_SHINKIN_BANK_JPY"
      ],
      "sender_info" => [
        "sender_name" => "Sender Name",
        "sender_type" => "C",
        "sender_fund_source" => "COMPANY_PROFIT"
      ],
      'bene_info' => [
        'bene_type' => "I",
      ]
    ]
  ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
$ch,
CURLOPT_HTTPHEADER,
[
"Content-type: application/json",
"Accept: application/json",
"Cache-Control: no-cache",
"User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
"Authorization: Bearer ". $auth->access_token
]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Request Example (Inpay)

$url="https://secure.staging.paypipes.net/api/v1/purchase";

$param = [
  "request" => [
    "api_id" => "3031022drc61c64a74f8fcece40a648c17a73379ccc373095acb617fb163a81e",
    "order_id" => "8c5ca6d32567f89034c57023",
    "ip_address" => "123.123.123.1",
    "customer_token"=> "1540e474-39c6-491a-b872-48434930ea3a",
    "amount"=> "1500.00",
    "currency"=> "JPY",
    "description"=> "Test withdraw",
    "gateway"=> "inpay",
    "callback_url" => "https://localhost/callback",
    "extra_param" => [
      "bank" => [
        "account_number" => "00012345", // for JP
        "bank_clearing_system_code" => "JPZGN", // for JP
        "bank_clearing_system_id" => "1234567", // for JP
        "bank_name" => "Test Bank", // for JP
        "iban" => "CZ6508000000192000145399" // for CZ
        "country_code" => "JP"
      ],
      "creditor" => [
        "type" => "private",
        "name" => "Jane Doe",
        "address_lines" => "Schiller strasse 78",
        "postcode" => "12000",
        "city" => "Prague",
        "state" => "Prague",
        "country_code" => "CZ"
      ]
    ]
  ]
];


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
$ch,
CURLOPT_HTTPHEADER,
[
"Content-type: application/json",
"Accept: application/json",
"Cache-Control: no-cache",
"User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
"Authorization: Bearer ". $auth->access_token
]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
    "data": {
        "order_id": "8c5ca6d32567f89034c5702",
        "transaction_id": "47adb6a1-ace6-469e-8ffc-25416fb5e7a0",
        "transaction_type": "withdraw",
        "amount": "14.92",
        "currency": "EUR",
        "status": "Approved",
        "status_code": "201.0000",
        "status_description": "3d-acquirer:The resource was successfully created.",
        "created": "2018-04-23 10:39:38",
        "description": "test withdraw",
        "gateway": "thunderxpay",
    }
}

Response Example (Validation)

{"error":{"amount":["The amount field is required."]},"code":"422"}

{"error":"Invalid Order Id","code":"422"}

Request Example

$url="https://secure.staging.paypipes.net/api/v1/status/10cd5c0a-0832-4de1-9091-bb5199b439f1?api_id=449f11a438853bb84bd7193fd6bceb0886d083d0a8d5e583a7f92fc55573854d";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt(
  $ch,
  CURLOPT_HTTPHEADER,
  [
      "Content-type: application/json",
      "Accept: application/json",
      "Cache-Control: no-cache",
      "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
      "Authorization: Bearer ". $auth->access_token
  ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
  "data":{
     "order_id":"01a8a6507fe1212c37e2c318",
     "transaction_id":"10cd5c0a-0832-4de1-9091-bb5199b439f1",
     "transaction_type":"Purchase",
     "amount":"36.23",
     "currency":"EUR",
     "status":"Approved",
     "status_code":"000.100.112",
     "status_description":"Request successfully processed in 'Merchant in Connector Test Mode'",
     "created":"2020-12-10 13:06:27",
     "card_token":"BF8B8DEE554CAA407506AECD6540",
     "customer_token":"6844a22e-c228-41a0-a0be-ed55f280007f",
     "description": "test purchase",
     "gateway":"trustpay",
     "mask_number":"4005 55XX XXXX 6540",
     "reference_number":"8ac7a4a2764b3ecb01764cc2e2656a90",
     "auth_code":"",
     "request_id":"10cd5c0a-0832-4de1-9091-bb5199b439f1",
     "cards":{
        "data":[
           {
              "card_token":"GF8B8DAE559CAE407506AECD6540",
              "holder":"Test holder",
              "bin":"400555",
              "digit":"6540",
              "brand":"visa",
              "created":"2020-12-10 13:06:50",
              "updated":"2020-12-10 13:06:50",
              "expired":"2023-01-31"
           }
        ]
     }
  }
}

Response Example (Validation)

{"error":{"api_id":["The api_id field is required."]},"code":"422"}

{"error":"Record not found","code":"404"}

Request Example

                
$url="https://secure.paypipes.net/api/v1/transaction/completion";

$param = [
    "request" => [
        "order_id" => "8c5ca6d32567f89034c57025",
        "transaction_id" => "66cb692d-2282-4a92-a641-ff537ae08341",
        "status"=> "completed",
    ]
];
    
    
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt(
$ch,
CURLOPT_HTTPHEADER,
[
    "Content-type: application/json",
    "Accept: application/json",
    "Cache-Control: no-cache",
    "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
    "Authorization: Bearer ". $auth->access_token
]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));
                
            

Response Example (200 OK)

                
{
    "code": 200,
    "status": "success",
    "message": "200 ok"
}
                
            

Response Example (Validation)

                
{
    "code": "422",
    "error": {
        "request.order_id": [
            "The order id field is required"
        ]
    }
}
                
            

Response Example (Error)

                
{
    "code": 401,
    "status": "failed",
    "errors": [
        "ERR.INVALID_TRANSFER_STATUS"
    ]
}
                
            

Request Example

$url="https://secure.staging.paypipes.net/api/v1/tokenize/customers/10cd5c0a-0832-4de1-9091-bb5199b439f1?api_id=449f11a438853bb84bd7193fd6bceb0886d083d0a8d5e583a7f92fc55573854d";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{
   "data":{
    "customer_token":"14d63bf9-e960-466c-bc62-5e241bd81259",
    "order_id":"46c83f43107ef4da0553137d",
    "first_name":"Elliott",
    "last_name":"Davis",
    "street":"Studio 19Carter Keys",
    "city":"West Jackson",
    "state":"Karlburgh",
    "post_code":"CO9 3JZ",
    "country":"Tajikistan",
    "phone_code":"+81",
    "phone":"2727388728",
    "email":"ella08@example.org",
    "status":"Active",
    "created":"2018-05-02 19:28:34",
    "updated":"2018-05-02 19:28:34",
    "expired":"2021-05-02 19:28:34",
    "cards":{
       "data":[
          {
             "card_token":"073FCFCECFDD7468F83B60901003",
             "holder":"Test Card",
             "bin":"401200",
             "digit":"1003",
             "brand":"visa",
             "created":"2018-05-02 19:28:35",
             "updated":"2018-05-02 19:28:35",
             "expired":"2019-01-31 19:28:35"
          }
       ]
    }
 }
}

Response Example (Validation)

{"error":{"api_id":["The api_id field is required."]},"code":"422"}

{"error":"Invalid Api Id","code":"422"}

Request Example

$url="https://secure.staging.paypipes.net/api/v1/tokenize/customers/34490389-d609-46f7-9c29-f0bbd396b968/cards/073FCFCECFDD7468F83B60901003?api_id=449f11a438853bb84bd7193fd6bceb0886d083d0a8d5e583a7f92fc55573854d";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt(
    $ch,
    CURLOPT_HTTPHEADER,
    [
        "Content-type: application/json",
        "Accept: application/json",
        "Cache-Control: no-cache",
        "User-Agent: ".$_SERVER['HTTP_USER_AGENT'],
        "Authorization: Bearer ". $auth->access_token
    ]
);
$response = curl_exec($ch);
curl_close($ch);

var_dump(json_decode($response));

Response Example (200 OK)

{"data":{"card_token":"073FCFCECFDD7468F83B60901003","holder":"Test Card","bin":"401200","digit":"1003","brand":"visa","created":"2018-05-02 19:28:35","updated":"2018-05-02 19:28:35","expired":"2019-01-31 19:28:35"}}

Response Example (Validation)

{"error":{"api_id":["The api_id field is required."]},"code":"422"}

{"error":"Invalid Api Id","code":"422"}

Webhook Example (Skrill)

                        
{
  "data": {
    "order_id": "02c4a9fa93f9fee24da02dc2",
    "transaction_id": "e128f0d5-5565-4830-8931-f9fe3936c995",
    "transaction_type": "Purchase",
    "amount": "1.00",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "2",
    "status_description": "Processed",
    "created": "2021-07-29 14:34:42",
    "card_token": "",
    "customer_token": "a8466e78-1d9b-402f-9734-608b064c5fd3",
    "description": "test purchase",
    "gateway": "skrill",
    "mask_number": "",
    "reference_number": "3816742570",
    "auth_code": "",
    "request_id": "e128f0d5-5565-4830-8931-f9fe3936c995",
    "apple_pay": "",
    "fees": {
      "data": [
        {
          "name": "Conversion Rate",
          "type": "conversion_rate",
          "amount": "1.00",
          "currency": "EUR",
          "customer_email": "testcustomer987@skrill.com"
        }
      ]
    }
  }
}
                        
                    

Webhook Example (Neteller)

                        
{
  "data": {
    "order_id": "21ab911f0e39b9efa412f199",
    "transaction_id": "0ab5028e-0da8-46d2-b601-ec86288a112d",
    "transaction_type": "Purchase",
    "amount": "20.00",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "2",
    "status_description": "Processed",
    "created": "2021-06-30 12:54:16",
    "card_token": "",
    "customer_token": "feb86c24-df3c-44e5-8d20-6dcb623e994a",
    "description": "test purchase",
    "gateway": "neteller",
    "mask_number": "",
    "reference_number": "3776155044",
    "auth_code": "",
    "request_id": "0ab5028e-0da8-46d2-b601-ec86288a112d",
    "apple_pay": "",
    "fees": {
      "data": [
        {
          "name": "Conversion Rate",
          "type": "conversion_rate",
          "amount": "20.00",
          "currency": "EUR",
          "customer_email": "neteller@paypipes.com"
        }
      ]
    }
  }
}
                        
                    

Webhook Example (Paysafecard)

                        
{
  "data": {
    "order_id": "0fcfb1903474df59605108ec",
    "transaction_id": "16a18e57-4043-422e-b248-8f6a7c2a8d30",
    "transaction_type": "Purchase",
    "amount": "63.55",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "201",
    "status_description": "transaction was successful",
    "created": "2021-07-29 14:43:01",
    "card_token": "",
    "customer_token": "a8466e78-1d9b-402f-9734-608b064c5fd3",
    "description": "test purchase",
    "gateway": "paysafecard",
    "mask_number": "",
    "reference_number": "pay_1000030971_16a18e57-4043-422e-b248-8f6a7c2a8d30_EUR",
    "auth_code": "",
    "request_id": "16a18e57-4043-422e-b248-8f6a7c2a8d30",
    "apple_pay": ""
  }
}
                        
                    

Webhook Example (Unlimint)

                        
{
  "data": {
    "order_id": "5408bbdb36c73e7c2589a362",
    "transaction_id": "887071b9-20a1-4779-8adf-8c785e61d5d5",
    "transaction_type": "Purchase",
    "amount": "49.82",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "201",
    "status_description": "COMPLETED",
    "created": "2021-07-29 14:46:46",
    "card_token": "BF1B29E882C7AEEAE4D744480002",
    "customer_token": "a8466e78-1d9b-402f-9734-608b064c5fd3",
    "description": "test purchase",
    "gateway": "cardpay",
    "mask_number": "4000 00XX XXXX 0002",
    "reference_number": "8165141",
    "auth_code": "Wy7v1o",
    "request_id": "887071b9-20a1-4779-8adf-8c785e61d5d5",
    "apple_pay": "",
    "cards": {
      "data": [
        {
          "card_token": "BF1B29E882C7AEEAE4D744480002",
          "holder": "John Doe",
          "bin": "400000",
          "digit": "0002",
          "brand": "visa",
          "card_level": "STANDARD",
          "created": "2021-05-21 09:24:28",
          "updated": "2021-07-29 14:47:04",
          "expired": "2023-01-31"
        }
      ]
    }
  }
}
                        
                    

Webhook Example (SticPay)

                        
{
  "data": {
    "order_id": "74a44d08386f1d406af8b530",
    "transaction_id": "6de3eb9f-7ad0-4288-9dca-bda07eaf5544",
    "transaction_type": "Purchase",
    "amount": "86.96",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "201",
    "status_description": "approved",
    "created": "2021-07-28 10:01:27",
    "card_token": "",
    "customer_token": "8e7d62ac-5c43-4401-b740-9b791670c93f",
    "description": "test purchase",
    "gateway": "sticpay",
    "mask_number": "",
    "reference_number": "11572",
    "auth_code": "",
    "request_id": "6de3eb9f7ad042889dcabda07eaf5544",
    "apple_pay": "",
    "fees": {
      "data": [
        {
          "name": "service fee",
          "type": "service_fee",
          "amount": "2.38",
          "currency": "EUR",
          "customer_email": "test-customer7@sticpay.com",
          "customer_name": "Test Customer 7",
          "verified_status": "{\"email\":\"not_matched\",\"name\":\"not_matched\",\"birthday\":\"not_matched\"}"
        }
      ]
    }
  }
}
                        
                    

Webhook Example (TrustPay)

                        
{
  "data": {
    "order_id": "cec317d405a6ecdefb3d47a0",
    "transaction_id": "0b75068e-3923-48f7-bd2e-7c19db09844f",
    "transaction_type": "Purchase",
    "amount": "29.99",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "000.100.112",
    "status_description": "Request successfully processed in 'Merchant in Connector Test Mode'",
    "created": "2021-07-28 11:52:26",
    "card_token": "125221120A4FCBF5A2AC95F39677",
    "customer_token": "8e7d62ac-5c43-4401-b740-9b791670c93f",
    "description": "test purchase",
    "gateway": "trustpay",
    "mask_number": "5567 26XX XXXX 9677",
    "reference_number": "8ac7a4a07aece25f017aecf5e047308f",
    "auth_code": "",
    "request_id": "0b75068e-3923-48f7-bd2e-7c19db09844f",
    "apple_pay": "",
    "cards": {
      "data": [
        {
          "card_token": "125221120A4FCBF5A2AC95F39677",
          "holder": "sgsdgsdh",
          "bin": "556726",
          "digit": "9677",
          "brand": "mastercard",
          "card_level": "CLASSIC",
          "created": "2021-07-28 11:52:53",
          "updated": "2021-07-28 11:52:53",
          "expired": "2023-01-31"
        }
      ]
    }
  }
}
                        
                    

Webhook Example (PayRedeem)

                        
{
  "data": {
    "order_id": "81a8c6e697db3c571ca6c543",
    "transaction_id": "0c279383-0086-47d3-ae7d-2cefab4f7f44",
    "transaction_type": "Purchase",
    "amount": "100.00",
    "currency": "USD",
    "status": "Approved",
    "status_code": "201",
    "status_description": "Success",
    "created": "2021-07-29 14:54:43",
    "card_token": "",
    "customer_token": "7d931ebb-9131-488e-a93a-b80524e8655c",
    "description": "test purchase",
    "gateway": "payredeem",
    "mask_number": "",
    "reference_number": "01EZ7QTY4ZVW9YK34QFHD7HCVV",
    "auth_code": "AXrywuO-cesQqMgqQAA-0Q",
    "request_id": "0c279383008647d3ae7d2cefab4f7f44",
    "apple_pay": ""
  }
}
                        
                    

Webhook Example (ThunderXpay)

                        
{
  "data": {
    "order_id": "bcc9a3a0-db2b-11eb-a216-072d2a927af5",
    "transaction_id": "e51b1391-94ac-4367-a2d7-26f63b097d8d",
    "transaction_type": "Purchase",
    "amount": "4729.96",
    "currency": "USD",
    "status": "Approved",
    "status_code": "201",
    "status_description": "Approve Transaction",
    "created": "2021-07-02 11:50:48",
    "card_token": "",
    "customer_token": "0a3291cb-55e9-4a3c-a3c9-98c7b55f1223",
    "description": "test purchase",
    "gateway": "thunderxpay",
    "mask_number": "",
    "reference_number": "972",
    "auth_code": "",
    "request_id": "e51b139194ac4367a2d726f63b097d8d",
    "apple_pay": "",
    "fees": {
      "data": [
        {
          "name": "Conversion Rate",
          "type": "conversion_rate",
          "amount": "156088.68",
          "currency": "THB",
          "verified_status": "{\"bank_account\":\"matched\",\"deposit_amount\":\"156088.68\",\"deposit_currency\":\"THB\",\"verify_date\":\"2021-07-02 19:17:54\",\"bank_account_number\":\"1111111111111\"}"
        },
        {
          "name": "Cross Rate",
          "type": "cross_rate",
          "amount": "33.00",
          "currency": "THB"
        }
      ]
    }
  }
}
                        
                    

Webhook Example (ZotaPay)

                        
{
  "data": {
    "order_id": "e27cc7eb4e114282c6b1a4ca",
    "transaction_id": "c3fb5915-bbfd-41ef-89f0-553f8a40f6a4",
    "transaction_type": "Purchase",
    "amount": "49.63",
    "currency": "USD",
    "status": "Approved",
    "status_code": "201",
    "status_description": "APPROVED",
    "created": "2021-07-29 11:56:58",
    "card_token": "",
    "customer_token": "a8466e78-1d9b-402f-9734-608b064c5fd3",
    "description": "test purchase",
    "gateway": "zotapay",
    "mask_number": "",
    "reference_number": "24180839",
    "auth_code": "",
    "request_id": "c3fb5915-bbfd-41ef-89f0-553f8a40f6a4",
    "apple_pay": "",
    "fees": {
      "data": [
        {
          "name": "Conversion Rate",
          "type": "conversion_rate",
          "amount": "211.83",
          "currency": "MYR",
          "verified_status": "{\"dcc\":true,\"dccAmount\":\"211.83\",\"dccCurrency\":\"MYR\",\"paymentMethod\":\"INSTANT-BANK-WIRE\",\"selectedBankCode\":\"CIMB\",\"selectedBankName\":\"CIMB Bank\",\"customer\":\"dylan.miller@example.com\",\"endpointID\":\"503969\"}"
        }
      ]
    }
  }
}
                        
                    

Webhook Example (MaxConnect)

                        
                        {
  "data": {
    "order_id": "74a44d08386f1d406af8b530",
    "transaction_id": "6de3eb9f-7ad0-4288-9dca-bda07eaf5544",
    "transaction_type": "Purchase",
    "amount": "5000.00",
    "currency": "JPY",
    "status": "Approved",
    "status_code": "201",
    "status_description": "Transaction process successfully",
    "created": "2021-07-28 10:01:27",
    "customer_token": "8e7d62ac-5c43-4401-b740-9b791670c93f",
    "description": "test purchase",
    "gateway": "maxconnect",
    "reference_number": "11572",
    "auth_code": "",
    "request_id": "6de3eb9f7ad042889dcabda07eaf5544",
    "apple_pay": "",
    "extradata": {
        "data": [
          {
            "amount": "5000.00",
            "currency": "JPY",
            "customer_name": "スズキ　イチロウ",
            "customer_id": "1e60218c8364",
            "account_number": "9164993"
          }
        ]
  }
                        
                    

Webhook Example (VirtualPay)

                        
{
  "data": {
    "order_id": "20211022090144",
    "transaction_id": "0256e060-5a7e-4e28-8e10-c7c946a0e5ba",
    "transaction_type": "Purchase",
    "amount": "10.00",
    "currency": "USD",
    "status": "Approved",
    "status_code": "00",
    "status_description": "Transaction Succesful",
    "created": "2021-10-22 09:01:45",
    "customer_token": "69c62dcc-84a0-47c9-983b-132e6668217c",
    "description": "test purchase",
    "gateway": "virtualpay",
    "reference_number": "53b85cb8-83d0-499b-8e97-f646f750c245",
    "auth_code": "",
    "request_id": "c946a0e5ba",
    "card_token": "62B6C9A675F76B73E698682C0007",
    "mask_number": "4456 53XX XXXX 0007",
    "apple_pay": "",
    "cards": {
      "data": [
        {
          "card_token": "62B6C9A675F76B73E698682C0007",
          "holder": "test card",
          "bin": "445653",
          "digit": "0007",
          "brand": "visa",
          "card_level": "STANDARD",
          "created": "2021-10-21 15:50:04",
          "updated": "2021-10-21 21:17:47",
          "expired": "2022-12-31"
        }
      ]
    }
  }
}

                        
                    

Webhook Example (Emerchantpay)

                        
{
  "data": {
    "order_id": "19645c24a6594a3073b203aa",
    "transaction_id": "49edf9ea-8020-43a1-9111-5213074b8bb8",
    "transaction_type": "Purchase",
    "amount": "48.05",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "201",
    "status_description": "approved",
    "created": "2021-12-15 10:26:14",
    "customer_token": "2734f378-89bc-4a55-9924-de8f6e60af3c",
    "description": "Ducimus voluptates.",
    "gateway": "emerchantpay",
    "reference_number": "65ba9ebd0c25ded6891e8e4bde1295ab",
    "auth_code": "856904",
    "request_id": "49edf9ea-8020-43a1-9111-5213074b8bb8",
    "card_token": "28E8CC68118BFAA3A9B1C1560000",
    "mask_number": "4200 00XX XXXX 0000",
    "apple_pay": "",
    "cards": {
      "data": [
        {
          "card_token": "28E8CC68118BFAA3A9B1C1560000",
          "holder": "Paypipes Test Card",
          "bin": "420000",
          "digit": "0000",
          "brand": "visa",
          "card_level": "CLASSIC",
          "created": "2021-12-15 10:26:42",
          "updated": "2021-12-15 10:26:42",
          "expired": "2023-01-31"
        }
      ]
    }
  }
}

                        
                    

Webhook Example (Korapay Server-to-Server integration)

                        
{
  "data": {
    "order_id": "53ac96d1352f7ea185b155df",
    "transaction_id": "f448c145-2eb1-4ab6-8ec3-310c6abd1425",
    "transaction_type": "Purchase",
    "amount": "220.52",
    "currency": "NGN",
    "status": "Approved",
    "status_code": "201",
    "status_description": "Approved",
    "created": "2022-07-20 12:14:10",
    "customer_token": "de40b409-9050-4e34-887b-1abffd3bfe91",
    "description": "Et hic quidem ad.",
    "gateway": "korapay",
    "reference_number": "f448c145-2eb1-4ab6-8ec3-310c6abd1425",
    "auth_code": "",
    "request_id": "f448c145-2eb1-4ab6-8ec3-310c6abd1425",
    "card_token": "8E267601847350FD211531034674",
    "mask_number": "4562 54XX XXXX 4674",
    "apple_pay": "",
    "fees": {
      "data": [
        {
          "name": "Service Fee",
          "type": "service_fee",
          "amount": "2.87",
          "currency": "NGN"
        }
      ]
    },
    "cards": {
      "data": [
        {
          "card_token": "8E267601847350FD211531034674",
          "holder": "Martin C",
          "bin": "456254",
          "digit": "4674",
          "brand": "visa",
          "card_level": "ELECTRON",
          "created": "2022-07-14 09:29:56",
          "updated": "2022-07-20 12:14:16",
          "expired": "2022-09-30"
        }
      ]
    }
  }
}

                        
                    

Webhook Example (Korapay Redirect integration)

                        
{
  "data": {
    "order_id": "6c32a267b0777d0f2a300d97",
    "transaction_id": "66313983-8806-44e0-8e80-d4b636b6c3ec",
    "transaction_type": "Purchase",
    "amount": "402.31",
    "currency": "NGN",
    "status": "Approved",
    "status_code": "201",
    "status_description": "Approved",
    "created": "2022-08-18 10:55:31",
    "customer_token": "a8466e78-1d9b-402f-9734-608b064c5fd3",
    "description": "Sit tenetur.",
    "gateway": "korapay",
    "reference_number": "66313983-8806-44e0-8e80-d4b636b6c3ec",
    "auth_code": "",
    "request_id": "66313983-8806-44e0-8e80-d4b636b6c3ec",
    "card_token": "AFD473658209B2560865C9503210",
    "apple_pay": "",
    "fees": {
      "data": [
        {
          "name": "Service Fee",
          "type": "service_fee",
          "amount": "5.23",
          "currency": "NGN"
        }
      ]
    },
    "cards": {
      "data": [
        {
          "card_token": "AFD473658209B2560865C9503210",
          "holder": "Vicky Robinson",
          "bin": "506146",
          "digit": "3210",
          "brand": "mastercard",
          "card_level": "STANDARD",
          "created": "2022-08-18 10:56:05",
          "updated": "2022-08-18 10:56:05",
          "expired": "2023-09-30"
        }
      ]
    }
  }
}
                        
                    

Webhook Example (curfex transaction on process)

                    
{
"data": {
    "order_id": "53ac96d1352f7ea185b155df",
    "transaction_id": "a07ad6c4-8b6a-46ae-8957-6887db2c7c5c",
    "transaction_type": "Purchase",
    "amount": "1450.00",
    "currency": "JPY",
    "status": "Waiting",
    "status_code": "206",
    "status_description": "REVIEW_TRANSFER",
    "created": "2022-12-22 14:15:35",
    "customer_token": "de40b409-9050-4e34-887b-1abffd3bfe91",
    "description": "Et hic quidem ad.",
    "gateway": "curfex",
    "auth_code": "",
    "request_id": "a07ad6c4-8b6a-46ae-8957-6887db2c7c5c",
    "apple_pay": "",
    "fees": {
        "data": [
            {
            "name": "Service Fee",
            "type": "service_fee",
            "amount": "22.00",
            "currency": "JPY",
            "customer_email": "patched_patched_shota11072507@gmail.com",
            "customer_name": "Test Name",
            "verified_status": "{\"name\":\"matched\",\"email\":\"not_matched\"}"
            }
        ]
    },
}
}

                    
                

Webhook Example (curfex approved transaction)

                    
{
    "data": {
        "order_id": "53ac96d1352f7ea185b155df",
        "transaction_id": "a07ad6c4-8b6a-46ae-8957-6887db2c7c5c",
        "transaction_type": "Purchase",
        "amount": "1450.00",
        "currency": "JPY",
        "status": "Approved",
        "status_code": "206",
        "status_description": "TRANSFER_COMPLETED",
        "created": "2022-12-22 14:15:35",
        "customer_token": "de40b409-9050-4e34-887b-1abffd3bfe91",
        "description": "Et hic quidem ad.",
        "gateway": "curfex",
        "auth_code": "",
        "request_id": "a07ad6c4-8b6a-46ae-8957-6887db2c7c5c",
        "reference_number": "0011040",
        "apple_pay": "",
        "fees": {
            "data": [
                {
                "name": "Service Fee",
                "type": "service_fee",
                "amount": "22.00",
                "currency": "JPY",
                "customer_email": "patched_patched_shota11072507@gmail.com",
                "customer_name": "Test Name",
                "verified_status": "{\"name\":\"matched\",\"email\":\"not_matched\"}"
                }
            ]
        },
    }
    }
                    
                

Webhook Example (Intraclear)

                        
{
  "data": {
    "order_id": "20230203150807",
    "transaction_id": "44d6ccae-cb63-4b92-9246-02a6943b94e1",
    "transaction_type": "Purchase",
    "amount": "20.55",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "1000",
    "status_description": "Successful Transaction.",
    "created": "2023-02-03 15:08:07",
    "customer_token": "e41459fd-af8d-469d-b6fc-6b7a8d68f051",
    "description": "Test Purchase from localhost",
    "gateway": "intraclear",
    "reference_number": "txny2ym3ehzlrgkwx",
    "auth_code": "",
    "request_id": "44d6ccae-cb63-4b92-9246-02a6943b94e1",
    "card_token": "ED5F8301F70B12114C25E8300002",
    "mask_number": "4000 00XX XXXX 0002",
    "apple_pay": "",
    "cards": {
      "data": [
        {
          "card_token": "ED5F8301F70B12114C25E8300002",
          "holder": "John Doe",
          "bin": "400000",
          "digit": "0002",
          "brand": "visa",
          "card_level": "STANDARD",
          "created": "2023-02-02 12:25:43",
          "updated": "2023-02-03 15:08:23",
          "expired": "2029-01-31"
        }
      ]
    }
  }
}

                        
                    

Webhook Example (Apple Pay)

                        
{
  "data": {
    "order_id": "15240206131917",
    "transaction_id": "942806s2-a21d-40d9-8039-8ba41e81b97d",
    "transaction_type": "Purchase",
    "amount": "10.00",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "000.000.000",
    "status_description": "Transaction succeeded",
    "created": "2023-02-06 13:49:18",
    "customer_token": "8a57f911-04a9-4cc4-ba51-da1805120159",
    "description": "Test Purchase",
    "gateway": "trustpay",
    "reference_number": "ncAO03XGDXpbBFT0Vg7bqw",
    "auth_code": "",
    "request_id": "942806s2-a21d-40d9-8039-8ba41e81b97",
    "apple_pay": "1"
  }
}
                        
                    

Webhook Example (TigerPay)

                        
{
  "data": {
    "order_id": "6581bcc4-7d84-4b0c-a29d-a3ab0dbb082a",
    "transaction_id": "88514530-0037-4e87-a974-0f55e2fc037b",
    "transaction_type": "Purchase",
    "amount": "1.00",
    "currency": "USD",
    "status": "Approved",
    "status_code": "201",
    "status_description": "OK",
    "created": "2023-04-26 08:18:47",
    "customer_token": "c1d8fc44-385e-4892-86f3-425ead2ea150",
    "description": "Test purchase",
    "gateway": "tigerpay",
    "reference_number": "PFIT15059610",
    "auth_code": "",
    "request_id": "8851453000374e87a9740f55e2fc037b",
    "apple_pay": "",
    "fees": {
      "data": [
        {
          "name": "service fee",
          "type": "service_fee",
          "amount": "",
          "currency": "USD"
        }
      ]
    }
  }
}
                        
                    

Webhook Example (Inpay)

                        
{
  "data": {
    "order_id": "6581bcc4-7d84-4b0c-a29d-a3ab0dbb082a",
    "transaction_id": "88514530-0037-4e87-a974-0f55e2fc037b",
    "transaction_type": "Withdraw",
    "amount": "1.00",
    "currency": "EUR",
    "status": "Approved",
    "status_code": "201",
    "status_description": "OK",
    "created": "2023-04-26 08:18:47",
    "customer_token": "c1d8fc44-385e-4892-86f3-425ead2ea150",
    "description": "Test purchase",
    "gateway": "inpay",
    "reference_number": "PFIT15059610",
    "auth_code": "",
    "request_id": "8851453000374e87a9740f55e2fc037b",
    "apple_pay": "",
  }
}
                        
                    

Test Data

Any PayPal sandbox account

Test Data

Test Data

Test Data

Test Data

Test Data

Test Data

Test Data

3D Secure 2 test cards

Test Data for DIRECT integration

Test Data for IFRAME integration

Simulator Test Data

Payredeem eCards PIN

Test Data

Test Data

Test Data For Withdrawals

Test Data

Test Data

Test Data

Test Data

Test Data

Test Data for Withdrawals

Test Data

For 3D Secure, input 3D value into card holdername field

Test Data

Apple Pay doesn't offer any test card data

Test Data

Test Data

Any valid address & bank info.