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 or null <= 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 or null <= 255 characters

The default reference for the recipient.

currencyCode
required
string
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SEK" "SGD" "SHN" "SLL" "SOS" "SRD" "SSP" "STN" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XOF" "XPD" "XPF" "XPT" "YER" "ZAR" "ZMK" "ZMW" "ZWD"
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.

paymentNetwork
string or null
Enum: "SWIFT" "SEPA.INSTANT" "SEPA.CREDITTRANSFER" "CHAPS" "UKFPS" "ACH" "WIRETRANSFER"
defaultPurpose
required
string <= 256 characters

The purpose of the payment.

Array of objects or null <= 1 items
required
object

Details about the address of the recipient.

required
object

Details about the bank's address.

Responses
201

Created

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",
  • "paymentNetwork": "SWIFT",
  • "defaultPurpose": "Purpose of the payment",
  • "subscribedEmails": [
    ],
  • "address": {
    },
  • "bankAddress": {
    }
}
Response samples
application/json
{
  • "id": "8lciyups6",
  • "accountId": "F50091",
  • "status": "AUTHORISED",
  • "accountIdentifier": "55555555",
  • "bankIdentifier": "395744",
  • "name": "William Walker",
  • "displayName": "Electrician",
  • "type": "business",
  • "defaultReference": "William Walker",
  • "currencyCode": "USD",
  • "verificationMethod": "phone",
  • "charges": "SHA",
  • "intermediaryBankIdentifier": "QBLCCCCV",
  • "paymentPurposeCode": "BKFE",
  • "paymentNetwork": "SWIFT",
  • "defaultPurpose": "Purpose of the payment",
  • "subscribedEmails": [
    ],
  • "address": {
    },
  • "validation": {
    },
  • "bankAddress": {
    },
  • "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"
}