Payment Methods

Retrieve the list of active payment methods available for the authenticated merchant, including supported currency, amount limits, payment time, and commission split.

Get payment methods

GET /api/v1/payment-methods

Returns the list of active payment methods available for the authenticated merchant.

Authentication

Send your API key in the X-Api-Key header.

X-Api-Key: your_api_key_here

Query parameters

Parameter	Type	Required	Description
`currency`	string	No	Filter by currency code, for example `UAH`, `EUR`. Case-insensitive.

Example request

curl -X GET "https://api.ecca-ex.com/api/v1/payment-methods?currency=UAH" \
  -H "X-Api-Key: your_api_key_here"

Example response

{
  "successful": true,
  "data": [
    {
      "name": "Monobank UA",
      "method_code": "monobank",
      "min_sum": "100.00",
      "max_sum": "10000.00",
      "logo_url": "https://ecca-ex.com/payment-methods/monobank.png",
      "payment_time": 15,
      "currency": {
        "code": "UAH",
        "name": "Ukrainian Hryvnia",
        "symbol": "₴"
      },
      "max_commission": "2.50",
      "client_commission": "2.50",
      "merchant_commission": "0.00"
    },
    {
      "name": "PrivatBank UA",
      "method_code": "privatbank",
      "min_sum": "100.00",
      "max_sum": "15000.00",
      "logo_url": "https://ecca-ex.com/payment-methods/privatbank.png",
      "payment_time": 15,
      "currency": {
        "code": "UAH",
        "name": "Ukrainian Hryvnia",
        "symbol": "₴"
      },
      "max_commission": "2.50",
      "client_commission": "1.00",
      "merchant_commission": "1.50"
    }
  ]
}

Response fields

Top-level response

Field	Type	Description
`successful`	boolean	Indicates whether the request succeeded
`data`	array	List of available payment methods

Payment method fields

Field	Type	Description
`name`	string	Human-readable payment method name
`method_code`	string	Machine-readable payment method code
`min_sum`	string	Minimum supported payment amount for this method
`max_sum`	string	Maximum supported payment amount for this method
`logo_url`	string \| null	Payment method logo URL
`payment_time`	integer	Expected payment time in minutes
`currency.code`	string	Currency code in uppercase
`currency.name`	string	Human-readable currency name
`currency.symbol`	string	Currency symbol
`max_commission`	string	Total commission rate for this method, in percent
`client_commission`	string	Part of the commission paid by the client, in percent
`merchant_commission`	string	Part of the commission paid by the merchant, in percent

Commission logic

Commission values are returned as percentage strings with 2 decimal places.

Example:

max_commission = "2.50" means the total commission for this method is 2.5%
client_commission = "1.00" means the client pays 1.0%
merchant_commission = "1.50" means the merchant pays 1.5%

These values show how the total commission is split between the client and the merchant for each payment method.

Notes

Only active payment methods are returned.
If currency is provided, only payment methods for that currency are returned.
Amount limits are returned as strings.
Commission values are returned as strings.
payment_time is returned in minutes.

Payment method errors

HTTP	Code	Description
`404`	`CURRENCY_NOT_FOUND`	The requested currency code was not found
`400`	`MERCHANT_CATEGORY_MISSING`	Merchant has no category assigned
`400`	`MERCHANT_CATEGORY_NOT_FOUND`	Merchant category was not found
`400`	`MERCHANT_CATEGORY_RATE_INVALID`	Merchant category commission configuration is invalid

Example error

{
  "successful": false,
  "request_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "error": {
    "code": "CURRENCY_NOT_FOUND",
    "message": "Currency not found",
    "currency": "ABC"
  }
}

Was this page helpful?

Last updated today

Built with Documentation.AI