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 (accountId)

The ID of the account to work with.

Example: accountId=F50072
Request Body schema: application/json
required
One of:
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.

name
required
string or null <= 256 characters

The recipient's name.

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 <= 256 characters

The recipient's email address.

defaultPurpose
required
string or null <= 256 characters

The purpose of the payment.

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

The currency code, in ISO-4217 format.

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

The bank country

recipientType
string (recipientType)

The recipient type

Enum: "business" "charity" "individual"
verificationMethod
required
string

The method used to verify the recipient.

Enum: "phone" "sms_otp" "biometrics" "other"
required
object

Details about the recipient's address.

Responses
201

Created

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

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