Download OpenAPI specification:
Merchant API
Get a list of payments sorted by creation date (most recent first)
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
| created.gte | string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: created.gte=2025-10-12T10:26:18 Return only payments created at or after the specified time. Default is beginning of the current day. |
| created.lt | string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: created.lt=2025-10-13T10:39:34 If passed, return only payments created strictly before the specified time |
| merchantId.in | string Example: merchantId.in=12,15 Comma-separated list of merchant (counterparty) Ids |
| shopId.in | string Example: shopId.in=101,102 Comma-separated list of shop Ids |
| terminalId.in | string Example: terminalId.in=501,502 Comma-separated list of terminal Ids |
| method.in | string Example: method.in=BASIC_CARD Comma-separated list of payment methods. See PaymentMethod for possible values. |
| type.in | string Example: type.in=DEPOSIT,REFUND Comma-separated list of payment types. See PaymentType for possible values. |
| state.in | string Example: state.in=COMPLETED,DECLINED Comma-separated list of payment states. See PaymentState for possible values. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": "91d27876e87f4b22b3ecd53924bf973d",
- "created": "2025-10-25T10:11:12",
- "updated": "2025-10-25T10:12:12",
- "state": "PENDING",
- "errorCode": "4.01 Insufficient Funds",
- "type": "DEPOSIT",
- "method": "BASIC_CARD",
- "description": "Deposit via TEST shop",
- "referenceId": "payment-123",
- "parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
- "startRecurring": true,
- "recurringToken": "string",
- "preAuth": true,
- "merchantId": 0,
- "merchantName": "string",
- "shopId": 0,
- "shopName": "string",
- "providerId": 0,
- "providerName": "string",
- "terminalId": 0,
- "terminalName": "string",
- "externalId": "string",
- "externalResultCode": "42",
- "amount": 11.12,
- "refundedAmount": 11.12,
- "currency": "EUR",
- "baseAmount": 15,
- "customerAmount": 15,
- "customerCurrency": "USD",
- "shopBaseAmount": 15,
- "shopBaseCurrency": "USD",
- "customerReferenceId": "customer_123",
- "customerAccountNumber": "string",
- "customerBank": "string",
- "customerBankBranch": "string",
- "customerBankCode": "string",
- "customerBankBranchCode": "string",
- "customerCitizenshipCountryCode": "AU",
- "customerFirstName": "John",
- "customerLastName": "Smith",
- "customerDateOfBirth": "2001-12-03",
- "customerPhone": "357 123123123",
- "customerRoutingGroup": "John",
- "customerIp": "127.0.0.1",
- "customerIpCountryCode": "CY",
- "billingCountryCode": "CY",
- "billingPostalCode": "4141",
- "billingCity": "Limassol",
- "billingState": "CA",
- "billingAddressLine1": "7, Sunny street",
- "billingAddressLine2": "Office 3",
- "cardholderName": "John Smith",
- "cardBrand": "VISA",
- "cardType": "CREDIT",
- "cardCountryCode": "CY",
- "cardIssuingOrganization": "BANK OF CYPRUS PUBLIC COMPANY LIMITED"
}
]
}Get a list of payment operations sorted by completion date (most recent first)
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
| completed.gte | string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: completed.gte=2025-10-12T10:26:18 Return only operations completed at or after the specified time. Default is beginning of the current day. |
| completed.lt | string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: completed.lt=2025-10-13T10:39:34 If passed, return only operations completed strictly before the specified time |
| operation.in | string Example: operation.in=CREATE_PAYMENT,CHECKOUT,CANCEL Comma-separated list of operations |
| paymentState.in | string Example: paymentState.in=CHECKOUT,COMPLETED,DECLINED Comma-separated list of payment states after operation completion |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 0,
- "paymentId": "91d27876e87f4b22b3ecd53924bf973d",
- "operation": "CREATE_PAYMENT",
- "paymentState": "PENDING",
- "started": "2025-10-25T10:12:12",
- "completed": "2025-10-25T10:12:13",
- "rawPaymentData": "string",
- "terminalId": 0,
- "terminalName": "string",
- "paymentCreated": "2025-10-25T10:11:12",
- "paymentType": "DEPOSIT",
- "paymentMethod": "BASIC_CARD",
- "paymentDescription": "Deposit via TEST shop",
- "paymentReferenceId": "payment-123",
- "paymentAmount": 11.12,
- "paymentCurrency": "EUR",
- "paymentBaseAmount": 15,
- "parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
- "merchantId": 0,
- "merchantName": "string",
- "shopId": 0,
- "shopName": "string",
- "providerId": 0,
- "providerName": "string",
- "errorCode": "4.01 Insufficient Funds",
- "externalResultCode": "42",
- "externalId": "string"
}
]
}Get all counterparties
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": [
- {
- "id": 111,
- "name": "Best Counterparty",
- "affiliateId": "d941c1d7805530",
- "affiliateName": "SomeName",
- "uniqueCode": "c1d7",
- "registrationDate": "2025-11-17",
- "createdAt": "2025-11-17T12:12:12",
- "counterpartyTypes": [
- "MERCHANT",
- "PROVIDER"
]
}
]
}Get all merchants shops
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
| merchantId.in | string Example: merchantId.in=12,15 Comma-separated list of merchant (counterparty) Ids |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": [
- {
- "id": 111,
- "name": "Best Shop",
- "state": "ACTIVE",
- "displayName": "Best Shop",
- "merchantId": 192,
- "merchantName": "Best Merchant",
- "introducerId": 12345,
- "introducerName": "Mr. John",
- "countryCode": "US",
- "baseCurrency": "string",
- "checkoutTimeout": 60,
- "cascadingConfirmationTimeout": 0,
- "resultPageRedirectTimeout": 5,
- "antiFraudProfileId": 100,
- "checkoutThemeCode": "string",
- "postProcessors": [
- 0
], - "preProcessors": [
- 0
], - "routingStrategy": "string",
- "depositRequiredParameters": [
- "customerFirstName",
- "customerLastName",
- "customerEmail",
- "customerPhone",
- "customerDateOfBirth",
- "billingAddress"
], - "shopGroups": [
- "string"
], - "createdAt": "2025-11-17T12:12:12"
}
]
}Get a paginated list of shop groups.
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 10,
- "name": "My Shop Group",
- "shops": [
- {
- "id": 111,
- "name": "Best Shop"
}
]
}
]
}Get the specified shop group with its shops. Requires SHOP_GROUP_VIEW permission.
| groupId required | integer Shop Group Id |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": {
- "id": 10,
- "name": "My Shop Group",
- "shops": [
- {
- "id": 111,
- "name": "Best Shop"
}
]
}
}Add one or more shops to the specified shop group. Requires SHOP_GROUP_EDIT permission.
| groupId required | integer Shop Group Id |
| shops required | Array of integers non-empty List of shop IDs |
{- "shops": [
- 10,
- 25
]
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Delete one or more shops from the specified shop group. Requires SHOP_GROUP_EDIT permission.
| groupId required | integer Shop Group Id |
| shops required | Array of integers non-empty List of shop IDs |
{- "shops": [
- 10,
- 25
]
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Get terminal balance by terminal Id (Applicable only to the Terminals that support the BALANCE operation).
| terminalId required | integer Terminal Id |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": {
- "available": [
- {
- "currency": "EUR",
- "amount": 11.12
}
], - "reserved": [
- {
- "currency": "EUR",
- "amount": 11.12
}
]
}
}Get all merchant terminals
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": [
- {
- "id": 111,
- "name": "Basic Card Terminal",
- "state": "Basic Card Terminal",
- "merchantId": 2281,
- "merchantName": "Best Merchant",
- "providerId": 345,
- "providerName": "Best Provider",
- "apiCode": "ApiCode",
- "apiName": "ApiName",
- "createdAt": "2025-11-17T12:12:12",
- "apiTypes": [
- "PSP",
- "BANKING",
- "COMPLIANCE",
- "PRE_PROCESSOR",
- "POST_PROCESSOR"
]
}
]
}Get a list of all merchant balances in the Financial Module. For more detailed information, please contact our support team.
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": [
- {
- "id": 123,
- "type": "PROCESSING",
- "name": "Processing Balance(EUR) of shop \"my-shop\"",
- "currency": "EUR",
- "amount": 1020.12
}
]
}Get balances available for withdrawals via the gateway API. See the "Check Withdrawal Balance" section in the shop settings.
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": [
- {
- "shopId": 1381,
- "shopName": "Best Shop",
- "terminalId": 11126,
- "terminalName": "Best Terminal",
- "currency": "EUR",
- "amount": 500.25
}
]
}Get a paginated list of BINs
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "bin": "411111",
- "cardBrand": "VISA",
- "cardType": "CREDIT",
- "issuingCountryCode": "CY",
- "issuingOrganization": "BANK OF CYPRUS PUBLIC COMPANY LIMITED"
}
]
}Get a paginated list of BIN groups
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 42,
- "merchantId": 192,
- "merchantName": "Best Merchant",
- "groupName": "My BIN Group"
}
]
}Get a paginated list of BINs belonging to the specified BIN group
| groupId required | integer BIN Group Id |
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- "411111",
- "511111"
]
}Add one or more BIN values to the specified BIN group. Requires SHOP_EDIT permission.
| groupId required | integer BIN Group Id |
| bins required | Array of strings non-empty [ items^[0-9]{6,8}$ ] List of BIN values (6-8 digits) |
{- "bins": [
- "412345",
- "51234567"
]
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Delete one or more BIN values from the specified BIN group. Requires SHOP_EDIT permission.
| groupId required | integer BIN Group Id |
| bins required | Array of strings non-empty [ items^[0-9]{6,8}$ ] List of BIN values (6-8 digits) |
{- "bins": [
- "412345",
- "51234567"
]
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Get a paginated list of customers.
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
| shopId.eq | integer The id of a shop to which the customers belong. Default is null, which means all shops. |
| id.gt | integer The customer ID after which to start collecting the result set. Default is null, which means result set collection starts with the first customer. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 999,
- "merchantId": 192,
- "merchantName": "Best Merchant",
- "shopId": 111,
- "shopName": "Best Shop",
- "referenceId": "customer_123",
- "firstName": "John",
- "lastName": "Smith",
- "phone": "357 123123123",
- "dateOfBirth": "2001-12-03",
- "citizenshipCountryCode": "CY",
- "billingCountryCode": "CY",
- "billingAddressLine1": "7, Sunny street",
- "billingAddressLine2": "Office 3",
- "billingCity": "Limassol",
- "billingState": "CA",
- "billingPostalCode": "4141",
- "paymentInstruments": [
- {
- "paymentMethod": "BASIC_CARD",
- "accountNumber": "411111******1111",
- "numberOfSuccessfulDeposits": 5
}
], - "connectedCards": [
- {
- "cardholderName": "John Smith",
- "pan": "411111******1111",
- "expiryDate": "12/26",
- "updatedAt": "2025-11-17T12:12:12",
- "savedByCustomer": true
}
]
}
]
}Get a paginated list of email groups
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 10,
- "name": "My Email Group",
- "merchantId": 192,
- "merchantName": "Best Merchant"
}
]
}Get a paginated list of email addresses belonging to the specified email group
| groupId required | integer Email Group Id |
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
}Add one or more email addresses to the specified email group. Requires "Edit Shops" permission.
| groupId required | integer Email Group Id |
| emails required | Array of strings <email> non-empty [ items <email > ] List of email addresses |
{
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Delete one or more email addresses from the specified email group. Requires SHOP_EDIT permission.
| groupId required | integer Email Group Id |
| emails required | Array of strings <email> non-empty [ items <email > ] List of email addresses |
{
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Get a paginated list of card groups
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 10,
- "name": "My Card Group",
- "merchantId": 192,
- "merchantName": "Best Merchant"
}
]
}Get a paginated list of masked card PANs belonging to the specified card group
| groupId required | integer Card Group Id |
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- "411111******1111",
- "511111******2222"
]
}Add one or more card numbers to the specified card group. Requires "Edit Shops" permission. For masked card groups, card numbers must contain at least the first 6 and last 4 digits.
| groupId required | integer Card Group Id |
| cardNumbers required | Array of strings non-empty List of card numbers to add to the group. For masked card groups, each entry must start with at least 6 digits and end with 4 digits. |
{- "cardNumbers": [
- "411111***1111",
- "550000***5559"
]
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Get a paginated list of country groups
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 10,
- "name": "My Country Group",
- "merchantId": 192,
- "merchantName": "Best Merchant",
- "countries": [
- "CY",
- "US",
- "GB"
]
}
]
}Get the specified country group with its countries
| groupId required | integer Country Group Id |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": {
- "id": 10,
- "name": "My Country Group",
- "merchantId": 192,
- "merchantName": "Best Merchant",
- "countries": [
- "CY",
- "US",
- "GB"
]
}
}Add one or more countries to the specified country group. Requires SETTINGS_EDIT permission.
| groupId required | integer Country Group Id |
| countries required | Array of strings non-empty [ items^[A-Za-z]{2}$ ] List of ISO 3166-1 alpha-2 country codes |
{- "countries": [
- "US",
- "DE"
]
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Delete one or more countries from the specified country group. Requires SETTINGS_EDIT permission.
| groupId required | integer Country Group Id |
| countries required | Array of strings non-empty [ items^[A-Za-z]{2}$ ] List of ISO 3166-1 alpha-2 country codes |
{- "countries": [
- "US",
- "DE"
]
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Get a paginated list of shop connectors
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
| merchantId.in | string Example: merchantId.in=12,15 Comma-separated list of merchant (counterparty) Ids |
| shopId.in | string Example: shopId.in=101,102 Comma-separated list of shop Ids. Use it to get the terminals connected to a shop. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 0,
- "shopId": 0,
- "state": "ACTIVE",
- "paymentMethod": "BASIC_CARD",
- "terminalId": 0,
- "priority": 0,
- "weight": 0,
- "terminalCurrency": "EUR",
- "dpMinCommission": 0,
- "dpCommissionPercent": 0,
- "dpAmountConfirmation": true,
- "wdMinCommission": 0,
- "wdCommissionPercent": 0,
- "wdCommissionOnTop": true,
- "cascadingErrorCodesWhitelistId": 0,
- "cascadingErrorCodesBlacklistId": 0,
- "filters": {
- "amountOp": "BETWEEN",
- "amountGte": 0,
- "amountLt": 0,
- "paymentType": "DEPOSIT",
- "customerCountry": {
- "code": "CY",
- "op": "IN",
- "groupId": 0
}, - "ipCountry": {
- "code": "CY",
- "op": "IN",
- "groupId": 0
}, - "currency": "EUR",
- "ipVersion": "IPV4",
- "emailBlackListGroupId": 0,
- "emailWhiteListGroupId": 0,
- "routingGroups": [
- "VIP"
]
}, - "cardFilters": {
- "cardBlackListGroupId": 0,
- "cardWhiteListGroupId": 0,
- "binCountry": {
- "code": "CY",
- "groupOp": "IN",
- "groupId": 0
}, - "cardBin": {
- "range": "string",
- "groupOp": "IN",
- "groupId": 0
}, - "binBrands": [
- "VISA",
- "MASTERCARD"
]
}, - "limits": [
- {
- "id": 0,
- "limitCode": "string",
- "timeUnit": "DAY",
- "timePeriod": 0,
- "limitValue": 0,
- "routingGroup": "string"
}
], - "trustedRoutingCriteria": {
- "customerKycStatus": "string",
- "cardKycStatus": "string",
- "daysSinceFirstDeposit": 0,
- "cardHoursSinceFirstDeposit": 0,
- "numberOfDpsForCard": 0,
- "statisticsForThisShop": {
- "depositsAmount": 0,
- "depositsCount": {
- "min": 0,
- "max": 0
}, - "depositsCountForCard": {
- "min": 0,
- "max": 0
}, - "withdrawalsAmount": 0,
- "withdrawalsCount": 0
}, - "statisticsForAllLinkedShops": {
- "depositsAmount": 0,
- "depositsCount": {
- "min": 0,
- "max": 0
}, - "depositsCountForCard": {
- "min": 0,
- "max": 0
}, - "withdrawalsAmount": 0,
- "withdrawalsCount": 0
}, - "statisticsForAtLeastOneLinkedShop": {
- "depositsAmount": 0,
- "depositsCount": {
- "min": 0,
- "max": 0
}, - "depositsCountForCard": {
- "min": 0,
- "max": 0
}, - "withdrawalsAmount": 0,
- "withdrawalsCount": 0
}
}
}
]
}Get a paginated list of anti-fraud profiles
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 100,
- "name": "Default Profile",
- "timeZoneToCheckLimits": "Europe/Nicosia",
- "paymentDataVerification": [
- {
- "id": 0,
- "ruleCode": "string",
- "countryOp": "string",
- "countryCode": "CY",
- "countryGroupId": 0,
- "currency": "EUR",
- "currencyOp": "string",
- "currencyGroupId": 0,
- "amountOp": "string",
- "amountGte": 0,
- "amountLt": 0,
- "currencies": "string",
- "period": 0,
- "parameters": "string",
- "routingGroup": "string"
}
], - "shopLimits": [
- {
- "id": 0,
- "limitCode": "string",
- "timeUnit": "DAY",
- "timePeriod": 0,
- "currency": "EUR",
- "limitValue": 0
}
], - "offlineChecks": [
- {
- "id": 0,
- "warnCode": "string",
- "timeUnit": "DAY",
- "timePeriod": 0,
- "countryOp": "string",
- "countryCode": "CY",
- "countryGroupId": 0,
- "currency": "EUR",
- "limitValue": 0,
- "period": 0
}
]
}
]
}Get a paginated list of currency exchange rates
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "baseCurrency": "EUR",
- "quoteCurrency": "USD",
- "rate": 1.1,
- "lastUpdate": "2025-11-17T12:12:12",
- "userId": 0,
- "jobTerminalId": 0
}
]
}Get a paginated list of bank codes
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "countryCode": "NG",
- "bankCode": "000001",
- "bankName": "Access Bank"
}
]
}Get a paginated list of bank code mappings
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 42,
- "countryCode": "NG",
- "bankCode": "000001",
- "apiCode": "FLUTTERWAVE",
- "apiBankCode": "ACCESS"
}
]
}Get a paginated list of error code groups
| offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
| limit | integer [ 1 .. 10000 ] The numbers of items to return. Default is 50. |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "id": 10,
- "name": "My Error Code Group",
- "merchantId": 192,
- "merchantName": "Best Merchant",
- "errorCodes": [
- "4.01",
- "3.00"
]
}
]
}Get the specified error code group with its error codes. Requires SHOP_EDIT permission.
| groupId required | integer Error Code Group Id |
{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": {
- "id": 10,
- "name": "My Error Code Group",
- "merchantId": 192,
- "merchantName": "Best Merchant",
- "errorCodes": [
- "4.01",
- "3.00"
]
}
}Add one or more error codes to the specified error code group. Requires SHOP_EDIT permission.
| groupId required | integer Error Code Group Id |
| errorCodes required | Array of strings non-empty [ items^\d\.\d{2}$ ] List of error codes in format X.XX |
{- "errorCodes": [
- "1.03",
- "2.01"
]
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Delete one or more error codes from the specified error code group. Requires SHOP_EDIT permission.
| groupId required | integer Error Code Group Id |
| errorCodes required | Array of strings non-empty [ items^\d\.\d{2}$ ] List of error codes in format X.XX |
{- "errorCodes": [
- "1.03",
- "2.01"
]
}{- "timestamp": "2025-10-07T13:32:19.444+00:00",
- "status": 400,
- "error": "Bad Request",
- "message": "string",
- "errors": [
- {
- "codes": [
- "string"
], - "arguments": [
- {
- "codes": [
- "string"
], - "defaultMessage": "string"
}
], - "defaultMessage": "string",
- "objectName": "string",
- "field": "string",
- "bindingFailure": true
}
], - "path": "/merchant-api/v1/payments"
}Simulate routing of a payment for the specified shop without creating a payment. Returns the connectors that would be tried, in order, with the amount and currency sent to each terminal. The result matches the Routing Simulation in the Dashboard. Requires SHOP_VIEW permission. The shop must belong to one of the user's merchants and, if the user is limited to specific shops, be one of those shops; otherwise 403 is returned.
| shopId required | integer Shop Id |
| paymentType | string (SimulationPaymentType) Enum: "DEPOSIT" "WITHDRAWAL" Payment Type. Default is DEPOSIT. |
| paymentMethod required | string (PaymentMethod) Enum: "ABSA_PAY" "ACH" "AHLPAY" "ALFAKIT" "ALFAMART" "ALIPAY" "ALYCEPAY" "APPLEPAY" "ARI10" "ASTROPAY" "B2BINPAY" "BANCOMAT" "BANCONTACT" "BANKTRANSFER" "BANKTRANSFER_AR" "BANKTRANSFER_BO" "BANKTRANSFER_BR" "BANKTRANSFER_CL" "BANKTRANSFER_CO" "BANKTRANSFER_CR" "BANKTRANSFER_EC" "BANKTRANSFER_GT" "BANKTRANSFER_HN" "BANKTRANSFER_JP" "BANKTRANSFER_MX" "BANKTRANSFER_MY" "BANKTRANSFER_PA" "BANKTRANSFER_PE" "BANKTRANSFER_TR" "BANKTRANSFER_UY" "BANKTRANSFER_VE" "BANKTRANSFER_KR" "BASIC_CARD" "BASIC_CARD_HPP" "BCI" "BILLLINE" "BINANCE_PAY" "BIOPAGO" "BIZUM" "BKASH" "BLIK" "BLUVOUCHER" "BOLETO" "BOOST" "BREB" "BRITE" "BYBIT_PAY" "CAPITEC_PAY" "CASH" "CASHAPP" "CASH_EC" "CASHLIB" "CHEK" "CIP" "CLICK" "CODI" "CRYPTO" "CUP" "DANA" "DPOPAY" "DRAGON_PAY" "DUITNOW" "EASYPAISA" "ECNY" "EFECTY" "EFT" "EMANAT" "ENAIRA" "EPAY_BG" "EPS" "ETISALAT_EG" "EZYCASH" "ESEWA" "EUPAGO" "EXTERNAL_HPP" "FAWRY" "FINRAX" "FLEXEPIN" "FONEPAY" "FPS" "FPS_HK" "FPX" "FUPS" "GATE8TRANSACT" "GATEIQ" "GCASH" "GIFTCARD" "GIFTCARD_CARD" "GIFTCARD_OPENBANKING" "GIFTCARD_PAYPAL" "GIFTCARD_PM" "GIROPAY" "GOOGLEPAY" "GOPAY" "GPAY_IN" "GRABPAY" "HAVALE" "HAYDIPAY" "HAYHAY" "HELP2PAY" "HITES" "IDEAL" "IMEPAY" "IMPS" "INAI" "INRPAY" "INTENT" "INTERAC" "INTERAC_ACH" "INTERAC_ETO" "INTERAC_EXPRESS" "INTERAC_REQUEST_MONEY" "INTERAC_RTO" "JAZZCASH" "JETONCASH" "JETONWALLET" "KAKAOPAY" "KBZ" "KESSPAY" "KHALTI" "KHIPU" "KLAP_EFECTIVO" "KLAP_TRANSFERENCIA" "KLARNA" "LOCALPAYMENT" "M10" "MACH" "MACROPAY" "MBWAY" "MEFETE" "MERCADOPAGO" "MIA" "MIFINITY" "MISTERCASH" "MOBILE_BANKING_CN" "MOBILE_COMMERCE" "MOBILE_MONEY" "MOLLIE" "MOMOPAY_RW" "MOMOPAY_VN" "MONERCHY" "MONETIX" "MONEYTOLIA" "MONNET" "MONOOVA_ACCOUNT_TRANSFER" "MONOOVA_WALLET_TRANSFER" "MPAY" "MPESA" "MUCHBETTER" "MULTIBANCO" "MYBANK" "MYPAYZ" "N26" "NAGAD" "NARANJAX" "NAVERPAY" "NEFT" "NEOSURF" "NEQUI" "NETBANKING" "NETELLER" "NGENIUS" "NODA" "NODA_REVOLUT" "NPP" "NUMICARD" "NUMICARD_CARD" "NUMICARD_OPENBANKING" "NUMICARD_PAYPAL" "OFFLINE_UPI" "OMNIMATRIX" "ONEVOUCHER" "ONLINE_BANKING" "OPAY" "OPEN_BANKING" "OPENPAYD" "OPTIMONEY" "OTTVOUCHER" "OVO" "OXXO" "P24" "P2C" "P2P_ACCESS" "P2P_ALFABANK" "P2P_CARD" "P2P_CARD_ABH" "P2P_CARD_CLICK" "P2P_CARD_HUMO" "P2P_CARD_PAYME" "P2P_CARD_UZCARD" "P2P_CROSS_BORDER" "P2P_CROSS_BORDER_ALFABANK" "P2P_CROSS_BORDER_GAZPROMBANK" "P2P_CROSS_BORDER_SBER" "P2P_CROSS_BORDER_TBANK" "P2P_CROSS_BORDER_VTB" "P2P_ELCART" "P2P_EMANAT" "P2P_GAZPROMBANK" "P2P_IBAN" "P2P_INSTAPAY_EG" "P2P_INTERAC_ETO" "P2P_KAPITAL" "P2P_M10" "P2P_MBANK_KG" "P2P_MOBILE" "P2P_MOBILE_PAYME" "P2P_MOBILE_TOP_UP" "P2P_OZONBANK" "P2P_PSB" "P2P_QR_CLICK" "P2P_QR_PAY" "P2P_SBERBANK" "P2P_SBP" "P2P_TBANK" "P2P_UPI" "P2P_VTB" "PAGO_MOVIL" "PAGO_MOVIL_INST" "PAGO46" "PAGOEFECTIVO" "PAGOFACIL" "PAGSMILE_VAULT" "PALMPAY" "PAPARA" "PAPEL" "PARAM" "PARATIM" "PARAZULA" "PAROLAPARA" "PAY2PLAY" "PAYBOL" "PAY_BY_LINK" "PAY_ME" "PAYCASH" "PAYCELL" "PAYCO_KR" "PAYCO_TR" "PAYDO_WALLET" "PAYFIX" "PAYFUN" "PAYID" "PAYMAXIS" "PAYMAYA" "PAYME_UZ" "PAYNOW" "PAYOUT_NONSEPA_REQUEST" "PAYOUT_SEPA_BATCH" "PAYPAL" "PAYPAY" "PAYPO" "PAYPORT" "PAYRETAILERS" "PAYSAFECARD" "PAYSAFECASH" "PAYSHOP" "PAYTM" "PAYTO" "PAYU" "PEC" "PEP" "PERFECTMONEY" "PG_PARA" "PHONEPE" "PIASTRIX" "PICPAY" "PIX" "POLI" "POPY" "POPY_PARA" "PREPAID_CARD" "PROMPTPAY" "PSE" "PUNTOPAGO" "PUSH" "QR" "QR_ELCART" "QR_INSTAPAY_EG" "QR_MBANK_KG" "QRIS" "RAPIDTRANSFER" "RAPIPAGO" "REVOLUT" "ROCKET" "RTP" "RTGS" "RUBPAY" "SATISPAY" "SBERPAY" "SBP" "SBP_CROSS_BORDER" "SEPA" "SERVIFACIL" "SHOPEEPAY" "SIPAY" "SKRILL" "SOFORT" "SOFT2PAY" "SPEI" "SPOYNT" "STICPAY" "SUPERMARKET_CODE_PAY" "SWISH" "TED" "TINK" "TOSLA" "TOSSPAY" "TOUCH_N_GO" "TRANSFIYA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "TWINT" "UNIONPAY_TRANSFER" "UPI" "USSD" "VENMO" "VIETTEL" "VIPPS" "VIRTUAL_ACCOUNT" "VNPAY_QR" "VODAFONE_EG" "VOLT" "VOUCHERCARD" "VOUCHERCARD_CARD" "VOUCHERCARD_OPENBANKING" "VOUCHERCARD_PAYPAL" "VOUCHERCARD_PM" "VOUCHERRY" "VOUCHSTAR" "WAVE" "WECHAT" "WEBPAY" "WHISH" "WISE" "XANPAY" "XINPAY" "YAPE" "YAPILY" "ZALO" "ZELLE" "ZIMPLER" "ZIPAY" "ZOTAPAY" Payment Method |
| amount required | number Payment amount. Must be greater than 0. |
| currency required | string^[A-Za-z]{3,4}$ Currency code configured in the system - ISO 4217 or a 3-4 letter crypto code (e.g. USDT) |
| customerReferenceId | string <= 256 characters Customer reference id |
| customerEmail | string <email> <= 256 characters Customer email |
| ipCountryCode | string^[A-Za-z]{2}$ ISO 3166-1 alpha-2 code of the payer IP country |
| billingCountryCode | string^[A-Za-z]{2}$ ISO 3166-1 alpha-2 code of the billing country |
| customerRoutingGroup | string <= 256 characters Customer routing group |
| cardNumber | string Card number used to resolve BIN data (brand, type, issuer, card country) for BASIC_CARD. 13-19 digits, spaces allowed, must pass the Luhn check. Test card numbers are recommended. The card number is not stored. Rules tied to a specific saved card (card PAN) are not simulated, as in the Dashboard Routing Simulation. |
{- "paymentType": "DEPOSIT",
- "paymentMethod": "BASIC_CARD",
- "amount": 100.5,
- "currency": "EUR",
- "customerReferenceId": "customer-123",
- "ipCountryCode": "DE",
- "billingCountryCode": "DE",
- "customerRoutingGroup": "VIP",
- "cardNumber": "4111 1111 1111 1111"
}{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": {
- "routes": [
- {
- "order": 1,
- "terminalId": 42,
- "terminalName": "Main EUR Terminal",
- "connectorId": 1001,
- "amount": 100.5,
- "currency": "EUR"
}
], - "reason": "NO_SUITABLE_CONNECTORS"
}
}Simulate which checkout options the payer would see on the checkout page for the specified shop, in display order. The result matches the Checkout Simulation in the Dashboard. Requires SHOP_VIEW permission. The shop must belong to one of the user's merchants and, if the user is limited to specific shops, be one of those shops; otherwise 403 is returned.
| shopId required | integer Shop Id |
| paymentType | string (SimulationPaymentType) Enum: "DEPOSIT" "WITHDRAWAL" Payment Type. Default is DEPOSIT. |
| paymentMethod | string (PaymentMethod) Enum: "ABSA_PAY" "ACH" "AHLPAY" "ALFAKIT" "ALFAMART" "ALIPAY" "ALYCEPAY" "APPLEPAY" "ARI10" "ASTROPAY" "B2BINPAY" "BANCOMAT" "BANCONTACT" "BANKTRANSFER" "BANKTRANSFER_AR" "BANKTRANSFER_BO" "BANKTRANSFER_BR" "BANKTRANSFER_CL" "BANKTRANSFER_CO" "BANKTRANSFER_CR" "BANKTRANSFER_EC" "BANKTRANSFER_GT" "BANKTRANSFER_HN" "BANKTRANSFER_JP" "BANKTRANSFER_MX" "BANKTRANSFER_MY" "BANKTRANSFER_PA" "BANKTRANSFER_PE" "BANKTRANSFER_TR" "BANKTRANSFER_UY" "BANKTRANSFER_VE" "BANKTRANSFER_KR" "BASIC_CARD" "BASIC_CARD_HPP" "BCI" "BILLLINE" "BINANCE_PAY" "BIOPAGO" "BIZUM" "BKASH" "BLIK" "BLUVOUCHER" "BOLETO" "BOOST" "BREB" "BRITE" "BYBIT_PAY" "CAPITEC_PAY" "CASH" "CASHAPP" "CASH_EC" "CASHLIB" "CHEK" "CIP" "CLICK" "CODI" "CRYPTO" "CUP" "DANA" "DPOPAY" "DRAGON_PAY" "DUITNOW" "EASYPAISA" "ECNY" "EFECTY" "EFT" "EMANAT" "ENAIRA" "EPAY_BG" "EPS" "ETISALAT_EG" "EZYCASH" "ESEWA" "EUPAGO" "EXTERNAL_HPP" "FAWRY" "FINRAX" "FLEXEPIN" "FONEPAY" "FPS" "FPS_HK" "FPX" "FUPS" "GATE8TRANSACT" "GATEIQ" "GCASH" "GIFTCARD" "GIFTCARD_CARD" "GIFTCARD_OPENBANKING" "GIFTCARD_PAYPAL" "GIFTCARD_PM" "GIROPAY" "GOOGLEPAY" "GOPAY" "GPAY_IN" "GRABPAY" "HAVALE" "HAYDIPAY" "HAYHAY" "HELP2PAY" "HITES" "IDEAL" "IMEPAY" "IMPS" "INAI" "INRPAY" "INTENT" "INTERAC" "INTERAC_ACH" "INTERAC_ETO" "INTERAC_EXPRESS" "INTERAC_REQUEST_MONEY" "INTERAC_RTO" "JAZZCASH" "JETONCASH" "JETONWALLET" "KAKAOPAY" "KBZ" "KESSPAY" "KHALTI" "KHIPU" "KLAP_EFECTIVO" "KLAP_TRANSFERENCIA" "KLARNA" "LOCALPAYMENT" "M10" "MACH" "MACROPAY" "MBWAY" "MEFETE" "MERCADOPAGO" "MIA" "MIFINITY" "MISTERCASH" "MOBILE_BANKING_CN" "MOBILE_COMMERCE" "MOBILE_MONEY" "MOLLIE" "MOMOPAY_RW" "MOMOPAY_VN" "MONERCHY" "MONETIX" "MONEYTOLIA" "MONNET" "MONOOVA_ACCOUNT_TRANSFER" "MONOOVA_WALLET_TRANSFER" "MPAY" "MPESA" "MUCHBETTER" "MULTIBANCO" "MYBANK" "MYPAYZ" "N26" "NAGAD" "NARANJAX" "NAVERPAY" "NEFT" "NEOSURF" "NEQUI" "NETBANKING" "NETELLER" "NGENIUS" "NODA" "NODA_REVOLUT" "NPP" "NUMICARD" "NUMICARD_CARD" "NUMICARD_OPENBANKING" "NUMICARD_PAYPAL" "OFFLINE_UPI" "OMNIMATRIX" "ONEVOUCHER" "ONLINE_BANKING" "OPAY" "OPEN_BANKING" "OPENPAYD" "OPTIMONEY" "OTTVOUCHER" "OVO" "OXXO" "P24" "P2C" "P2P_ACCESS" "P2P_ALFABANK" "P2P_CARD" "P2P_CARD_ABH" "P2P_CARD_CLICK" "P2P_CARD_HUMO" "P2P_CARD_PAYME" "P2P_CARD_UZCARD" "P2P_CROSS_BORDER" "P2P_CROSS_BORDER_ALFABANK" "P2P_CROSS_BORDER_GAZPROMBANK" "P2P_CROSS_BORDER_SBER" "P2P_CROSS_BORDER_TBANK" "P2P_CROSS_BORDER_VTB" "P2P_ELCART" "P2P_EMANAT" "P2P_GAZPROMBANK" "P2P_IBAN" "P2P_INSTAPAY_EG" "P2P_INTERAC_ETO" "P2P_KAPITAL" "P2P_M10" "P2P_MBANK_KG" "P2P_MOBILE" "P2P_MOBILE_PAYME" "P2P_MOBILE_TOP_UP" "P2P_OZONBANK" "P2P_PSB" "P2P_QR_CLICK" "P2P_QR_PAY" "P2P_SBERBANK" "P2P_SBP" "P2P_TBANK" "P2P_UPI" "P2P_VTB" "PAGO_MOVIL" "PAGO_MOVIL_INST" "PAGO46" "PAGOEFECTIVO" "PAGOFACIL" "PAGSMILE_VAULT" "PALMPAY" "PAPARA" "PAPEL" "PARAM" "PARATIM" "PARAZULA" "PAROLAPARA" "PAY2PLAY" "PAYBOL" "PAY_BY_LINK" "PAY_ME" "PAYCASH" "PAYCELL" "PAYCO_KR" "PAYCO_TR" "PAYDO_WALLET" "PAYFIX" "PAYFUN" "PAYID" "PAYMAXIS" "PAYMAYA" "PAYME_UZ" "PAYNOW" "PAYOUT_NONSEPA_REQUEST" "PAYOUT_SEPA_BATCH" "PAYPAL" "PAYPAY" "PAYPO" "PAYPORT" "PAYRETAILERS" "PAYSAFECARD" "PAYSAFECASH" "PAYSHOP" "PAYTM" "PAYTO" "PAYU" "PEC" "PEP" "PERFECTMONEY" "PG_PARA" "PHONEPE" "PIASTRIX" "PICPAY" "PIX" "POLI" "POPY" "POPY_PARA" "PREPAID_CARD" "PROMPTPAY" "PSE" "PUNTOPAGO" "PUSH" "QR" "QR_ELCART" "QR_INSTAPAY_EG" "QR_MBANK_KG" "QRIS" "RAPIDTRANSFER" "RAPIPAGO" "REVOLUT" "ROCKET" "RTP" "RTGS" "RUBPAY" "SATISPAY" "SBERPAY" "SBP" "SBP_CROSS_BORDER" "SEPA" "SERVIFACIL" "SHOPEEPAY" "SIPAY" "SKRILL" "SOFORT" "SOFT2PAY" "SPEI" "SPOYNT" "STICPAY" "SUPERMARKET_CODE_PAY" "SWISH" "TED" "TINK" "TOSLA" "TOSSPAY" "TOUCH_N_GO" "TRANSFIYA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "TWINT" "UNIONPAY_TRANSFER" "UPI" "USSD" "VENMO" "VIETTEL" "VIPPS" "VIRTUAL_ACCOUNT" "VNPAY_QR" "VODAFONE_EG" "VOLT" "VOUCHERCARD" "VOUCHERCARD_CARD" "VOUCHERCARD_OPENBANKING" "VOUCHERCARD_PAYPAL" "VOUCHERCARD_PM" "VOUCHERRY" "VOUCHSTAR" "WAVE" "WECHAT" "WEBPAY" "WHISH" "WISE" "XANPAY" "XINPAY" "YAPE" "YAPILY" "ZALO" "ZELLE" "ZIMPLER" "ZIPAY" "ZOTAPAY" Payment Method |
| amount required | number Payment amount. Must be greater than 0. |
| currency required | string^[A-Za-z]{3,4}$ Currency code configured in the system - ISO 4217 or a 3-4 letter crypto code (e.g. USDT) |
| customerReferenceId | string <= 256 characters Customer reference id |
| ipCountryCode | string^[A-Za-z]{2}$ ISO 3166-1 alpha-2 code of the payer IP country |
| billingCountryCode | string^[A-Za-z]{2}$ ISO 3166-1 alpha-2 code of the billing country |
| customerRoutingGroup | string <= 256 characters Customer routing group |
{- "paymentType": "DEPOSIT",
- "paymentMethod": "BASIC_CARD",
- "amount": 100.5,
- "currency": "EUR",
- "customerReferenceId": "customer-123",
- "ipCountryCode": "DE",
- "billingCountryCode": "DE",
- "customerRoutingGroup": "VIP"
}{- "timestamp": "2025-10-07T13:36:32.595+00:00",
- "status": 200,
- "result": {
- "checkoutOptions": [
- {
- "order": 1,
- "id": 15,
- "name": "Cards",
- "paymentMethod": "BASIC_CARD"
}
], - "reason": "NO_SUITABLE_CHECKOUT_OPTIONS"
}
}