Create a recipient

Creates a new recipient for a given account. A recipient represents an account you want to make a payout to. You'll need to create a recipient before you can create an order.

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

One of:
required
object

Details about the address of the recipient.

defaultPurpose
required
string or null <= 256 characters

The purpose of the payment.

name
required
string or null <= 256 characters

The recipient's name.

currency
required
string^[A-Z]{3}$

The currency code, in ISO-4217 format.

verificationMethod
required
string
Enum: "phone" "sms_otp" "biometrics" "email" "other"
friendlyName
string or null <= 256 characters

An optional friendly name for the recipient. This is used only for display purposes.

intermediaryBankIdentifier
string or null^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?

The BIC of the intermediary bank.

paymentPurposeCode
string or null^[A-Z0-9]{3,13}$

The payment purpose code, in ISO 200222 format.

email
string or null <email> <= 256 characters

The recipient's email address.

isoCountry
string^[A-Z]{2}$

The bank country

recipientType
string

The type of the recipient.

Enum: "business" "charity" "individual"
accountNumber
required
string^[A-Z0-9-]{5,34}$

The recipient's bank account number.

bankCode
required
string or null^\d{6}$|^\d{9}$

The recipient's bank code.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

post/recipients
Request samples
application/json
{
  • "recipientAddress": {
    },
  • "defaultPurpose": "Purpose of the payment",
  • "name": "William Walker",
  • "currency": "USD",
  • "verificationMethod": "phone",
  • "friendlyName": "Electrician",
  • "intermediaryBankIdentifier": "QBLCCCCV",
  • "paymentPurposeCode": "BKFE",
  • "email": "user@example.com",
  • "isoCountry": "string",
  • "recipientType": "business",
  • "accountNumber": "55555555",
  • "bankCode": "123456"
}
Response samples
application/json
{
  • "recipientId": "8lciyups6",
  • "timestamp": 1672915765801,
  • "message": [
    ]
}