Skip to main content

WithdrawalRecipientRequest

Withdrawal recipient request object.

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.
firstNamestring

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

Possible values: non-empty and <= 50 characters

Example: Tom
lastNamestring

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

Possible values: non-empty and <= 50 characters

Example: Jones
address object

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

emailstring<email>

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 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
idstring

The instrument id

Example: 97266b06c85f4acd9a3f3aa0eed8b11e
instrumentTypeRecipientInstrumentType (string)required

Represents the type of the recipient instrument.

ValueDescription
SEPA_BANK_ACCOUNTSEPA Bank account
UK_BANK_ACCOUNTUK Bank account
US_BANK_ACCOUNTUS Bank account
CCI_BANK_ACCOUNTCCI Bank account
PHONE_NUMBERPhone Number

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

Example: US_BANK_ACCOUNT
typestring

Recipient type.

Possible values: [BUSINESS, INDIVIDUAL]

birthDatestring<date>

Birth date in YYYY-MM-DD format.

Example: 1981-01-11
WithdrawalRecipientRequest
{
  "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": "97266b06c85f4acd9a3f3aa0eed8b11e",
    "instrumentType": "US_BANK_ACCOUNT"
  },
  "type": "BUSINESS",
  "birthDate": "1981-01-11"
}