Skip to main content

WithdrawalRecipient

Withdrawal recipient object. The payment instrument is obfuscated.

idstringrequired

Withdrawal recipient id.

Example: 97266b06c85f4acd9a3f3aa0eed8b11e
statusWithdrawalRecipientStatus (string)required

Recipient status. Recipients are not deleted but kept for reference. Only ACTIVE recipients can be used for withdrawals.

Possible values: [ACTIVE, INACTIVE]

creationTimedate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
labelstring

Label for the recipient. Use this field to label the recipient, if you want to make additional payments to the same party. If not specified the label is generated by combining the title, first name, and last name. If ACTIVE recipient with the same label already exists a number suffix is added.

Possible values: non-empty and <= 100 characters

Example: Supplier1
titlestring

Personal title, Mr., Dr., etc.

Possible values: <= 15 characters

Example: Mr.
firstNamestringrequired

First name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

Example: Tom
lastNamestringrequired

Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

Example: Jones
address objectrequired

Address of the customer.

countryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB
stateProvincestring

US state postal abbreviation. Not used for non-US territories.

Possible values: <= 2 characters

citystringrequired

City.

Possible values: <= 50 characters

Example: London
postalCodestringrequired

Postal code.

Possible values: non-empty and <= 50 characters

Example: E1 6AN
address1stringrequired

The first line of the address.

Possible values: <= 200 characters

Example: 12 Brushfield Street
address2string

The second line of the address.

Possible values: <= 200 characters

contactInfo object

Represents contact information.

mobilestring

Mobile number.

Possible values: <= 50 characters

emailemail

Email.

Possible values: >= 6 characters and <= 100 characters

paymentInstrument objectrequired

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
iduuid

The instrument id

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 |

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

Example: US_BANK_ACCOUNT
typestringrequired

Recipient type.

Possible values: [BUSINESS, INDIVIDUAL]

WithdrawalRecipient
{
  "id": "97266b06c85f4acd9a3f3aa0eed8b11e",
  "status": "ACTIVE",
  "creationTime": "2021-07-15T17:54:12Z",
  "label": "Supplier1",
  "title": "Mr.",
  "firstName": "Tom",
  "lastName": "Jones",
  "address": {
    "countryCode": "GB",
    "stateProvince": "string",
    "city": "London",
    "postalCode": "E1 6AN",
    "address1": "12 Brushfield Street",
    "address2": "string"
  },
  "contactInfo": {
    "mobile": "string",
    "email": "user@example.com"
  },
  "paymentInstrument": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "instrumentType": "US_BANK_ACCOUNT"
  },
  "type": "BUSINESS"
}