Transaction

get

List all API error logs for payment intents owned by the authenticated user. Supports searching by payment intent ID, transaction_ref, or client_ref, and filtering by date range.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

from_datestringOptional

Filter logs from this date (YYYY-MM-DD)

searchstringOptional

Search by payment intent ID, transaction_ref, or client_ref

to_datestringOptional

Filter logs up to this date (YYYY-MM-DD)

Responses

200

List of API error logs for the authenticated user

application/json

Serializer for Payment Intent API Error Log entries.

idstring · uuidRead-onlyRequired

payment_intentstring · uuid · nullableRead-onlyRequired

Payment intent if it was created, null if creation failed

transaction_refstringRead-onlyRequired

Transaction reference for cases where payment intent doesn't exist

client_refstringRead-onlyRequired

Client reference for cases where payment intent doesn't exist

error_typestringRead-onlyRequired

Exception class name (e.g., APIHTTPError)

error_messagestringRead-onlyRequired

Exception message

status_codeinteger · nullableRead-onlyRequired

HTTP status code if available (from APIHTTPError)

response_dataany · nullableRead-onlyRequired

API response data if available

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

get

/v1/transaction/api_errors/

GET /v1/transaction/api_errors/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

List of API error logs for the authenticated user

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "payment_intent": "123e4567-e89b-12d3-a456-426614174000",
    "transaction_ref": "text",
    "client_ref": "text",
    "error_type": "text",
    "error_message": "text",
    "status_code": 1,
    "response_data": null,
    "created": "2026-03-27T22:18:45.853Z",
    "modified": "2026-03-27T22:18:45.853Z"
  }
]

get

List all callback logs for payment intents owned by the authenticated user. Supports searching by payment intent ID and filtering by date range.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

from_datestringOptional

Filter logs from this date (YYYY-MM-DD)

searchstringOptional

Search by payment intent ID

to_datestringOptional

Filter logs up to this date (YYYY-MM-DD)

Responses

200

List of callback logs for the authenticated user

application/json

Serializer for Payment Intent Callback Log entries.

idstring · uuidRead-onlyRequired

payment_intentstring · uuidRead-onlyRequired

status_codeintegerRead-onlyRequired

HTTP status code from the callback response

response_headersanyRead-onlyRequired

Response headers from the callback

response_jsonany · nullableRead-onlyRequired

JSON response body if content-type is JSON

response_textstring · nullableRead-onlyRequired

Text response body for non-JSON responses

endpointstring · uriRead-onlyRequired

The callback endpoint that was called

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

get

/v1/transaction/callback_logs/

GET /v1/transaction/callback_logs/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

List of callback logs for the authenticated user

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "payment_intent": "123e4567-e89b-12d3-a456-426614174000",
    "status_code": 1,
    "response_headers": null,
    "response_json": null,
    "response_text": "text",
    "endpoint": "https://example.com",
    "created": "2026-03-27T22:18:45.853Z",
    "modified": "2026-03-27T22:18:45.853Z"
  }
]

get

This endpoint provides an overview of the dashboard data including total payment intents, total amount, and recent payment intents.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

endstringOptional

End date for filtering (YYYY-MM-DD)

startstringOptional

Start date for filtering (YYYY-MM-DD)

Responses

200

Dashboard data for UI

application/json

get

/v1/transaction/dashboard/

GET /v1/transaction/dashboard/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Dashboard data for UI

{
  "stats": {
    "revenue": [
      {
        "date": "2026-03-27",
        "total_amount": "text"
      }
    ],
    "fees": [
      {
        "date": "2026-03-27",
        "total_amount": "text"
      }
    ]
  },
  "countries": [
    {
      "country": "AF",
      "count": 1,
      "total": "text"
    }
  ],
  "payments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transaction_ref": "text",
      "client_ref": "text",
      "first_name": "text",
      "last_name": "text",
      "email": "[email protected]",
      "phone": "text",
      "address": "text",
      "amount": "text",
      "currency": "text",
      "base_amount": "text",
      "base_currency": "text",
      "method": "card",
      "payment_link": "text",
      "payment": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "amount": "text",
          "currency": "text",
          "base_amount": "text",
          "base_currency": "text",
          "fee": "text",
          "refunded": "text",
          "status": "pending",
          "refund": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "amount": "text",
              "currency": "text",
              "payment": "123e4567-e89b-12d3-a456-426614174000",
              "gateway_id": "text",
              "created": "2026-03-27T22:18:45.853Z"
            }
          ],
          "created": "2026-03-27T22:18:45.853Z"
        }
      ],
      "actions": null,
      "metadata": null,
      "order_items": null,
      "route_id": "text",
      "created": "2026-03-27T22:18:45.853Z"
    }
  ]
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

pageintegerOptional

A page number within the paginated result set.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

get

/v1/transaction/payment/

GET /v1/transaction/payment/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "currency": "text",
      "base_amount": "text",
      "base_currency": "text",
      "fee": "text",
      "refunded": "text",
      "status": "pending",
      "refund": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "amount": "text",
          "currency": "text",
          "payment": "123e4567-e89b-12d3-a456-426614174000",
          "gateway_id": "text",
          "created": "2026-03-27T22:18:45.853Z"
        }
      ],
      "created": "2026-03-27T22:18:45.853Z"
    }
  ]
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

amountstring · decimalRequiredPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

currencystringRead-onlyRequired

base_amountstring · decimalOptionalPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

base_currencystringRead-onlyRequired

feestringRead-onlyRequired

refundedstring · decimalOptionalPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

statusstring · enumOptional

pending - Pending
partial - Partially Paid
success - Success
failed - Failed
canceled - Canceled
expired - Expired
authorized - Authorized
refunded - Refunded
partial_refunded - Partially Refunded
disputed - Disputed
disputed_won - Disputed - Won
disputed_lost - Disputed - Lost
disputed_close - Disputed - Closed

Possible values:

createdstring · date-timeRead-onlyRequired

get

/v1/transaction/payment/{id}/

GET /v1/transaction/payment/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": "text",
  "currency": "text",
  "base_amount": "text",
  "base_currency": "text",
  "fee": "text",
  "refunded": "text",
  "status": "pending",
  "refund": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "currency": "text",
      "payment": "123e4567-e89b-12d3-a456-426614174000",
      "gateway_id": "text",
      "created": "2026-03-27T22:18:45.853Z"
    }
  ],
  "created": "2026-03-27T22:18:45.853Z"
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

client_emailstringOptional

client_refstringOptional

domainstringOptional

gateway_idstringOptional

pageintegerOptional

A page number within the paginated result set.

route_idstringOptional

Filter by routing rule UUID used for the payment intent

searchstringOptional

A search term.

transaction_refstringOptional

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

get

/v1/transaction/payment_intent/

GET /v1/transaction/payment_intent/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transaction_ref": "text",
      "client_ref": "text",
      "first_name": "text",
      "last_name": "text",
      "email": "[email protected]",
      "phone": "text",
      "address": "text",
      "amount": "text",
      "currency": "text",
      "base_amount": "text",
      "base_currency": "text",
      "method": "card",
      "payment_link": "text",
      "payment": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "amount": "text",
          "currency": "text",
          "base_amount": "text",
          "base_currency": "text",
          "fee": "text",
          "refunded": "text",
          "status": "pending",
          "refund": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "amount": "text",
              "currency": "text",
              "payment": "123e4567-e89b-12d3-a456-426614174000",
              "gateway_id": "text",
              "created": "2026-03-27T22:18:45.853Z"
            }
          ],
          "created": "2026-03-27T22:18:45.853Z"
        }
      ],
      "actions": null,
      "metadata": null,
      "order_items": null,
      "route_id": "text",
      "created": "2026-03-27T22:18:45.853Z"
    }
  ]
}

post

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

transaction_refstring · min: 1 · max: 128Required

client_refstring · min: 1 · max: 128Required

amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

amount_currencystring · enumRequired

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

methodstring · enumOptional

card - Card
crypto - Crypto
wire - Wire
paypal - Paypal
klarna - Klarna
ideal - Ideal
bancontact - Bancontact
trustly - Trustly

Possible values:

metadataanyOptional

force_routestring · uuidOptional

Responses

201

The created payment intent

application/json

post

/v1/transaction/payment_intent/

POST /v1/transaction/payment_intent/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 698

{
  "transaction_ref": "text",
  "client_ref": "text",
  "amount": "text",
  "amount_currency": "AED",
  "method": "card",
  "card": {
    "number": "text",
    "exp_month": "text",
    "exp_year": "text",
    "cvc": "text"
  },
  "customer": {
    "first_name": "text",
    "last_name": "text",
    "email": "[email protected]",
    "phone": "text"
  },
  "address": {
    "street": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "AF"
  },
  "session": {
    "ip_address": "text",
    "user_agent": "text"
  },
  "callback": {
    "notification_url": "https://example.com",
    "return_url": "https://example.com",
    "cancel_url": "https://example.com"
  },
  "metadata": null,
  "force_route": "123e4567-e89b-12d3-a456-426614174000",
  "order_items": [
    {
      "name": "text",
      "description": "text",
      "quantity": 1,
      "unit_price": "text",
      "sku": "text"
    }
  ]
}

201

The created payment intent

{
  "id": 1,
  "client_ref": "text",
  "payment_link": "https://example.com"
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

transaction_refstring · max: 255Required

client_refstring · max: 255Required

first_namestring · max: 255 · nullableOptional

last_namestring · max: 255 · nullableOptional

emailstring · email · max: 254 · nullableOptional

phonestring · max: 32 · nullableOptional

addressstringRead-onlyRequired

amountstring · decimalRequiredPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

currencystringRead-onlyRequired

base_amountstring · decimalOptionalPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

base_currencystringRead-onlyRequired

methodstring · enumOptional

card - Card
crypto - Crypto
wire - Wire
paypal - Paypal
klarna - Klarna
ideal - Ideal
bancontact - Bancontact
trustly - Trustly

Possible values:

payment_linkstringRead-onlyRequired

actionsanyOptional

metadataanyOptional

order_itemsanyOptional

List of order items with name, description, quantity, unit_price, and sku

route_idstringRead-onlyRequired

createdstring · date-timeRead-onlyRequired

get

/v1/transaction/payment_intent/{id}/

GET /v1/transaction/payment_intent/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "transaction_ref": "text",
  "client_ref": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "address": "text",
  "amount": "text",
  "currency": "text",
  "base_amount": "text",
  "base_currency": "text",
  "method": "card",
  "payment_link": "text",
  "payment": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "currency": "text",
      "base_amount": "text",
      "base_currency": "text",
      "fee": "text",
      "refunded": "text",
      "status": "pending",
      "refund": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "amount": "text",
          "currency": "text",
          "payment": "123e4567-e89b-12d3-a456-426614174000",
          "gateway_id": "text",
          "created": "2026-03-27T22:18:45.853Z"
        }
      ],
      "created": "2026-03-27T22:18:45.853Z"
    }
  ],
  "actions": null,
  "metadata": null,
  "order_items": null,
  "route_id": "text",
  "created": "2026-03-27T22:18:45.853Z"
}

get

List API error logs for a specific payment intent. Only accessible by the owner of the payment intent.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

pkstringRequired

UUID of the payment intent

Query parameters

pageintegerOptional

A page number within the paginated result set.

Responses

200

List of API error logs for the payment intent

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

404

Payment intent not found or access denied

get

/v1/transaction/payment_intent/{id}/api_errors/

GET /v1/transaction/payment_intent/{id}/api_errors/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "payment_intent": "123e4567-e89b-12d3-a456-426614174000",
      "transaction_ref": "text",
      "client_ref": "text",
      "error_type": "text",
      "error_message": "text",
      "status_code": 1,
      "response_data": null,
      "created": "2026-03-27T22:18:45.853Z",
      "modified": "2026-03-27T22:18:45.853Z"
    }
  ]
}

get

List callback logs for a specific payment intent. Only accessible by the owner of the payment intent.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

pkstringRequired

UUID of the payment intent

Query parameters

pageintegerOptional

A page number within the paginated result set.

Responses

200

List of callback logs for the payment intent

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

404

Payment intent not found or access denied

get

/v1/transaction/payment_intent/{id}/callback_logs/

GET /v1/transaction/payment_intent/{id}/callback_logs/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "payment_intent": "123e4567-e89b-12d3-a456-426614174000",
      "status_code": 1,
      "response_headers": null,
      "response_json": null,
      "response_text": "text",
      "endpoint": "https://example.com",
      "created": "2026-03-27T22:18:45.853Z",
      "modified": "2026-03-27T22:18:45.853Z"
    }
  ]
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

pageintegerOptional

A page number within the paginated result set.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

get

/v1/transaction/payment_link/

GET /v1/transaction/payment_link/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "client_ref": "text",
      "amount": "text",
      "amount_currency": "AED",
      "first_name": "text",
      "last_name": "text",
      "email": "[email protected]",
      "phone": "text",
      "country": "AF",
      "payment_link": "text",
      "modified": "2026-03-27T22:18:45.853Z",
      "created": "2026-03-27T22:18:45.853Z"
    }
  ]
}

post

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

client_refstring · min: 1 · max: 255Required

amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

amount_currencystring · enumRequired

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

first_namestring · max: 255 · nullableOptional

last_namestring · max: 255 · nullableOptional

emailstring · email · max: 254 · nullableOptional

phonestring · max: 32 · nullableOptional

countrystring · enumRequired

AF - Afghanistan
AX - Åland Islands
AL - Albania
DZ - Algeria
AS - American Samoa
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarctica
AG - Antigua and Barbuda
AR - Argentina
AM - Armenia
AW - Aruba
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas (The)
BH - Bahrain
BD - Bangladesh
BB - Barbados
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BA - Bosnia and Herzegovina
BW - Botswana
BV - Bouvet Island
BR - Brazil
IO - British Indian Ocean Territory
BN - Brunei
BG - Bulgaria
BF - Burkina Faso
BI - Burundi
CV - Cabo Verde
KH - Cambodia
CM - Cameroon
CA - Canada
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CX - Christmas Island
CC - Cocos (Keeling) Islands
CO - Colombia
KM - Comoros
CG - Congo
CK - Cook Islands
CR - Costa Rica
CI - Côte d'Ivoire
HR - Croatia
CU - Cuba
CW - Curaçao
CY - Cyprus
CZ - Czechia
CD - Democratic Republic of the Congo
DK - Denmark
DJ - Djibouti
DM - Dominica
DO - Dominican Republic
EC - Ecuador
EG - Egypt
SV - El Salvador
GQ - Equatorial Guinea
ER - Eritrea
EE - Estonia
SZ - Eswatini
ET - Ethiopia
FK - Falkland Islands (Malvinas)
FO - Faroe Islands
FJ - Fiji
FI - Finland
FR - France
GF - French Guiana
PF - French Polynesia
TF - French Southern Territories
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GL - Greenland
GD - Grenada
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard Island and McDonald Islands
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IR - Iran
IQ - Iraq
IE - Ireland
IM - Isle of Man
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JE - Jersey
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KI - Kiribati
KW - Kuwait
KG - Kyrgyzstan
LA - Laos
LV - Latvia
LB - Lebanon
LS - Lesotho
LR - Liberia
LY - Libya
LI - Liechtenstein
LT - Lithuania
LU - Luxembourg
MO - Macao
MG - Madagascar
MW - Malawi
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MH - Marshall Islands
MQ - Martinique
MR - Mauritania
MU - Mauritius
YT - Mayotte
MX - Mexico
FM - Micronesia
MD - Moldova
MC - Monaco
MN - Mongolia
ME - Montenegro
MS - Montserrat
MA - Morocco
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NL - Netherlands
NC - New Caledonia
NZ - New Zealand
NI - Nicaragua
NE - Niger
NG - Nigeria
NU - Niue
NF - Norfolk Island
KP - North Korea
MK - North Macedonia
MP - Northern Mariana Islands
NO - Norway
OM - Oman
PK - Pakistan
PW - Palau
PS - Palestine
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PN - Pitcairn
PL - Poland
PT - Portugal
PR - Puerto Rico
QA - Qatar
RE - Réunion
RO - Romania
RU - Russia
RW - Rwanda
BL - Saint Barthélemy
SH - Saint Helena
KN - Saint Kitts and Nevis
LC - Saint Lucia
MF - Saint Martin (French part)
PM - Saint Pierre and Miquelon
VC - Saint Vincent and the Grenadines
WS - Samoa
SM - San Marino
ST - Sao Tome and Principe
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SC - Seychelles
SL - Sierra Leone
SG - Singapore
SX - Sint Maarten (Dutch part)
SK - Slovakia
SI - Slovenia
SB - Solomon Islands
SO - Somalia
ZA - South Africa
GS - South Georgia
KR - South Korea
SS - South Sudan
ES - Spain
LK - Sri Lanka
SD - Sudan
SR - Suriname
SJ - Svalbard and Jan Mayen
SE - Sweden
CH - Switzerland
SY - Syria
TW - Taiwan
TJ - Tajikistan
TZ - Tanzania
TH - Thailand
TL - Timor-Leste
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Türkiye
TM - Turkmenistan
TC - Turks and Caicos Islands
TV - Tuvalu
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
GB - United Kingdom
UM - United States Minor Outlying Islands
US - United States of America
UY - Uruguay
UZ - Uzbekistan
VU - Vanuatu
VA - Vatican City
VE - Venezuela
VN - Vietnam
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
WF - Wallis and Futuna
EH - Western Sahara
YE - Yemen
ZM - Zambia
ZW - Zimbabwe

Possible values:

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

client_refstring · max: 255Required

amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

amount_currencystring · enumRequired

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

first_namestring · max: 255 · nullableOptional

last_namestring · max: 255 · nullableOptional

emailstring · email · max: 254 · nullableOptional

phonestring · max: 32 · nullableOptional

countrystring · enumRequired

AF - Afghanistan
AX - Åland Islands
AL - Albania
DZ - Algeria
AS - American Samoa
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarctica
AG - Antigua and Barbuda
AR - Argentina
AM - Armenia
AW - Aruba
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas (The)
BH - Bahrain
BD - Bangladesh
BB - Barbados
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BA - Bosnia and Herzegovina
BW - Botswana
BV - Bouvet Island
BR - Brazil
IO - British Indian Ocean Territory
BN - Brunei
BG - Bulgaria
BF - Burkina Faso
BI - Burundi
CV - Cabo Verde
KH - Cambodia
CM - Cameroon
CA - Canada
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CX - Christmas Island
CC - Cocos (Keeling) Islands
CO - Colombia
KM - Comoros
CG - Congo
CK - Cook Islands
CR - Costa Rica
CI - Côte d'Ivoire
HR - Croatia
CU - Cuba
CW - Curaçao
CY - Cyprus
CZ - Czechia
CD - Democratic Republic of the Congo
DK - Denmark
DJ - Djibouti
DM - Dominica
DO - Dominican Republic
EC - Ecuador
EG - Egypt
SV - El Salvador
GQ - Equatorial Guinea
ER - Eritrea
EE - Estonia
SZ - Eswatini
ET - Ethiopia
FK - Falkland Islands (Malvinas)
FO - Faroe Islands
FJ - Fiji
FI - Finland
FR - France
GF - French Guiana
PF - French Polynesia
TF - French Southern Territories
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GL - Greenland
GD - Grenada
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard Island and McDonald Islands
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IR - Iran
IQ - Iraq
IE - Ireland
IM - Isle of Man
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JE - Jersey
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KI - Kiribati
KW - Kuwait
KG - Kyrgyzstan
LA - Laos
LV - Latvia
LB - Lebanon
LS - Lesotho
LR - Liberia
LY - Libya
LI - Liechtenstein
LT - Lithuania
LU - Luxembourg
MO - Macao
MG - Madagascar
MW - Malawi
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MH - Marshall Islands
MQ - Martinique
MR - Mauritania
MU - Mauritius
YT - Mayotte
MX - Mexico
FM - Micronesia
MD - Moldova
MC - Monaco
MN - Mongolia
ME - Montenegro
MS - Montserrat
MA - Morocco
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NL - Netherlands
NC - New Caledonia
NZ - New Zealand
NI - Nicaragua
NE - Niger
NG - Nigeria
NU - Niue
NF - Norfolk Island
KP - North Korea
MK - North Macedonia
MP - Northern Mariana Islands
NO - Norway
OM - Oman
PK - Pakistan
PW - Palau
PS - Palestine
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PN - Pitcairn
PL - Poland
PT - Portugal
PR - Puerto Rico
QA - Qatar
RE - Réunion
RO - Romania
RU - Russia
RW - Rwanda
BL - Saint Barthélemy
SH - Saint Helena
KN - Saint Kitts and Nevis
LC - Saint Lucia
MF - Saint Martin (French part)
PM - Saint Pierre and Miquelon
VC - Saint Vincent and the Grenadines
WS - Samoa
SM - San Marino
ST - Sao Tome and Principe
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SC - Seychelles
SL - Sierra Leone
SG - Singapore
SX - Sint Maarten (Dutch part)
SK - Slovakia
SI - Slovenia
SB - Solomon Islands
SO - Somalia
ZA - South Africa
GS - South Georgia
KR - South Korea
SS - South Sudan
ES - Spain
LK - Sri Lanka
SD - Sudan
SR - Suriname
SJ - Svalbard and Jan Mayen
SE - Sweden
CH - Switzerland
SY - Syria
TW - Taiwan
TJ - Tajikistan
TZ - Tanzania
TH - Thailand
TL - Timor-Leste
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Türkiye
TM - Turkmenistan
TC - Turks and Caicos Islands
TV - Tuvalu
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
GB - United Kingdom
UM - United States Minor Outlying Islands
US - United States of America
UY - Uruguay
UZ - Uzbekistan
VU - Vanuatu
VA - Vatican City
VE - Venezuela
VN - Vietnam
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
WF - Wallis and Futuna
EH - Western Sahara
YE - Yemen
ZM - Zambia
ZW - Zimbabwe

Possible values:

payment_linkstringRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

createdstring · date-timeRead-onlyRequired

post

/v1/transaction/payment_link/

POST /v1/transaction/payment_link/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "client_ref": "text",
  "amount": "text",
  "amount_currency": "AED",
  "first_name": "text",
  "last_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "country": "AF"
}

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "client_ref": "text",
  "amount": "text",
  "amount_currency": "AED",
  "first_name": "text",
  "last_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "country": "AF",
  "payment_link": "text",
  "modified": "2026-03-27T22:18:45.853Z",
  "created": "2026-03-27T22:18:45.853Z"
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

client_refstring · max: 255Required

amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

amount_currencystring · enumRequired

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

first_namestring · max: 255 · nullableOptional

last_namestring · max: 255 · nullableOptional

emailstring · email · max: 254 · nullableOptional

phonestring · max: 32 · nullableOptional

countrystring · enumRequired

AF - Afghanistan
AX - Åland Islands
AL - Albania
DZ - Algeria
AS - American Samoa
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarctica
AG - Antigua and Barbuda
AR - Argentina
AM - Armenia
AW - Aruba
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas (The)
BH - Bahrain
BD - Bangladesh
BB - Barbados
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BA - Bosnia and Herzegovina
BW - Botswana
BV - Bouvet Island
BR - Brazil
IO - British Indian Ocean Territory
BN - Brunei
BG - Bulgaria
BF - Burkina Faso
BI - Burundi
CV - Cabo Verde
KH - Cambodia
CM - Cameroon
CA - Canada
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CX - Christmas Island
CC - Cocos (Keeling) Islands
CO - Colombia
KM - Comoros
CG - Congo
CK - Cook Islands
CR - Costa Rica
CI - Côte d'Ivoire
HR - Croatia
CU - Cuba
CW - Curaçao
CY - Cyprus
CZ - Czechia
CD - Democratic Republic of the Congo
DK - Denmark
DJ - Djibouti
DM - Dominica
DO - Dominican Republic
EC - Ecuador
EG - Egypt
SV - El Salvador
GQ - Equatorial Guinea
ER - Eritrea
EE - Estonia
SZ - Eswatini
ET - Ethiopia
FK - Falkland Islands (Malvinas)
FO - Faroe Islands
FJ - Fiji
FI - Finland
FR - France
GF - French Guiana
PF - French Polynesia
TF - French Southern Territories
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GL - Greenland
GD - Grenada
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard Island and McDonald Islands
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IR - Iran
IQ - Iraq
IE - Ireland
IM - Isle of Man
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JE - Jersey
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KI - Kiribati
KW - Kuwait
KG - Kyrgyzstan
LA - Laos
LV - Latvia
LB - Lebanon
LS - Lesotho
LR - Liberia
LY - Libya
LI - Liechtenstein
LT - Lithuania
LU - Luxembourg
MO - Macao
MG - Madagascar
MW - Malawi
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MH - Marshall Islands
MQ - Martinique
MR - Mauritania
MU - Mauritius
YT - Mayotte
MX - Mexico
FM - Micronesia
MD - Moldova
MC - Monaco
MN - Mongolia
ME - Montenegro
MS - Montserrat
MA - Morocco
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NL - Netherlands
NC - New Caledonia
NZ - New Zealand
NI - Nicaragua
NE - Niger
NG - Nigeria
NU - Niue
NF - Norfolk Island
KP - North Korea
MK - North Macedonia
MP - Northern Mariana Islands
NO - Norway
OM - Oman
PK - Pakistan
PW - Palau
PS - Palestine
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PN - Pitcairn
PL - Poland
PT - Portugal
PR - Puerto Rico
QA - Qatar
RE - Réunion
RO - Romania
RU - Russia
RW - Rwanda
BL - Saint Barthélemy
SH - Saint Helena
KN - Saint Kitts and Nevis
LC - Saint Lucia
MF - Saint Martin (French part)
PM - Saint Pierre and Miquelon
VC - Saint Vincent and the Grenadines
WS - Samoa
SM - San Marino
ST - Sao Tome and Principe
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SC - Seychelles
SL - Sierra Leone
SG - Singapore
SX - Sint Maarten (Dutch part)
SK - Slovakia
SI - Slovenia
SB - Solomon Islands
SO - Somalia
ZA - South Africa
GS - South Georgia
KR - South Korea
SS - South Sudan
ES - Spain
LK - Sri Lanka
SD - Sudan
SR - Suriname
SJ - Svalbard and Jan Mayen
SE - Sweden
CH - Switzerland
SY - Syria
TW - Taiwan
TJ - Tajikistan
TZ - Tanzania
TH - Thailand
TL - Timor-Leste
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Türkiye
TM - Turkmenistan
TC - Turks and Caicos Islands
TV - Tuvalu
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
GB - United Kingdom
UM - United States Minor Outlying Islands
US - United States of America
UY - Uruguay
UZ - Uzbekistan
VU - Vanuatu
VA - Vatican City
VE - Venezuela
VN - Vietnam
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
WF - Wallis and Futuna
EH - Western Sahara
YE - Yemen
ZM - Zambia
ZW - Zimbabwe

Possible values:

payment_linkstringRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

createdstring · date-timeRead-onlyRequired

get

/v1/transaction/payment_link/{id}/

GET /v1/transaction/payment_link/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "client_ref": "text",
  "amount": "text",
  "amount_currency": "AED",
  "first_name": "text",
  "last_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "country": "AF",
  "payment_link": "text",
  "modified": "2026-03-27T22:18:45.853Z",
  "created": "2026-03-27T22:18:45.853Z"
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

pageintegerOptional

A page number within the paginated result set.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

get

/v1/transaction/refund/

GET /v1/transaction/refund/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "currency": "text",
      "payment": "123e4567-e89b-12d3-a456-426614174000",
      "gateway_id": "text",
      "created": "2026-03-27T22:18:45.853Z"
    }
  ]
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

amountstring · decimalRequiredPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

currencystringRead-onlyRequired

paymentstring · uuidRequired

gateway_idstring · max: 255Required

createdstring · date-timeRead-onlyRequired

get

/v1/transaction/refund/{id}/

GET /v1/transaction/refund/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": "text",
  "currency": "text",
  "payment": "123e4567-e89b-12d3-a456-426614174000",
  "gateway_id": "text",
  "created": "2026-03-27T22:18:45.853Z"
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

payment_methodstringRead-onlyRequired

gatewaystringRead-onlyRequired

integration_typestringRead-onlyRequired

prioritynumber · doubleRequired

Route priority. Higher numbers are processed first.

min_amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

max_amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

daily_quotastring · decimalOptional

Daily processing limit. Set it -1 for unlimited.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

used_quotastringRead-onlyRequired

countriesstring · enumRequired

AF - Afghanistan
AX - Åland Islands
AL - Albania
DZ - Algeria
AS - American Samoa
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarctica
AG - Antigua and Barbuda
AR - Argentina
AM - Armenia
AW - Aruba
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas (The)
BH - Bahrain
BD - Bangladesh
BB - Barbados
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BA - Bosnia and Herzegovina
BW - Botswana
BV - Bouvet Island
BR - Brazil
IO - British Indian Ocean Territory
BN - Brunei
BG - Bulgaria
BF - Burkina Faso
BI - Burundi
CV - Cabo Verde
KH - Cambodia
CM - Cameroon
CA - Canada
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CX - Christmas Island
CC - Cocos (Keeling) Islands
CO - Colombia
KM - Comoros
CG - Congo
CK - Cook Islands
CR - Costa Rica
CI - Côte d'Ivoire
HR - Croatia
CU - Cuba
CW - Curaçao
CY - Cyprus
CZ - Czechia
CD - Democratic Republic of the Congo
DK - Denmark
DJ - Djibouti
DM - Dominica
DO - Dominican Republic
EC - Ecuador
EG - Egypt
SV - El Salvador
GQ - Equatorial Guinea
ER - Eritrea
EE - Estonia
SZ - Eswatini
ET - Ethiopia
FK - Falkland Islands (Malvinas)
FO - Faroe Islands
FJ - Fiji
FI - Finland
FR - France
GF - French Guiana
PF - French Polynesia
TF - French Southern Territories
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GL - Greenland
GD - Grenada
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard Island and McDonald Islands
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IR - Iran
IQ - Iraq
IE - Ireland
IM - Isle of Man
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JE - Jersey
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KI - Kiribati
KW - Kuwait
KG - Kyrgyzstan
LA - Laos
LV - Latvia
LB - Lebanon
LS - Lesotho
LR - Liberia
LY - Libya
LI - Liechtenstein
LT - Lithuania
LU - Luxembourg
MO - Macao
MG - Madagascar
MW - Malawi
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MH - Marshall Islands
MQ - Martinique
MR - Mauritania
MU - Mauritius
YT - Mayotte
MX - Mexico
FM - Micronesia
MD - Moldova
MC - Monaco
MN - Mongolia
ME - Montenegro
MS - Montserrat
MA - Morocco
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NL - Netherlands
NC - New Caledonia
NZ - New Zealand
NI - Nicaragua
NE - Niger
NG - Nigeria
NU - Niue
NF - Norfolk Island
KP - North Korea
MK - North Macedonia
MP - Northern Mariana Islands
NO - Norway
OM - Oman
PK - Pakistan
PW - Palau
PS - Palestine
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PN - Pitcairn
PL - Poland
PT - Portugal
PR - Puerto Rico
QA - Qatar
RE - Réunion
RO - Romania
RU - Russia
RW - Rwanda
BL - Saint Barthélemy
SH - Saint Helena
KN - Saint Kitts and Nevis
LC - Saint Lucia
MF - Saint Martin (French part)
PM - Saint Pierre and Miquelon
VC - Saint Vincent and the Grenadines
WS - Samoa
SM - San Marino
ST - Sao Tome and Principe
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SC - Seychelles
SL - Sierra Leone
SG - Singapore
SX - Sint Maarten (Dutch part)
SK - Slovakia
SI - Slovenia
SB - Solomon Islands
SO - Somalia
ZA - South Africa
GS - South Georgia
KR - South Korea
SS - South Sudan
ES - Spain
LK - Sri Lanka
SD - Sudan
SR - Suriname
SJ - Svalbard and Jan Mayen
SE - Sweden
CH - Switzerland
SY - Syria
TW - Taiwan
TJ - Tajikistan
TZ - Tanzania
TH - Thailand
TL - Timor-Leste
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Türkiye
TM - Turkmenistan
TC - Turks and Caicos Islands
TV - Tuvalu
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
GB - United Kingdom
UM - United States Minor Outlying Islands
US - United States of America
UY - Uruguay
UZ - Uzbekistan
VU - Vanuatu
VA - Vatican City
VE - Venezuela
VN - Vietnam
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
WF - Wallis and Futuna
EH - Western Sahara
YE - Yemen
ZM - Zambia
ZW - Zimbabwe

Possible values:

labelstringRead-onlyRequired

enabledbooleanOptional

modifiedstring · date-timeRead-onlyRequired

createdstring · date-timeRead-onlyRequired

get

/v1/transaction/routing/

GET /v1/transaction/routing/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "payment_method": "text",
    "gateway": "text",
    "integration_type": "text",
    "priority": 1,
    "min_amount": "text",
    "max_amount": "text",
    "daily_quota": "text",
    "used_quota": "text",
    "countries": [
      "AF"
    ],
    "label": "text",
    "enabled": true,
    "modified": "2026-03-27T22:18:45.853Z",
    "created": "2026-03-27T22:18:45.853Z"
  }
]

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

payment_methodstringRead-onlyRequired

gatewaystringRead-onlyRequired

integration_typestringRead-onlyRequired

prioritynumber · doubleRequired

Route priority. Higher numbers are processed first.

min_amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

max_amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

daily_quotastring · decimalOptional

Daily processing limit. Set it -1 for unlimited.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

used_quotastringRead-onlyRequired

countriesstring · enumRequired

AF - Afghanistan
AX - Åland Islands
AL - Albania
DZ - Algeria
AS - American Samoa
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarctica
AG - Antigua and Barbuda
AR - Argentina
AM - Armenia
AW - Aruba
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas (The)
BH - Bahrain
BD - Bangladesh
BB - Barbados
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BA - Bosnia and Herzegovina
BW - Botswana
BV - Bouvet Island
BR - Brazil
IO - British Indian Ocean Territory
BN - Brunei
BG - Bulgaria
BF - Burkina Faso
BI - Burundi
CV - Cabo Verde
KH - Cambodia
CM - Cameroon
CA - Canada
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CX - Christmas Island
CC - Cocos (Keeling) Islands
CO - Colombia
KM - Comoros
CG - Congo
CK - Cook Islands
CR - Costa Rica
CI - Côte d'Ivoire
HR - Croatia
CU - Cuba
CW - Curaçao
CY - Cyprus
CZ - Czechia
CD - Democratic Republic of the Congo
DK - Denmark
DJ - Djibouti
DM - Dominica
DO - Dominican Republic
EC - Ecuador
EG - Egypt
SV - El Salvador
GQ - Equatorial Guinea
ER - Eritrea
EE - Estonia
SZ - Eswatini
ET - Ethiopia
FK - Falkland Islands (Malvinas)
FO - Faroe Islands
FJ - Fiji
FI - Finland
FR - France
GF - French Guiana
PF - French Polynesia
TF - French Southern Territories
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GL - Greenland
GD - Grenada
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard Island and McDonald Islands
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IR - Iran
IQ - Iraq
IE - Ireland
IM - Isle of Man
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JE - Jersey
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KI - Kiribati
KW - Kuwait
KG - Kyrgyzstan
LA - Laos
LV - Latvia
LB - Lebanon
LS - Lesotho
LR - Liberia
LY - Libya
LI - Liechtenstein
LT - Lithuania
LU - Luxembourg
MO - Macao
MG - Madagascar
MW - Malawi
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MH - Marshall Islands
MQ - Martinique
MR - Mauritania
MU - Mauritius
YT - Mayotte
MX - Mexico
FM - Micronesia
MD - Moldova
MC - Monaco
MN - Mongolia
ME - Montenegro
MS - Montserrat
MA - Morocco
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NL - Netherlands
NC - New Caledonia
NZ - New Zealand
NI - Nicaragua
NE - Niger
NG - Nigeria
NU - Niue
NF - Norfolk Island
KP - North Korea
MK - North Macedonia
MP - Northern Mariana Islands
NO - Norway
OM - Oman
PK - Pakistan
PW - Palau
PS - Palestine
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PN - Pitcairn
PL - Poland
PT - Portugal
PR - Puerto Rico
QA - Qatar
RE - Réunion
RO - Romania
RU - Russia
RW - Rwanda
BL - Saint Barthélemy
SH - Saint Helena
KN - Saint Kitts and Nevis
LC - Saint Lucia
MF - Saint Martin (French part)
PM - Saint Pierre and Miquelon
VC - Saint Vincent and the Grenadines
WS - Samoa
SM - San Marino
ST - Sao Tome and Principe
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SC - Seychelles
SL - Sierra Leone
SG - Singapore
SX - Sint Maarten (Dutch part)
SK - Slovakia
SI - Slovenia
SB - Solomon Islands
SO - Somalia
ZA - South Africa
GS - South Georgia
KR - South Korea
SS - South Sudan
ES - Spain
LK - Sri Lanka
SD - Sudan
SR - Suriname
SJ - Svalbard and Jan Mayen
SE - Sweden
CH - Switzerland
SY - Syria
TW - Taiwan
TJ - Tajikistan
TZ - Tanzania
TH - Thailand
TL - Timor-Leste
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Türkiye
TM - Turkmenistan
TC - Turks and Caicos Islands
TV - Tuvalu
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
GB - United Kingdom
UM - United States Minor Outlying Islands
US - United States of America
UY - Uruguay
UZ - Uzbekistan
VU - Vanuatu
VA - Vatican City
VE - Venezuela
VN - Vietnam
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
WF - Wallis and Futuna
EH - Western Sahara
YE - Yemen
ZM - Zambia
ZW - Zimbabwe

Possible values:

labelstringRead-onlyRequired

enabledbooleanOptional

modifiedstring · date-timeRead-onlyRequired

createdstring · date-timeRead-onlyRequired

get

/v1/transaction/routing/{id}/

GET /v1/transaction/routing/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "payment_method": "text",
  "gateway": "text",
  "integration_type": "text",
  "priority": 1,
  "min_amount": "text",
  "max_amount": "text",
  "daily_quota": "text",
  "used_quota": "text",
  "countries": [
    "AF"
  ],
  "label": "text",
  "enabled": true,
  "modified": "2026-03-27T22:18:45.853Z",
  "created": "2026-03-27T22:18:45.853Z"
}

put

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

Body

prioritynumber · doubleRequired

Route priority. Higher numbers are processed first.

min_amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

max_amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

daily_quotastring · decimalOptional

Daily processing limit. Set it -1 for unlimited.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

countriesstring · enumRequired

AF - Afghanistan
AX - Åland Islands
AL - Albania
DZ - Algeria
AS - American Samoa
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarctica
AG - Antigua and Barbuda
AR - Argentina
AM - Armenia
AW - Aruba
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas (The)
BH - Bahrain
BD - Bangladesh
BB - Barbados
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BA - Bosnia and Herzegovina
BW - Botswana
BV - Bouvet Island
BR - Brazil
IO - British Indian Ocean Territory
BN - Brunei
BG - Bulgaria
BF - Burkina Faso
BI - Burundi
CV - Cabo Verde
KH - Cambodia
CM - Cameroon
CA - Canada
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CX - Christmas Island
CC - Cocos (Keeling) Islands
CO - Colombia
KM - Comoros
CG - Congo
CK - Cook Islands
CR - Costa Rica
CI - Côte d'Ivoire
HR - Croatia
CU - Cuba
CW - Curaçao
CY - Cyprus
CZ - Czechia
CD - Democratic Republic of the Congo
DK - Denmark
DJ - Djibouti
DM - Dominica
DO - Dominican Republic
EC - Ecuador
EG - Egypt
SV - El Salvador
GQ - Equatorial Guinea
ER - Eritrea
EE - Estonia
SZ - Eswatini
ET - Ethiopia
FK - Falkland Islands (Malvinas)
FO - Faroe Islands
FJ - Fiji
FI - Finland
FR - France
GF - French Guiana
PF - French Polynesia
TF - French Southern Territories
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GL - Greenland
GD - Grenada
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard Island and McDonald Islands
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IR - Iran
IQ - Iraq
IE - Ireland
IM - Isle of Man
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JE - Jersey
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KI - Kiribati
KW - Kuwait
KG - Kyrgyzstan
LA - Laos
LV - Latvia
LB - Lebanon
LS - Lesotho
LR - Liberia
LY - Libya
LI - Liechtenstein
LT - Lithuania
LU - Luxembourg
MO - Macao
MG - Madagascar
MW - Malawi
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MH - Marshall Islands
MQ - Martinique
MR - Mauritania
MU - Mauritius
YT - Mayotte
MX - Mexico
FM - Micronesia
MD - Moldova
MC - Monaco
MN - Mongolia
ME - Montenegro
MS - Montserrat
MA - Morocco
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NL - Netherlands
NC - New Caledonia
NZ - New Zealand
NI - Nicaragua
NE - Niger
NG - Nigeria
NU - Niue
NF - Norfolk Island
KP - North Korea
MK - North Macedonia
MP - Northern Mariana Islands
NO - Norway
OM - Oman
PK - Pakistan
PW - Palau
PS - Palestine
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PN - Pitcairn
PL - Poland
PT - Portugal
PR - Puerto Rico
QA - Qatar
RE - Réunion
RO - Romania
RU - Russia
RW - Rwanda
BL - Saint Barthélemy
SH - Saint Helena
KN - Saint Kitts and Nevis
LC - Saint Lucia
MF - Saint Martin (French part)
PM - Saint Pierre and Miquelon
VC - Saint Vincent and the Grenadines
WS - Samoa
SM - San Marino
ST - Sao Tome and Principe
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SC - Seychelles
SL - Sierra Leone
SG - Singapore
SX - Sint Maarten (Dutch part)
SK - Slovakia
SI - Slovenia
SB - Solomon Islands
SO - Somalia
ZA - South Africa
GS - South Georgia
KR - South Korea
SS - South Sudan
ES - Spain
LK - Sri Lanka
SD - Sudan
SR - Suriname
SJ - Svalbard and Jan Mayen
SE - Sweden
CH - Switzerland
SY - Syria
TW - Taiwan
TJ - Tajikistan
TZ - Tanzania
TH - Thailand
TL - Timor-Leste
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Türkiye
TM - Turkmenistan
TC - Turks and Caicos Islands
TV - Tuvalu
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
GB - United Kingdom
UM - United States Minor Outlying Islands
US - United States of America
UY - Uruguay
UZ - Uzbekistan
VU - Vanuatu
VA - Vatican City
VE - Venezuela
VN - Vietnam
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
WF - Wallis and Futuna
EH - Western Sahara
YE - Yemen
ZM - Zambia
ZW - Zimbabwe

Possible values:

enabledbooleanOptional

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

payment_methodstringRead-onlyRequired

gatewaystringRead-onlyRequired

integration_typestringRead-onlyRequired

prioritynumber · doubleRequired

Route priority. Higher numbers are processed first.

min_amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

max_amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

daily_quotastring · decimalOptional

Daily processing limit. Set it -1 for unlimited.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

used_quotastringRead-onlyRequired

countriesstring · enumRequired

AF - Afghanistan
AX - Åland Islands
AL - Albania
DZ - Algeria
AS - American Samoa
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarctica
AG - Antigua and Barbuda
AR - Argentina
AM - Armenia
AW - Aruba
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas (The)
BH - Bahrain
BD - Bangladesh
BB - Barbados
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BA - Bosnia and Herzegovina
BW - Botswana
BV - Bouvet Island
BR - Brazil
IO - British Indian Ocean Territory
BN - Brunei
BG - Bulgaria
BF - Burkina Faso
BI - Burundi
CV - Cabo Verde
KH - Cambodia
CM - Cameroon
CA - Canada
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CX - Christmas Island
CC - Cocos (Keeling) Islands
CO - Colombia
KM - Comoros
CG - Congo
CK - Cook Islands
CR - Costa Rica
CI - Côte d'Ivoire
HR - Croatia
CU - Cuba
CW - Curaçao
CY - Cyprus
CZ - Czechia
CD - Democratic Republic of the Congo
DK - Denmark
DJ - Djibouti
DM - Dominica
DO - Dominican Republic
EC - Ecuador
EG - Egypt
SV - El Salvador
GQ - Equatorial Guinea
ER - Eritrea
EE - Estonia
SZ - Eswatini
ET - Ethiopia
FK - Falkland Islands (Malvinas)
FO - Faroe Islands
FJ - Fiji
FI - Finland
FR - France
GF - French Guiana
PF - French Polynesia
TF - French Southern Territories
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GL - Greenland
GD - Grenada
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard Island and McDonald Islands
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IR - Iran
IQ - Iraq
IE - Ireland
IM - Isle of Man
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JE - Jersey
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KI - Kiribati
KW - Kuwait
KG - Kyrgyzstan
LA - Laos
LV - Latvia
LB - Lebanon
LS - Lesotho
LR - Liberia
LY - Libya
LI - Liechtenstein
LT - Lithuania
LU - Luxembourg
MO - Macao
MG - Madagascar
MW - Malawi
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MH - Marshall Islands
MQ - Martinique
MR - Mauritania
MU - Mauritius
YT - Mayotte
MX - Mexico
FM - Micronesia
MD - Moldova
MC - Monaco
MN - Mongolia
ME - Montenegro
MS - Montserrat
MA - Morocco
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NL - Netherlands
NC - New Caledonia
NZ - New Zealand
NI - Nicaragua
NE - Niger
NG - Nigeria
NU - Niue
NF - Norfolk Island
KP - North Korea
MK - North Macedonia
MP - Northern Mariana Islands
NO - Norway
OM - Oman
PK - Pakistan
PW - Palau
PS - Palestine
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PN - Pitcairn
PL - Poland
PT - Portugal
PR - Puerto Rico
QA - Qatar
RE - Réunion
RO - Romania
RU - Russia
RW - Rwanda
BL - Saint Barthélemy
SH - Saint Helena
KN - Saint Kitts and Nevis
LC - Saint Lucia
MF - Saint Martin (French part)
PM - Saint Pierre and Miquelon
VC - Saint Vincent and the Grenadines
WS - Samoa
SM - San Marino
ST - Sao Tome and Principe
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SC - Seychelles
SL - Sierra Leone
SG - Singapore
SX - Sint Maarten (Dutch part)
SK - Slovakia
SI - Slovenia
SB - Solomon Islands
SO - Somalia
ZA - South Africa
GS - South Georgia
KR - South Korea
SS - South Sudan
ES - Spain
LK - Sri Lanka
SD - Sudan
SR - Suriname
SJ - Svalbard and Jan Mayen
SE - Sweden
CH - Switzerland
SY - Syria
TW - Taiwan
TJ - Tajikistan
TZ - Tanzania
TH - Thailand
TL - Timor-Leste
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Türkiye
TM - Turkmenistan
TC - Turks and Caicos Islands
TV - Tuvalu
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
GB - United Kingdom
UM - United States Minor Outlying Islands
US - United States of America
UY - Uruguay
UZ - Uzbekistan
VU - Vanuatu
VA - Vatican City
VE - Venezuela
VN - Vietnam
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
WF - Wallis and Futuna
EH - Western Sahara
YE - Yemen
ZM - Zambia
ZW - Zimbabwe

Possible values:

labelstringRead-onlyRequired

enabledbooleanOptional

modifiedstring · date-timeRead-onlyRequired

createdstring · date-timeRead-onlyRequired

put

/v1/transaction/routing/{id}/

PUT /v1/transaction/routing/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "priority": 1,
  "min_amount": "text",
  "max_amount": "text",
  "daily_quota": "text",
  "countries": [
    "AF"
  ],
  "enabled": true
}

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "payment_method": "text",
  "gateway": "text",
  "integration_type": "text",
  "priority": 1,
  "min_amount": "text",
  "max_amount": "text",
  "daily_quota": "text",
  "used_quota": "text",
  "countries": [
    "AF"
  ],
  "label": "text",
  "enabled": true,
  "modified": "2026-03-27T22:18:45.853Z",
  "created": "2026-03-27T22:18:45.853Z"
}

PreviousConfig NextModels

Last updated 37 minutes ago