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 domestic UK transfers
  • US_BANK_ACCOUNT - US Bank Account for domestic USA transfers
  • CCI_BANK_ACCOUNT - CCI Bank Account for transfers in Peru
  • PHONE_NUMBER - Phone Number for transfers via phone number
  • QR_CODE - QR Code for transfers via QR code
idstring

The instrument id

Example: 97266b06c85f4acd9a3f3aa0eed8b11e
instrumentTypeRecipientInstrumentType (string)required

Represents the type of the recipient instrument.

| Value | Description| |---|---| | SEPA_BANK_ACCOUNT| SEPA Bank account | | UK_BANK_ACCOUNT | UK Bank account | | US_BANK_ACCOUNT | US Bank account | | CCI_BANK_ACCOUNT | CCI Bank account | | PHONE_NUMBER | Phone Number | | QR_CODE | QR Code |

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, PHONE_NUMBER, QR_CODE]

Example: US_BANK_ACCOUNT
RecipientPaymentInstrument
{
  "id": "97266b06c85f4acd9a3f3aa0eed8b11e",
  "instrumentType": "US_BANK_ACCOUNT"
}