Get Supported Payout Parameters

Retrieves parameter values accepted by Create Payout for an optional payoutType and required country. The endpoint currently supports bank payouts in Russia (RU) and returns the available bankCode values. When payoutType is omitted, it defaults to bank.

Call this endpoint before presenting bank options or submitting a payout to avoid using an unsupported or outdated bank code.

Request

• Method: POST
• Path: /api/v1/payout/supportedParameters
• Content-Type: application/json
• Authentication: Merchant authentication and request signing are required. See Authentication

Request fields

Field	Type	Length / constraints	Required	Example	Description
payoutType	string	bank	No	bank	Payout type; defaults to bank when omitted and currently only supports bank
country	string	2 characters, ISO-3166	Yes	RU	Two-letter country code; currently only RU is supported

Request example

{
  "payoutType": "bank",
  "country": "RU"
}

Use the exact raw JSON request body when generating the signature. See Authentication for signature headers and timestamp rules.

Response example

{
  "result": {
    "code": "S0000",
    "msg": "Payout supported parameters query success"
  },
  "data": {
    "type": "bank",
    "field": "bankCode",
    "parameters": [
      {
        "bankCode": "NORVIK",
        "bankName": "Norvik Bank"
      },
      {
        "bankCode": "OZON",
        "bankName": "OZON"
      }
    ]
  }
}

The example shows only part of the bankCode list. Always use the complete list returned by the endpoint. The current RU/bank response contains 204 bank codes.

Response fields

Field	Type	Always returned	Description
result	object	Yes	Request result
data	object	On success	Parameters supported by the country and payout type

result object

Field	Type	Always returned	Example	Description
code	string	Yes	S0000	Response code; S0000 indicates success
msg	string	Yes	Payout supported parameters query success	Response message

data object

Field	Type	Always returned	Example	Description
type	string	Yes	bank	Corresponds to payoutMethod.type in Create Payout
field	string	Yes	bankCode	Create Payout field represented by each item in parameters
parameters	object[]	Yes	—	Parameter values supported by the country and payout type

data.parameters item

Field	Type	Always returned	Description
bankCode	string	Yes	Bank code accepted as payoutMethod.bank.bankCode when creating a bank payout
bankName	string	Yes	Bank display name

Error responses

Error responses also use result.code and result.msg:

Code	Scenario	Description
C0002	Unsupported parameter combination	Currently only payoutType=bank and country=RU are supported
C0003	Invalid signature	Invalid signature or timestamp, or request outside the allowed time window
C0004	Merchant authentication failed	Missing authentication headers or invalid merchant/API key

Unsupported payout type example:

{
  "result": {
    "code": "C0002",
    "msg": "Unsupported payoutType: e-wallet"
  }
}

Related links

• Authentication: Merchant authentication and request signing
• Create Payout: Use a returned bankCode to create a payout