Validate a recipient

Validates a new recipient.

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

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

Body

accountIdentifier
required
string <= 34 characters

Identifier of the account, could be iban or account number

bankIdentifier
string <= 20 characters

Identifier of the bank, could be BIC or sort code

name
required
string <= 256 characters

The recipient's name.

displayName
string <= 256 characters

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

type
required
string

The type of the recipient.

Enum: "business" "charity" "individual"
defaultReference
string <= 255 characters

The default reference for the recipient.

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

The currency code, in ISO-4217 format.

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

The BIC of the intermediary bank.

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

The payment purpose code, in ISO 200222 format.

defaultPurpose
required
string <= 256 characters

The purpose of the payment.

Array of objects <= 1 items
required
object
object
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

post/recipients/validate
Request samples
application/json
{
  • "accountIdentifier": "55555555",
  • "bankIdentifier": "395744",
  • "name": "William Walker",
  • "displayName": "Electrician",
  • "type": "business",
  • "defaultReference": "William Walker",
  • "currencyCode": "USD",
  • "intermediaryBankIdentifier": "QBLCCCCV",
  • "paymentPurposeCode": "BKFE",
  • "defaultPurpose": "Purpose of the payment",
  • "subscribedEmails": [
    ],
  • "address": {
    },
  • "bankAddress": {
    }
}
Response samples
application/json
{
  • "accountIdentifier": "55555555",
  • "bankIdentifier": "395744",
  • "name": "William Walker",
  • "displayName": "Electrician",
  • "type": "business",
  • "defaultReference": "William Walker",
  • "currencyCode": "USD",
  • "intermediaryBankIdentifier": "QBLCCCCV",
  • "paymentPurposeCode": "BKFE",
  • "defaultPurpose": "Purpose of the payment",
  • "subscribedEmails": [
    ],
  • "address": {
    },
  • "bankAddress": {
    },
  • "id": "string",
  • "status": "AUTHORISED",
  • "validation": {
    },
  • "dateLastPaid": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "archivedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string"
}