Skip to main content

RecipientPaymentInstrument

Represents a payment instrument, used for third-party payments. Here are the valid instrumentType values:

  • SEPA_BANK_ACCOUNT - IBAN Bank Account for EEA international transfers
  • UK_BANK_ACCOUNT - UK Bank Account for somestic UK transfers
  • US_BANK_ACCOUNT - US Bank Account for domestic USA transfers
    id uuid

    The instrument id

    instrumentType

    string

    required

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

    Represents the type of the recipient instrument.

    ValueDescription
    SEPA_BANK_ACCOUNTSEPA Bank account
    UK_BANK_ACCOUNTUK Bank account
    US_BANK_ACCOUNTUS Bank account
    accountHolderName string

    Possible values: <= 100 characters

    This is the name of the customer or company that owns the bank account.

    iban stringrequired

    The International Bank Account Number (IBAN) of the account.

    bic stringrequired

    The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.

    bankName string

    The bank name.