Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/oauth/token" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"client_id\": \"PUT_YOUR_CLIENT_ID_HERE\",
    \"client_secret\": \"PUT_YOUR_CLIENT_SECRET_HERE\",
    \"grant_type\": \"client_credentials\"
}"

const url = new URL(
    "https://secure.staging.paypipes.net/oauth/token"
);

const headers = {
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "client_id": "PUT_YOUR_CLIENT_ID_HERE",
    "client_secret": "PUT_YOUR_CLIENT_SECRET_HERE",
    "grant_type": "client_credentials"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/oauth/token';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'client_id' => 'PUT_YOUR_CLIENT_ID_HERE',
            'client_secret' => 'PUT_YOUR_CLIENT_SECRET_HERE',
            'grant_type' => 'client_credentials',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/oauth/token'
payload = {
    "client_id": "PUT_YOUR_CLIENT_ID_HERE",
    "client_secret": "PUT_YOUR_CLIENT_SECRET_HERE",
    "grant_type": "client_credentials"
}
headers = {
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "token_type": "Bearer",
    "expires_in": 259200,
    "access_token": "eyJ0eXAiOiJKL1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5N2VhNjdiYS03ZWNkLTRkODYtYjRlNC1hYjI2YzY2NGMyNTYiLC JqdGkiOiJjMTM1NjU5OWRlNjE0Y2ViNWU3ZDJkNmI5MTE3MTcxMWE2ZjY5OTlkMDM4MjIyNmY2ZmIwOGI4MWJiOGM1MjgxNGY4ODQxZWJlMjZkZmRmNyI sImlhdCI6MTcxNzc1NjUzOC45MTIwNjEsIm5iZiI6MTcxNzc1NjUzOC45MTIwNjIsImV4cCI6MTcxODAxNTczOC45MTAxNDgsInN1YiI6IiIsInNjb3Blc yI6W119.BctTyyN20SkMH200hJaP3NGqQ69Xu7RT2aAmymprq2TRDBH02F3jUlzkufSkR3Zp6pW1_1c7ridFoqjjHCJKrpxQND9TzcrGE9QjUDiFpswzbE 9ljDQ1HRUYfIvFCqGVS8PQ69J3-i-FPl4uwcTNJ1mq3eoI0A-X5d2J0INPRou-HgbQYYv3vTtm_OCVriuSHm8QCMVdej5Xq41bDzuxIsgh_OPgARUBs51y q8JjPtBAS5z_OArus1YSCfx0gyYbvy2VJuOGgPILCzUpboseaWNO2OHdIjUD1h8foMXhDlCScn0wfJFwOsEUl6Nn22DZIzToCTOwibd-lwzmir4-OAJCs ManyyfRdkU2aqb5OnVFjauzIMnznswGq9d3IzkV6cimWsDs7ZwD6RwGv5I0yF6NGsTfCah_DO9Ch9z-iNVjJe27aO0EhgdpHELIkmnTprfVYPcD2LTKJ5 6ap8g5JTmtsykFKY1sK8WoAK12YqjZRdfRkiiqltJc1x2569hGFT102VCnH5ECpDmh2EAyOLx0d_E7juS_dxgQrVIZAOzcTyLZN6ckM03PBp4n3bhLCoi U1kptvFQ2vgpxavt6xF7ESPAmgEUj0zo0mIxnVqRegPJm1hRxlIplb1nfR-mDpG3FSn8Ms_RxtAksghFmLXysqLpipiRbiF540v8DXTz"
}
 

Example response (401, Error response):

{
    "error": "invalid_request",
    "error_description": "The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.",
    "hint": "Check the `client_id` parameter",
    "message": "The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/purchase" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"order_id\": \"ORD1234567890\",
    \"amount\": \"100.00\",
    \"currency\": \"USD\",
    \"description\": \"Payment for order ORD1234567890\",
    \"return_url\": \"https:\\/\\/example.com\\/result\",
    \"callback_url\": \"https:\\/\\/example.com\\/callback\",
    \"cancel_url\": \"https:\\/\\/example.com\\/cancel\",
    \"origin\": \"web\",
    \"customer_token\": \"11cc649a-cdab-4b26-b9ec-781920174ca6\",
    \"card_token\": \"E75C608271E3852BA81A87540085\",
    \"gateway\": \"unlimit\",
    \"type\": \"card\",
    \"language\": \"en\",
    \"simulator\": true,
    \"save_card_for_future_use\": true,
    \"billing_address\": true
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/purchase"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "order_id": "ORD1234567890",
    "amount": "100.00",
    "currency": "USD",
    "description": "Payment for order ORD1234567890",
    "return_url": "https:\/\/example.com\/result",
    "callback_url": "https:\/\/example.com\/callback",
    "cancel_url": "https:\/\/example.com\/cancel",
    "origin": "web",
    "customer_token": "11cc649a-cdab-4b26-b9ec-781920174ca6",
    "card_token": "E75C608271E3852BA81A87540085",
    "gateway": "unlimit",
    "type": "card",
    "language": "en",
    "simulator": true,
    "save_card_for_future_use": true,
    "billing_address": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/purchase';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'order_id' => 'ORD1234567890',
            'amount' => '100.00',
            'currency' => 'USD',
            'description' => 'Payment for order ORD1234567890',
            'return_url' => 'https://example.com/result',
            'callback_url' => 'https://example.com/callback',
            'cancel_url' => 'https://example.com/cancel',
            'origin' => 'web',
            'customer_token' => '11cc649a-cdab-4b26-b9ec-781920174ca6',
            'card_token' => 'E75C608271E3852BA81A87540085',
            'gateway' => 'unlimit',
            'type' => 'card',
            'language' => 'en',
            'simulator' => true,
            'save_card_for_future_use' => true,
            'billing_address' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/purchase'
payload = {
    "order_id": "ORD1234567890",
    "amount": "100.00",
    "currency": "USD",
    "description": "Payment for order ORD1234567890",
    "return_url": "https:\/\/example.com\/result",
    "callback_url": "https:\/\/example.com\/callback",
    "cancel_url": "https:\/\/example.com\/cancel",
    "origin": "web",
    "customer_token": "11cc649a-cdab-4b26-b9ec-781920174ca6",
    "card_token": "E75C608271E3852BA81A87540085",
    "gateway": "unlimit",
    "type": "card",
    "language": "en",
    "simulator": true,
    "save_card_for_future_use": true,
    "billing_address": true
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "redirect_url": "https://secure.paypipes.com/v2/redirect/f10f8c7b-a18b-46a2-978a-dadb5ce80987",
    "expires_at": "2024-05-03 14:14:34",
    "purchase_request_id": "79e03b19c411f001981ca4a6d30aa407300c23b1"
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Invalid currency",
    "code": 100003
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/card/process" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"jwe\": \"eyJhbGciOiJ...\"
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/card/process"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "jwe": "eyJhbGciOiJ..."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/card/process';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'jwe' => 'eyJhbGciOiJ...',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/card/process'
payload = {
    "jwe": "eyJhbGciOiJ..."
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "version": 2,
    "orderID": "ORD1234567890",
    "trxID": "6c37e2d5-92cc-4241-a9f8-9813720aec64",
    "trxType": "Purchase",
    "amount": "15.00",
    "currency": "EUR",
    "status": "Waiting",
    "paymentStatus": null,
    "statusCode": "200",
    "statusDescription": "",
    "declineCode": null,
    "created": "2024-06-04T10:50:38.000000Z",
    "cardToken": "E75C608271E3852BA81A87540085",
    "customerToken": "11cc649a-cdab-4b26-b9ec-781920174ca6",
    "description": "Charge transaction with ID #ORD1234567890",
    "gateway": "ecommpay",
    "applePay": false,
    "googlePay": false,
    "refNo": null,
    "requestID": "6c37e2d5-92cc-4241-a9f8-9813720aec6",
    "authCode": null,
    "card": {
        "holder": "John Doe",
        "bin": "401200",
        "digit": "0085",
        "brand": "visa",
        "cardLevel": "CLASSIC",
        "expired": "12/2025",
        "maskNumber": "4012 00XX XXXX 0085"
    },
    "bank": null,
    "customerBank": null,
    "fees": null,
    "meta": null,
    "threeds": {
        "redirectUrl": "https://secure.paypipes.com/api/v2/card/threeds",
        "redirectParams": {
            "purchase_request_id": "4b99850b6a24fede48c38a5a41d59d20d53c3102"
        }
    }
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Transaction has invalid status: Pending",
    "code": 200013
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/card/threeds" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"purchase_request_id\": \"b2685b95ec0de53d6871f836e3c90dca05fa1b44\"
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/card/threeds"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "purchase_request_id": "b2685b95ec0de53d6871f836e3c90dca05fa1b44"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/card/threeds';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'purchase_request_id' => 'b2685b95ec0de53d6871f836e3c90dca05fa1b44',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/card/threeds'
payload = {
    "purchase_request_id": "b2685b95ec0de53d6871f836e3c90dca05fa1b44"
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

<!DOCTYPE html>
<html lang="en">

<head>
    <title>Redirecting ...</title>
    <script type="module" nonce="">
        document.addEventListener('DOMContentLoaded', function () {
            window.location.href = "https://authentication-devices.sandbox.checkout.com/sessions-interceptor/sid_l3qxbdli5mmevhz3tb4gzyysfi"
        });
    </script>
</head>

</html>
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Transaction has invalid status: Pending",
    "code": 200013
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/charge" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"order_id\": \"ORD1234567890\",
    \"transaction_id\": \"123e4567-e89b-12d3-a456-426614174000\",
    \"amount\": \"100.00\",
    \"currency\": \"USD\",
    \"description\": \"Payment for order ORD1234567890\"
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/charge"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "order_id": "ORD1234567890",
    "transaction_id": "123e4567-e89b-12d3-a456-426614174000",
    "amount": "100.00",
    "currency": "USD",
    "description": "Payment for order ORD1234567890"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/charge';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'order_id' => 'ORD1234567890',
            'transaction_id' => '123e4567-e89b-12d3-a456-426614174000',
            'amount' => '100.00',
            'currency' => 'USD',
            'description' => 'Payment for order ORD1234567890',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/charge'
payload = {
    "order_id": "ORD1234567890",
    "transaction_id": "123e4567-e89b-12d3-a456-426614174000",
    "amount": "100.00",
    "currency": "USD",
    "description": "Payment for order ORD1234567890"
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "version": 2,
    "orderID": "ORD1234567890",
    "trxID": "6c37e2d5-92cc-4241-a9f8-9813720aec64",
    "trxType": "Purchase",
    "amount": "15.00",
    "currency": "EUR",
    "status": "Waiting",
    "paymentStatus": null,
    "statusCode": "200",
    "statusDescription": "",
    "declineCode": null,
    "created": "2024-06-04T10:50:38.000000Z",
    "cardToken": "E75C608271E3852BA81A87540085",
    "customerToken": "11cc649a-cdab-4b26-b9ec-781920174ca6",
    "description": "Charge transaction with ID #ORD1234567890",
    "gateway": "ecommpay",
    "applePay": false,
    "googlePay": false,
    "refNo": null,
    "requestID": "6c37e2d5-92cc-4241-a9f8-9813720aec6",
    "authCode": null,
    "card": {
        "holder": "John Doe",
        "bin": "401200",
        "digit": "0085",
        "brand": "visa",
        "cardLevel": "CLASSIC",
        "expired": "12/2025",
        "maskNumber": "4012 00XX XXXX 0085"
    },
    "bank": null,
    "customerBank": null,
    "fees": null,
    "meta": null
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Transaction has invalid status: Pending",
    "code": 200013
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/charge/cancel" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"order_id\": \"ORD1234567890\",
    \"transaction_id\": \"123e4567-e89b-12d3-a456-426614174000\"
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/charge/cancel"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "order_id": "ORD1234567890",
    "transaction_id": "123e4567-e89b-12d3-a456-426614174000"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/charge/cancel';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'order_id' => 'ORD1234567890',
            'transaction_id' => '123e4567-e89b-12d3-a456-426614174000',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/charge/cancel'
payload = {
    "order_id": "ORD1234567890",
    "transaction_id": "123e4567-e89b-12d3-a456-426614174000"
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "version": 2,
    "orderID": "ORD1234567890",
    "trxID": "6c37e2d5-92cc-4241-a9f8-9813720aec64",
    "trxType": "Cancel",
    "amount": "15.00",
    "currency": "EUR",
    "status": "Waiting",
    "paymentStatus": null,
    "statusCode": "200",
    "statusDescription": "",
    "declineCode": null,
    "created": "2024-06-04T10:50:38.000000Z",
    "cardToken": "E75C608271E3852BA81A87540085",
    "customerToken": "11cc649a-cdab-4b26-b9ec-781920174ca6",
    "description": "Charge cancel transaction with ID #ORD1234567890",
    "gateway": "ecommpay",
    "applePay": false,
    "googlePay": false,
    "refNo": null,
    "requestID": "6c37e2d5-92cc-4241-a9f8-9813720aec6",
    "authCode": null,
    "card": {
        "holder": "John Doe",
        "bin": "401200",
        "digit": "0085",
        "brand": "visa",
        "cardLevel": "CLASSIC",
        "expired": "12/2025",
        "maskNumber": "4012 00XX XXXX 0085"
    },
    "bank": null,
    "customerBank": null,
    "fees": null,
    "meta": null
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Transaction has invalid status: Pending",
    "code": 200013
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/reverse" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"transaction_id\": \"123e4567-e89b-12d3-a456-426614174000\",
    \"order_id\": \"ORD1234567890\",
    \"description\": \"Reverse transaction with ID #ORD1234567890\",
    \"callback_url\": \"https:\\/\\/example.com\\/callback\",
    \"execution_date\": \"2024-07-01T14:30:00Z\"
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/reverse"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "transaction_id": "123e4567-e89b-12d3-a456-426614174000",
    "order_id": "ORD1234567890",
    "description": "Reverse transaction with ID #ORD1234567890",
    "callback_url": "https:\/\/example.com\/callback",
    "execution_date": "2024-07-01T14:30:00Z"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/reverse';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'transaction_id' => '123e4567-e89b-12d3-a456-426614174000',
            'order_id' => 'ORD1234567890',
            'description' => 'Reverse transaction with ID #ORD1234567890',
            'callback_url' => 'https://example.com/callback',
            'execution_date' => '2024-07-01T14:30:00Z',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/reverse'
payload = {
    "transaction_id": "123e4567-e89b-12d3-a456-426614174000",
    "order_id": "ORD1234567890",
    "description": "Reverse transaction with ID #ORD1234567890",
    "callback_url": "https:\/\/example.com\/callback",
    "execution_date": "2024-07-01T14:30:00Z"
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "version": 2,
    "orderID": "ORD1234567890",
    "trxID": "6c37e2d5-92cc-4241-a9f8-9813720aec64",
    "trxType": "Reverse",
    "amount": "15.00",
    "currency": "EUR",
    "status": "Approved",
    "paymentStatus": null,
    "statusCode": "200",
    "statusDescription": "Transaction has been reversed",
    "declineCode": null,
    "created": "2024-06-04T10:50:38.000000Z",
    "cardToken": "E75C608271E3852BA81A87540085",
    "customerToken": "11cc649a-cdab-4b26-b9ec-781920174ca6",
    "description": "Reverse transaction with ID #ORD1234567890",
    "gateway": "trustpay",
    "applePay": false,
    "googlePay": false,
    "refNo": null,
    "requestID": "6c37e2d5-92cc-4241-a9f8-9813720aec6",
    "authCode": null,
    "card": {
        "holder": "John Doe",
        "bin": "401200",
        "digit": "0085",
        "brand": "visa",
        "cardLevel": "CLASSIC",
        "expired": "12/2025",
        "maskNumber": "4012 00XX XXXX 0085"
    },
    "bank": null,
    "customerBank": null,
    "fees": null,
    "meta": null
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Transaction has invalid status: Pending",
    "code": 200013
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/refund" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"transaction_id\": \"123e4567-e89b-12d3-a456-426614174000\",
    \"order_id\": \"ORD1234567890\",
    \"description\": \"Refund transaction with ID #ORD1234567890\",
    \"amount\": \"25.00\",
    \"callback_url\": \"https:\\/\\/example.com\\/callback\",
    \"execution_date\": \"2024-07-01T14:30:00Z\"
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/refund"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "transaction_id": "123e4567-e89b-12d3-a456-426614174000",
    "order_id": "ORD1234567890",
    "description": "Refund transaction with ID #ORD1234567890",
    "amount": "25.00",
    "callback_url": "https:\/\/example.com\/callback",
    "execution_date": "2024-07-01T14:30:00Z"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/refund';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'transaction_id' => '123e4567-e89b-12d3-a456-426614174000',
            'order_id' => 'ORD1234567890',
            'description' => 'Refund transaction with ID #ORD1234567890',
            'amount' => '25.00',
            'callback_url' => 'https://example.com/callback',
            'execution_date' => '2024-07-01T14:30:00Z',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/refund'
payload = {
    "transaction_id": "123e4567-e89b-12d3-a456-426614174000",
    "order_id": "ORD1234567890",
    "description": "Refund transaction with ID #ORD1234567890",
    "amount": "25.00",
    "callback_url": "https:\/\/example.com\/callback",
    "execution_date": "2024-07-01T14:30:00Z"
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "version": 2,
    "orderID": "ORD1234567890",
    "trxID": "6c37e2d5-92cc-4241-a9f8-9813720aec64",
    "trxType": "Refund",
    "amount": "15.00",
    "currency": "EUR",
    "status": "Approved",
    "paymentStatus": null,
    "statusCode": "200",
    "statusDescription": "Transaction has been refunded",
    "declineCode": null,
    "created": "2024-06-04T10:50:38.000000Z",
    "cardToken": "E75C608271E3852BA81A87540085",
    "customerToken": "11cc649a-cdab-4b26-b9ec-781920174ca6",
    "description": "Refund transaction with ID #ORD1234567890",
    "gateway": "trustpay",
    "applePay": false,
    "googlePay": false,
    "refNo": null,
    "requestID": "6c37e2d5-92cc-4241-a9f8-9813720aec6",
    "authCode": null,
    "card": {
        "holder": "John Doe",
        "bin": "401200",
        "digit": "0085",
        "brand": "visa",
        "cardLevel": "CLASSIC",
        "expired": "12/2025",
        "maskNumber": "4012 00XX XXXX 0085"
    },
    "bank": null,
    "customerBank": null,
    "fees": null,
    "meta": null
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Transaction has invalid status: Pending",
    "code": 200013
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/transaction" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/transaction"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/transaction';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/transaction'
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200, Successful response):

[
    {
        "version": 2,
        "orderID": "ORD1234567890",
        "trxID": "6c37e2d5-92cc-4241-a9f8-9813720aec64",
        "trxType": "Purchase",
        "amount": "15.00",
        "currency": "EUR",
        "status": "Waiting",
        "paymentStatus": null,
        "statusCode": "200",
        "statusDescription": "",
        "declineCode": null,
        "created": "2024-06-04T10:50:38.000000Z",
        "cardToken": "E75C608271E3852BA81A87540085",
        "customerToken": "11cc649a-cdab-4b26-b9ec-781920174ca6",
        "description": "Charge transaction with ID #ORD1234567890",
        "gateway": "ecommpay",
        "applePay": false,
        "googlePay": false,
        "refNo": null,
        "requestID": "6c37e2d5-92cc-4241-a9f8-9813720aec6",
        "authCode": null,
        "card": {
            "holder": "John Doe",
            "bin": "401200",
            "digit": "0085",
            "brand": "visa",
            "cardLevel": "CLASSIC",
            "expired": "12/2025",
            "maskNumber": "4012 00XX XXXX 0085"
        },
        "bank": null,
        "customerBank": null,
        "fees": null,
        "meta": null
    },
    {
        "version": 2,
        "orderID": "ORD1234567890",
        "trxID": "6c37e2d5-92cc-4241-a9f8-9813720aec64",
        "trxType": "Purchase",
        "amount": "15.00",
        "currency": "EUR",
        "status": "Waiting",
        "paymentStatus": null,
        "statusCode": "200",
        "statusDescription": "",
        "declineCode": null,
        "created": "2024-06-04T10:50:38.000000Z",
        "cardToken": "E75C608271E3852BA81A87540085",
        "customerToken": "11cc649a-cdab-4b26-b9ec-781920174ca6",
        "description": "Charge transaction with ID #ORD1234567890",
        "gateway": "ecommpay",
        "applePay": false,
        "googlePay": false,
        "refNo": null,
        "requestID": "6c37e2d5-92cc-4241-a9f8-9813720aec6",
        "authCode": null,
        "card": {
            "holder": "John Doe",
            "bin": "401200",
            "digit": "0085",
            "brand": "visa",
            "cardLevel": "CLASSIC",
            "expired": "12/2025",
            "maskNumber": "4012 00XX XXXX 0085"
        },
        "bank": null,
        "customerBank": null,
        "fees": null,
        "meta": null
    }
]
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Transaction has invalid status: Pending",
    "code": 200013
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/inpay/withdraw" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"customer_token\": \"99cc649a-cdab-4b26-b9ec-781920174ca6\",
    \"bank_token\": \"0402763a-1a10-47ae-b00a-95d773177aa3\",
    \"order_id\": \"ORD1234567890\",
    \"description\": \"Withdraw transaction with ID #ORD1234567890\",
    \"amount\": \"1000.00\",
    \"currency\": \"JPY\",
    \"callback_url\": \"https:\\/\\/example.com\\/callback\",
    \"creditor\": {
        \"name\": \"Jane Doe\",
        \"address_lines\": \"Schillerstrasse 78\",
        \"postcode\": \"120-0015\",
        \"city\": \"Scherstetten\",
        \"state\": \"Adachi\",
        \"country_code\": \"JP\",
        \"birthdate\": \"1959-09-01\"
    },
    \"creditor_account\": {
        \"account_number\": \"00012345\",
        \"country_code\": \"JP\",
        \"bank_name\": \"Test Bank\"
    }
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/inpay/withdraw"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "customer_token": "99cc649a-cdab-4b26-b9ec-781920174ca6",
    "bank_token": "0402763a-1a10-47ae-b00a-95d773177aa3",
    "order_id": "ORD1234567890",
    "description": "Withdraw transaction with ID #ORD1234567890",
    "amount": "1000.00",
    "currency": "JPY",
    "callback_url": "https:\/\/example.com\/callback",
    "creditor": {
        "name": "Jane Doe",
        "address_lines": "Schillerstrasse 78",
        "postcode": "120-0015",
        "city": "Scherstetten",
        "state": "Adachi",
        "country_code": "JP",
        "birthdate": "1959-09-01"
    },
    "creditor_account": {
        "account_number": "00012345",
        "country_code": "JP",
        "bank_name": "Test Bank"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/inpay/withdraw';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'customer_token' => '99cc649a-cdab-4b26-b9ec-781920174ca6',
            'bank_token' => '0402763a-1a10-47ae-b00a-95d773177aa3',
            'order_id' => 'ORD1234567890',
            'description' => 'Withdraw transaction with ID #ORD1234567890',
            'amount' => '1000.00',
            'currency' => 'JPY',
            'callback_url' => 'https://example.com/callback',
            'creditor' => [
                'name' => 'Jane Doe',
                'address_lines' => 'Schillerstrasse 78',
                'postcode' => '120-0015',
                'city' => 'Scherstetten',
                'state' => 'Adachi',
                'country_code' => 'JP',
                'birthdate' => '1959-09-01',
            ],
            'creditor_account' => [
                'account_number' => '00012345',
                'country_code' => 'JP',
                'bank_name' => 'Test Bank',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/inpay/withdraw'
payload = {
    "customer_token": "99cc649a-cdab-4b26-b9ec-781920174ca6",
    "bank_token": "0402763a-1a10-47ae-b00a-95d773177aa3",
    "order_id": "ORD1234567890",
    "description": "Withdraw transaction with ID #ORD1234567890",
    "amount": "1000.00",
    "currency": "JPY",
    "callback_url": "https:\/\/example.com\/callback",
    "creditor": {
        "name": "Jane Doe",
        "address_lines": "Schillerstrasse 78",
        "postcode": "120-0015",
        "city": "Scherstetten",
        "state": "Adachi",
        "country_code": "JP",
        "birthdate": "1959-09-01"
    },
    "creditor_account": {
        "account_number": "00012345",
        "country_code": "JP",
        "bank_name": "Test Bank"
    }
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "version": 2,
    "orderID": "order123",
    "trxID": "54adcf49-b19f-4f84-a8a4-c7969cb50cb6",
    "trxType": "Withdraw",
    "amount": "1.00",
    "currency": "EUR",
    "status": "Waiting",
    "paymentStatus": null,
    "statusCode": "0",
    "statusDescription": "received",
    "declineCode": null,
    "created": "2024-10-08T10:46:16.000000Z",
    "cardToken": null,
    "customerToken": "5712cd65-78bb-43f8-9b9a-a8fa4ac43c18",
    "description": "Test withdrawal",
    "gateway": "inpay",
    "applePay": false,
    "googlePay": false,
    "refNo": "4CRK4Q9",
    "requestID": "54adcf49-b19f-4f84-a8a4-c7969cb50cb6",
    "authCode": null,
    "card": null,
    "bank": null,
    "customerBank": null,
    "fees": null,
    "meta": null
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (422, Error response):

{
    "error": "Invalid currency",
    "code": 100003
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://secure.staging.paypipes.net/api/v2/transaction/b748bab7-e930-42f4-b673-fe29e30acad3" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/transaction/b748bab7-e930-42f4-b673-fe29e30acad3"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/transaction/b748bab7-e930-42f4-b673-fe29e30acad3';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/transaction/b748bab7-e930-42f4-b673-fe29e30acad3'
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200, Successful response):

{
    "version": 2,
    "orderID": "2381cfcc-e15d-4342-a5ef-5f758265f010",
    "trxID": "b748bab7-e930-42f4-b673-fe29e30acadc",
    "trxType": "Purchase",
    "amount": "15.00",
    "currency": "EUR",
    "status": "Pending",
    "paymentStatus": null,
    "statusCode": "",
    "statusDescription": null,
    "declineCode": null,
    "created": "2024-06-04T13:59:55.000000Z",
    "cardToken": null,
    "customerToken": "11cc649a-cdab-4b26-b9ec-781920174ca6",
    "description": "EUR test",
    "gateway": "trustpay",
    "applePay": false,
    "googlePay": false,
    "refNo": null,
    "requestID": null,
    "authCode": null,
    "card": null,
    "bank": null,
    "customerBank": null,
    "fees": null,
    "meta": null
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Invalid currency",
    "code": 100003
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/tokenize/customers" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"jp_fullname\": \"山田 太郎\",
    \"street\": \"123 Maple Street\",
    \"city\": \"London\",
    \"state\": \"CA\",
    \"post_code\": \"94107\",
    \"country\": \"GB\",
    \"email\": \"john.doe@example.com\",
    \"phone_code\": \"+44\",
    \"phone\": \"5551234567\",
    \"reference_id\": \"ABC123XYZ\",
    \"date_of_birth\": \"2021-10-20\",
    \"legal_entity\": \"PRIVATE\",
    \"identifiers\": [
        {
            \"id\": \"123456\",
            \"gateway\": \"trustpay\"
        },
        {
            \"id\": \"456789\",
            \"gateway\": \"unlimit\"
        }
    ]
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/tokenize/customers"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "first_name": "John",
    "last_name": "Doe",
    "jp_fullname": "山田 太郎",
    "street": "123 Maple Street",
    "city": "London",
    "state": "CA",
    "post_code": "94107",
    "country": "GB",
    "email": "john.doe@example.com",
    "phone_code": "+44",
    "phone": "5551234567",
    "reference_id": "ABC123XYZ",
    "date_of_birth": "2021-10-20",
    "legal_entity": "PRIVATE",
    "identifiers": [
        {
            "id": "123456",
            "gateway": "trustpay"
        },
        {
            "id": "456789",
            "gateway": "unlimit"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/tokenize/customers';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'first_name' => 'John',
            'last_name' => 'Doe',
            'jp_fullname' => '山田 太郎',
            'street' => '123 Maple Street',
            'city' => 'London',
            'state' => 'CA',
            'post_code' => '94107',
            'country' => 'GB',
            'email' => 'john.doe@example.com',
            'phone_code' => '+44',
            'phone' => '5551234567',
            'reference_id' => 'ABC123XYZ',
            'date_of_birth' => '2021-10-20',
            'legal_entity' => 'PRIVATE',
            'identifiers' => [
                [
                    'id' => '123456',
                    'gateway' => 'trustpay',
                ],
                [
                    'id' => '456789',
                    'gateway' => 'unlimit',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/tokenize/customers'
payload = {
    "first_name": "John",
    "last_name": "Doe",
    "jp_fullname": "山田 太郎",
    "street": "123 Maple Street",
    "city": "London",
    "state": "CA",
    "post_code": "94107",
    "country": "GB",
    "email": "john.doe@example.com",
    "phone_code": "+44",
    "phone": "5551234567",
    "reference_id": "ABC123XYZ",
    "date_of_birth": "2021-10-20",
    "legal_entity": "PRIVATE",
    "identifiers": [
        {
            "id": "123456",
            "gateway": "trustpay"
        },
        {
            "id": "456789",
            "gateway": "unlimit"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (201, Successful response):

{
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "first_name": "John",
    "last_name": "Doe",
    "jp_fullname": "山田 太郎",
    "street": "123 Maple Street",
    "city": "London",
    "state": null,
    "post_code": "94107",
    "country": "GB",
    "phone_code": "+44",
    "phone": "5551234567",
    "email": "john.doe@example.com",
    "reference_id": "ABC123XYZ",
    "date_of_birth": "2021-10-20",
    "legal_entity": "PRIVATE",
    "status": "Active",
    "created": "2024-06-04T10:06:57.000000Z",
    "updated": "2024-06-04T10:06:57.000000Z",
    "identifiers": [
        {
            "id": "123456",
            "gateway": "trustpay",
            "created": "2024-06-04T10:06:57.000000Z",
            "updated": "2024-06-04T10:06:57.000000Z"
        },
        {
            "id": "456789",
            "gateway": "unlimit",
            "created": "2024-06-04T10:06:57.000000Z",
            "updated": "2024-06-04T10:06:57.000000Z"
        }
    ],
    "banks": [
        {
            "bank_token": "c9c97d4a-d1c3-4aa4-abd2-a32436800437",
            "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
            "title": "Test bank account",
            "currency": "JPY",
            "beneficiary_name": "John Doe",
            "beneficiary_address": "123 Maple Street, London",
            "bank_name": "Metro Bank",
            "branch_name": "MetroBank",
            "bank_address": "123 Maple Street, London",
            "bank_code": "0100",
            "account_number": "1234567890",
            "iban": "GB23MBTC60161331926819",
            "bic": "MBTCPHMMXXX",
            "account_type": "checking",
            "bank_clearing_system_code": "SGIBG",
            "bank_clearing_system_id": "1234567"
        }
    ]
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Invalid currency",
    "code": 100003
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PATCH \
    "https://secure.staging.paypipes.net/api/v2/tokenize/customers/31e80148-746c-11e8-ad82-000d3a2b9844" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"jp_fullname\": \"山田 太郎\",
    \"street\": \"123 Maple Street\",
    \"city\": \"London\",
    \"state\": \"CA\",
    \"post_code\": \"94107\",
    \"country\": \"GB\",
    \"email\": \"john.doe@example.com\",
    \"phone_code\": \"+44\",
    \"phone\": \"5551234567\",
    \"reference_id\": \"ABC123XYZ\",
    \"date_of_birth\": \"2021-10-20\",
    \"legal_entity\": \"PRIVATE\",
    \"identifiers\": [
        {
            \"id\": \"123456\",
            \"gateway\": \"trustpay\"
        },
        {
            \"id\": \"456789\",
            \"gateway\": \"unlimit\"
        }
    ]
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/tokenize/customers/31e80148-746c-11e8-ad82-000d3a2b9844"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "first_name": "John",
    "last_name": "Doe",
    "jp_fullname": "山田 太郎",
    "street": "123 Maple Street",
    "city": "London",
    "state": "CA",
    "post_code": "94107",
    "country": "GB",
    "email": "john.doe@example.com",
    "phone_code": "+44",
    "phone": "5551234567",
    "reference_id": "ABC123XYZ",
    "date_of_birth": "2021-10-20",
    "legal_entity": "PRIVATE",
    "identifiers": [
        {
            "id": "123456",
            "gateway": "trustpay"
        },
        {
            "id": "456789",
            "gateway": "unlimit"
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/tokenize/customers/31e80148-746c-11e8-ad82-000d3a2b9844';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'first_name' => 'John',
            'last_name' => 'Doe',
            'jp_fullname' => '山田 太郎',
            'street' => '123 Maple Street',
            'city' => 'London',
            'state' => 'CA',
            'post_code' => '94107',
            'country' => 'GB',
            'email' => 'john.doe@example.com',
            'phone_code' => '+44',
            'phone' => '5551234567',
            'reference_id' => 'ABC123XYZ',
            'date_of_birth' => '2021-10-20',
            'legal_entity' => 'PRIVATE',
            'identifiers' => [
                [
                    'id' => '123456',
                    'gateway' => 'trustpay',
                ],
                [
                    'id' => '456789',
                    'gateway' => 'unlimit',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/tokenize/customers/31e80148-746c-11e8-ad82-000d3a2b9844'
payload = {
    "first_name": "John",
    "last_name": "Doe",
    "jp_fullname": "山田 太郎",
    "street": "123 Maple Street",
    "city": "London",
    "state": "CA",
    "post_code": "94107",
    "country": "GB",
    "email": "john.doe@example.com",
    "phone_code": "+44",
    "phone": "5551234567",
    "reference_id": "ABC123XYZ",
    "date_of_birth": "2021-10-20",
    "legal_entity": "PRIVATE",
    "identifiers": [
        {
            "id": "123456",
            "gateway": "trustpay"
        },
        {
            "id": "456789",
            "gateway": "unlimit"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "first_name": "John",
    "last_name": "Doe",
    "jp_fullname": "山田 太郎",
    "street": "123 Maple Street",
    "city": "London",
    "state": null,
    "post_code": "94107",
    "country": "GB",
    "phone_code": "+44",
    "phone": "5551234567",
    "email": "john.doe@example.com",
    "reference_id": "ABC123XYZ",
    "date_of_birth": "2021-10-20",
    "legal_entity": "PRIVATE",
    "status": "Active",
    "created": "2024-06-04T10:06:57.000000Z",
    "updated": "2024-06-04T10:06:57.000000Z",
    "identifiers": [
        {
            "id": "123456",
            "gateway": "trustpay",
            "created": "2024-06-04T10:06:57.000000Z",
            "updated": "2024-06-04T10:06:57.000000Z"
        },
        {
            "id": "456789",
            "gateway": "unlimit",
            "created": "2024-06-04T10:06:57.000000Z",
            "updated": "2024-06-04T10:06:57.000000Z"
        }
    ],
    "banks": [
        {
            "bank_token": "c9c97d4a-d1c3-4aa4-abd2-a32436800437",
            "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
            "title": "Test bank account",
            "currency": "JPY",
            "beneficiary_name": "John Doe",
            "beneficiary_address": "123 Maple Street, London",
            "bank_name": "Metro Bank",
            "branch_name": "MetroBank",
            "bank_address": "123 Maple Street, London",
            "bank_code": "0100",
            "account_number": "1234567890",
            "iban": "GB23MBTC60161331926819",
            "bic": "MBTCPHMMXXX",
            "account_type": "checking",
            "bank_clearing_system_code": "SGIBG",
            "bank_clearing_system_id": "1234567"
        }
    ]
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Invalid currency",
    "code": 100003
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://secure.staging.paypipes.net/api/v2/customer/31e80148-746c-11e8-ad82-000d3a2b9844" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/customer/31e80148-746c-11e8-ad82-000d3a2b9844"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/customer/31e80148-746c-11e8-ad82-000d3a2b9844';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/customer/31e80148-746c-11e8-ad82-000d3a2b9844'
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200, Successful response):

{
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "first_name": "John",
    "last_name": "Doe",
    "jp_fullname": "山田 太郎",
    "street": "123 Maple Street",
    "city": "London",
    "state": null,
    "post_code": "94107",
    "country": "GB",
    "phone_code": "+44",
    "phone": "5551234567",
    "email": "john.doe@example.com",
    "reference_id": "ABC123XYZ",
    "date_of_birth": "2021-10-20",
    "legal_entity": "PRIVATE",
    "status": "Active",
    "created": "2024-06-04T10:06:57.000000Z",
    "updated": "2024-06-04T10:06:57.000000Z",
    "identifiers": [
        {
            "id": "123456",
            "gateway": "trustpay",
            "created": "2024-06-04T10:06:57.000000Z",
            "updated": "2024-06-04T10:06:57.000000Z"
        },
        {
            "id": "456789",
            "gateway": "unlimit",
            "created": "2024-06-04T10:06:57.000000Z",
            "updated": "2024-06-04T10:06:57.000000Z"
        }
    ],
    "banks": [
        {
            "bank_token": "a6a6509b-26dc-49cc-b0e6-92c5d6eede36",
            "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
            "title": "Bank Account",
            "currency": "USD",
            "beneficiary_name": "John Doe",
            "beneficiary_address": "123 Maple Street, London",
            "bank_name": "Metro Bank",
            "branch_name": "MetroBank",
            "bank_address": "123 Maple Street, London",
            "bank_code": "0100",
            "account_number": "789456123",
            "iban": "GB23MBTC60161331926819",
            "bic": "MBTCPHMMXXX",
            "account_type": "current",
            "bank_clearing_system_code": "SGIBG",
            "bank_clearing_system_id": "1234567"
        }
    ]
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (410, Error response):

{
    "error": "Transaction has expired (Transaction ID: #ID)",
    "code": 200037
}
 

Example response (422, Error response):

{
    "error": "Invalid currency",
    "code": 100003
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://secure.staging.paypipes.net/api/v2/tokenize/banks" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"customer_token\": \"496d8b1f-916e-4f79-bab6-a09a223ecffb\",
    \"title\": \"Bank Account\",
    \"currency\": \"USD\",
    \"beneficiary_name\": \"John Doe\",
    \"beneficiary_address\": \"123 Maple Street, London\",
    \"bank_name\": \"Metro Bank\",
    \"branch_name\": \"MetroBank\",
    \"bank_address\": \"123 Maple Street, London\",
    \"bank_code\": \"0100\",
    \"bank_country\": \"CZ\",
    \"account_number\": 789456123,
    \"iban\": \"GB23MBTC60161331926819\",
    \"bic\": \"MBTCPHMMXXX\",
    \"account_type\": \"current\",
    \"bank_clearing_system_code\": \"SGIBG\",
    \"bank_clearing_system_id\": \"1234567\"
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/tokenize/banks"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "title": "Bank Account",
    "currency": "USD",
    "beneficiary_name": "John Doe",
    "beneficiary_address": "123 Maple Street, London",
    "bank_name": "Metro Bank",
    "branch_name": "MetroBank",
    "bank_address": "123 Maple Street, London",
    "bank_code": "0100",
    "bank_country": "CZ",
    "account_number": 789456123,
    "iban": "GB23MBTC60161331926819",
    "bic": "MBTCPHMMXXX",
    "account_type": "current",
    "bank_clearing_system_code": "SGIBG",
    "bank_clearing_system_id": "1234567"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/tokenize/banks';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'customer_token' => '496d8b1f-916e-4f79-bab6-a09a223ecffb',
            'title' => 'Bank Account',
            'currency' => 'USD',
            'beneficiary_name' => 'John Doe',
            'beneficiary_address' => '123 Maple Street, London',
            'bank_name' => 'Metro Bank',
            'branch_name' => 'MetroBank',
            'bank_address' => '123 Maple Street, London',
            'bank_code' => '0100',
            'bank_country' => 'CZ',
            'account_number' => 789456123.0,
            'iban' => 'GB23MBTC60161331926819',
            'bic' => 'MBTCPHMMXXX',
            'account_type' => 'current',
            'bank_clearing_system_code' => 'SGIBG',
            'bank_clearing_system_id' => '1234567',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/tokenize/banks'
payload = {
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "title": "Bank Account",
    "currency": "USD",
    "beneficiary_name": "John Doe",
    "beneficiary_address": "123 Maple Street, London",
    "bank_name": "Metro Bank",
    "branch_name": "MetroBank",
    "bank_address": "123 Maple Street, London",
    "bank_code": "0100",
    "bank_country": "CZ",
    "account_number": 789456123,
    "iban": "GB23MBTC60161331926819",
    "bic": "MBTCPHMMXXX",
    "account_type": "current",
    "bank_clearing_system_code": "SGIBG",
    "bank_clearing_system_id": "1234567"
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (201, Successful response):

{
    "bank_token": "a6a6509b-26dc-49cc-b0e6-92c5d6eede36",
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "title": "Bank Account",
    "currency": "USD",
    "beneficiary_name": "John Doe",
    "beneficiary_address": "123 Maple Street, London",
    "bank_name": "Metro Bank",
    "branch_name": "MetroBank",
    "bank_address": "123 Maple Street, London",
    "bank_code": "0100",
    "bank_country": "CZ",
    "account_number": "789456123",
    "iban": "GB23MBTC60161331926819",
    "bic": "MBTCPHMMXXX",
    "account_type": "current",
    "bank_clearing_system_code": "SGIBG",
    "bank_clearing_system_id": "1234567"
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (422, Error response):

{
    "error": "Invalid currency",
    "code": 100003
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PATCH \
    "https://secure.staging.paypipes.net/api/v2/tokenize/banks/a6a6509b-26dc-49cc-b0e6-92c5d6eede36" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)" \
    --data "{
    \"customer_token\": \"496d8b1f-916e-4f79-bab6-a09a223ecffb\",
    \"title\": \"Bank Account\",
    \"currency\": \"USD\",
    \"beneficiary_name\": \"John Doe\",
    \"beneficiary_address\": \"123 Maple Street, London\",
    \"bank_name\": \"Metro Bank\",
    \"branch_name\": \"MetroBank\",
    \"bank_address\": \"123 Maple Street, London\",
    \"bank_code\": \"0100\",
    \"bank_country\": \"CZ\",
    \"account_number\": 789456123,
    \"iban\": \"GB23MBTC60161331926819\",
    \"bic\": \"MBTCPHMMXXX\",
    \"account_type\": \"current\",
    \"bank_clearing_system_code\": \"SGIBG\",
    \"bank_clearing_system_id\": \"1234567\"
}"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/tokenize/banks/a6a6509b-26dc-49cc-b0e6-92c5d6eede36"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

let body = {
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "title": "Bank Account",
    "currency": "USD",
    "beneficiary_name": "John Doe",
    "beneficiary_address": "123 Maple Street, London",
    "bank_name": "Metro Bank",
    "branch_name": "MetroBank",
    "bank_address": "123 Maple Street, London",
    "bank_code": "0100",
    "bank_country": "CZ",
    "account_number": 789456123,
    "iban": "GB23MBTC60161331926819",
    "bic": "MBTCPHMMXXX",
    "account_type": "current",
    "bank_clearing_system_code": "SGIBG",
    "bank_clearing_system_id": "1234567"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/tokenize/banks/a6a6509b-26dc-49cc-b0e6-92c5d6eede36';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
        'json' => [
            'customer_token' => '496d8b1f-916e-4f79-bab6-a09a223ecffb',
            'title' => 'Bank Account',
            'currency' => 'USD',
            'beneficiary_name' => 'John Doe',
            'beneficiary_address' => '123 Maple Street, London',
            'bank_name' => 'Metro Bank',
            'branch_name' => 'MetroBank',
            'bank_address' => '123 Maple Street, London',
            'bank_code' => '0100',
            'bank_country' => 'CZ',
            'account_number' => 789456123.0,
            'iban' => 'GB23MBTC60161331926819',
            'bic' => 'MBTCPHMMXXX',
            'account_type' => 'current',
            'bank_clearing_system_code' => 'SGIBG',
            'bank_clearing_system_id' => '1234567',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/tokenize/banks/a6a6509b-26dc-49cc-b0e6-92c5d6eede36'
payload = {
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "title": "Bank Account",
    "currency": "USD",
    "beneficiary_name": "John Doe",
    "beneficiary_address": "123 Maple Street, London",
    "bank_name": "Metro Bank",
    "branch_name": "MetroBank",
    "bank_address": "123 Maple Street, London",
    "bank_code": "0100",
    "bank_country": "CZ",
    "account_number": 789456123,
    "iban": "GB23MBTC60161331926819",
    "bic": "MBTCPHMMXXX",
    "account_type": "current",
    "bank_clearing_system_code": "SGIBG",
    "bank_clearing_system_id": "1234567"
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Example response (200, Successful response):

{
    "bank_token": "a6a6509b-26dc-49cc-b0e6-92c5d6eede36",
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "title": "Bank Account",
    "currency": "USD",
    "beneficiary_name": "John Doe",
    "beneficiary_address": "123 Maple Street, London",
    "bank_name": "Metro Bank",
    "branch_name": "MetroBank",
    "bank_address": "123 Maple Street, London",
    "bank_code": "0100",
    "bank_country": "CZ",
    "account_number": "789456123",
    "iban": "GB23MBTC60161331926819",
    "bic": "MBTCPHMMXXX",
    "account_type": "current",
    "bank_clearing_system_code": "SGIBG",
    "bank_clearing_system_id": "1234567"
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (422, Error response):

{
    "error": "Invalid currency",
    "code": 100003
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://secure.staging.paypipes.net/api/v2/bank/a6a6509b-26dc-49cc-b0e6-92c5d6eede36" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json (or application/x-www-form-url-encoded)"

const url = new URL(
    "https://secure.staging.paypipes.net/api/v2/bank/a6a6509b-26dc-49cc-b0e6-92c5d6eede36"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json (or application/x-www-form-url-encoded)",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://secure.staging.paypipes.net/api/v2/bank/a6a6509b-26dc-49cc-b0e6-92c5d6eede36';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json (or application/x-www-form-url-encoded)',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://secure.staging.paypipes.net/api/v2/bank/a6a6509b-26dc-49cc-b0e6-92c5d6eede36'
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json (or application/x-www-form-url-encoded)'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200, Successful response):

{
    "bank_token": "a6a6509b-26dc-49cc-b0e6-92c5d6eede36",
    "customer_token": "496d8b1f-916e-4f79-bab6-a09a223ecffb",
    "title": "Bank Account",
    "currency": "USD",
    "beneficiary_name": "John Doe",
    "beneficiary_address": "123 Maple Street, London",
    "bank_name": "Metro Bank",
    "branch_name": "MetroBank",
    "bank_address": "123 Maple Street, London",
    "bank_code": "0100",
    "account_number": "789456123",
    "iban": "GB23MBTC60161331926819",
    "bic": "MBTCPHMMXXX",
    "account_type": "current",
    "bank_clearing_system_code": "SGIBG",
    "bank_clearing_system_id": "1234567"
}
 

Example response (400, Error response):

{
    "error": "Bad request",
    "code": 200000
}
 

Example response (401, Error response):

{
    "error": "Unauthenticated",
    "code": 100001
}
 

Example response (403, Error response):

{
    "error": "Unauthorized",
    "code": 100004
}
 

Example response (404, Error response):

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

Example response (405, Error response):

{
    "error": "The specified method for the request is invalid",
    "code": 200008
}
 

Example response (422, Error response):

{
    "error": "Invalid currency",
    "code": 100003
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.