PayoutMethod-Request

From Barion Documentation
Jump to navigation Jump to search

Payout method

This structure represents a payout method associated with a recipient.

Included in

Payout methods are used in the following structures:

Property list

Property name Property type Limitations and constraints Description
bankTransfer Object
  • Required
Bank transfer details object.
bankTransfer.accountNumber String
  • Required
The bank account number. Format depends on the accountNumberFormat property.
bankTransfer.accountNumberFormat String
  • Required
Format of the account number. Accepted values:
  • iban
  • bban_hu
  • bban_cz
  • bban_pl
bankTransfer.bankAccountCountry String
  • Required
Country of the bank account. Must be a valid ISO 3166-1 Alpha-3 code.
bankTransfer.currency String
  • Required
  • Length: 3 characters
Currency of the bank account. Accepted values:
  • CZK — Czech koruna
  • EUR — Euro
  • HUF — Hungarian forint
  • PLN — Polish złoty
  • RON — Romanian leu
  • USD — U.S. dollar
bankTransfer.bankSwiftCode String
  • Required if accountNumberFormat is iban
  • Length: 8–11 characters
SWIFT/BIC code of the bank.
bankTransfer.address Object
  • Required for foreign transfers (see restrictions)
Address of the bank account holder. Not required for the following combinations:
  • Hungary (HUN) with HUF
  • Poland (POL) with PLN
  • Czech Republic (CZE) with CZK
bankTransfer.address.country String
  • Required
Country of the address. Must be a valid ISO 3166-1 Alpha-3 code.
bankTransfer.address.city String
  • Required
City of the address.
bankTransfer.address.zip String
  • Required
  • Maximum length: 16 characters
Postal code.
bankTransfer.address.street String
  • Required
Street address.
bankTransfer.bankAccountHolderName Object
  • Required
Name details of the bank account holder.
bankTransfer.bankAccountHolderName.nameType String
  • Required
Type of the account holder. Accepted values: business or individual.
bankTransfer.bankAccountHolderName.companyName String
  • Required if nameType is business
  • Maximum length: 100 characters
Name of the company.
bankTransfer.bankAccountHolderName.firstName String
  • Required if nameType is individual
  • Maximum length: 45 characters
First name of the account holder.
bankTransfer.bankAccountHolderName.lastName String
  • Required if nameType is individual
  • Maximum length: 45 characters
Last name of the account holder.

Additional length restrictions:

Additional character limits apply to address fields depending on currency:

  • For CZK currency:
    • Street: maximum 35 characters
    • City: maximum 35 characters
  • For HUF, EUR, and USD currencies:
    • Sum of Street, City, and Zip: maximum 54 characters