PayoutMethod-Response

From Barion Documentation
Jump to navigation Jump to search

Payout method

This structure represents a payout method associated with a recipient in a response.

Included in

Payout methods are used in the following structures:

Property list

Property name Property type Description
id String Unique identifier of the payout method. Format: pout_<ordered-base64-ulid>.
methodType String Type of the payout method. Currently only bank_transfer.
bankTransfer Object Present if methodType is bank_transfer.
bankTransfer.accountNumber String The bank account number. Format depends on the accountNumberFormat property.
bankTransfer.accountNumberFormat String Format of the account number. Accepted values:
  • iban
  • bban_hu
  • bban_cz
  • bban_pl
bankTransfer.bankAccountCountry String Country of the bank account. Must be a valid ISO 3166-1 Alpha-3 code.
bankTransfer.bankAccountCurrency String Currency of the bank account. Length: 3 characters. Accepted values:
  • CZK — Czech koruna
  • EUR — Euro
  • HUF — Hungarian forint
  • PLN — Polish złoty
  • RON — Romanian leu
  • USD — U.S. dollar
bankTransfer.bankSwiftCode String SWIFT/BIC code of the bank. Length: 8–11 characters. null if accountNumberFormat is not iban.
bankTransfer.isDeleted bool Indicates whether the payout method has been deleted.
bankTransfer.address Object 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 Country of the address. Must be a valid ISO 3166-1 Alpha-3 code.
bankTransfer.address.city String City of the address.
bankTransfer.address.zip String Postal code. Maximum length: 16 characters.
bankTransfer.address.street String Street address.
bankTransfer.bankAccountHolderName Object Name details of the bank account holder.
bankTransfer.bankAccountHolderName.nameType String Type of the recipient. Accepted values: business or individual.
bankTransfer.bankAccountHolderName.companyName String Name of the company. Only present if nameType is business.
bankTransfer.bankAccountHolderName.firstName String First name of the account holder. Only present if nameType is individual.
bankTransfer.bankAccountHolderName.lastName String Last name of the account holder. Only present if nameType is individual.