Returns information about payment methods

Returns information about all available payment channels on particular terminal, such as: name, min. amount, max amount, currency, logo, country etc. It is possible to fetch one channel only, specific channels or all payment channels (including those for which the Merchant does not have a signed agreement).

Request

Query Params

transactionType

string

required

Type of transaction. TRT_AUTH is used for recurring.

Example:

TRT_REFUND

Match pattern:

^TRT(_[A-Z0-9]+)+$

amount

string

optional

Amount

Example:

123.04

Match pattern:

^(?=.*[0-9])\d{1,16}(?:\.\d{1,12})?$

currency

string

optional

Currency

>= 3 characters<= 3 characters

Example:

PLN

Match pattern:

^[A-Z]+$

authorizationCurrency

string

optional

Authorization currency

>= 3 characters<= 3 characters

Example:

PLN

Match pattern:

^[A-Z]+$

orderCountry

string | null

optional

country code from dictionary CTR_COUNTRY_CODE

Example:

paymentMethod

string

optional

PaymentMethod

Example:

PME_CARD

paymentChannel

string

optional

PaymentChannel

Example:

PCL_CARD

Match pattern:

^([a-z](-?[a-z0-9])*|[A-Z](_?[A-Z0-9])*)$

sortBy

enum<string>

optional

sort type, Currently only rank

Allowed value:

rank

Default:

rank

direction

enum<string>

optional

Direction of order

Allowed values:

ascdesc

Default:

asc

limit

string

optional

Limit of results

Default:

Match pattern:

^[1-9][0-9]*$

offset

string

optional

offset of results

Default:

Match pattern:

^[0-9]*$

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

customer-id

string <uuid>

optional

A customer identifier

external-customer-id

string

optional

A customer identifier from merchant system

customer-ip

optional

A customer IP Addres for feature use

Any of

string<ipv4>

string<ipv6>

<= 15 characters

Example:

127.0.0.1

Responses

🟢200OK

application/json

Body

meta

object

CheckoutMethodMeta

optional

limit

integer

required

Default:

offset

integer

required

Default:

direction

enum<string>

required

Allowed values:

ascdesc

Default:

desc

hasMore

boolean

required

Default:

false

currencies

array[string]

optional

data

array[object (CheckoutMethodEntityV3) {5}]

optional

paymentMethod

string

required

Payment method name from dictionary PME_PAYMENT_METHOD

Example:

PME_CARD

paymentMethodName

string

optional

methodLogoUrl

string <url>

optional

Payment method logo URL. Option 3 from PME_PAYMENT_METHOD

customerCountry

string | null

optional

Customer country code from dictionary CTR_COUNTRY_CODE

Example:

paymentChannels

array[object (CheckoutChannelEntityV3) {9}]

required

Example

{
    "meta": {
        "limit": 10,
        "offset": 0,
        "direction": "desc",
        "hasMore": false,
        "currencies": [
            "PLN"
        ]
    },
    "data": [
        {
            "paymentMethod": "PME_CARD",
            "paymentMethodName": "string",
            "methodLogoUrl": "string",
            "customerCountry": "PL",
            "paymentChannels": [
                {
                    "paymentChannel": "PCL_CARD",
                    "paymentChannelName": "string",
                    "currencies": [
                        "PLN",
                        "EUR",
                        "USD",
                        "GBP"
                    ],
                    "cryptoCurrencies": [
                        {
                            "walletCurrency": "BTC",
                            "currencyName": "Bitcoin",
                            "currencyCode": "BTC_LIGHTNING",
                            "network": "Lightning Network",
                            "networkLogoUrl": "https://www.zen.com/hubfs/Assets/Top-up/Lightning%20Network.png",
                            "networkCode": "LIGHTNING",
                            "minAmount": "12.03",
                            "maxAmount": "123.04"
                        }
                    ],
                    "cardOrganizations": [
                        {
                            "organization": "COR_VISA",
                            "logoUrl": "string"
                        }
                    ],
                    "channelLogoUrl": "string",
                    "lastUsed": true,
                    "hasAuthorizationFee": true,
                    "hasCashback": true
                }
            ]
        }
    ]
}

🟠404Record Not Found

Returns information about payment methods

Request

Request samples

Responses