v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB

Recipients

Validate a recipient

Validates a new recipient.

post/recipients/validate

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

accountIdentifierstring required

Identifier of the account, could be iban or account number

bankIdentifierstring

Identifier of the bank, could be BIC or sort code

namestring required

The recipient's name.

displayNamestring nullable

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

type'business' | 'charity' | 'individual' required

The type of the recipient.

defaultReferencestring nullable

The default reference for the recipient.

currencyCode'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' required

intermediaryBankIdentifierstring nullable

The intermediary bank identifier: either a BIC or a numeric account number.

paymentPurposeCodestring nullable

The payment purpose code, in ISO 200222 format.

defaultPurposestring required

The purpose of the payment.

Example request

{
  "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": [
    {
      "name": "William Walker",
      "email": "test@example.com"
    }
  ],
  "address": {
    "countryCode": "AD",
    "address": "123 Fake Street",
    "city": "London",
    "postcode": "SW1A 1AA"
  },
  "bankAddress": {
    "bankName": "Brilliant Bank",
    "fullBankName": "Brilliant Bank Plc",
    "city": "Enfield",
    "postcode": "EN1 3JY",
    "countryCode": "AD",
    "address": "1 High Street"
  }
}

Response

Created

idstring required

The recipient's ID.

accountIdstring

The ID of the account to work with.

status'UNVERIFIED' | 'PENDING' | 'AUTHORISED' | 'REJECTED' required

The recipient's status.

accountIdentifierstring required

Identifier of the account, could be iban or account number

bankIdentifierstring

Identifier of the bank, could be BIC or sort code

namestring required

The recipient's name.

displayNamestring nullable

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

type'business' | 'charity' | 'individual' required

The type of the recipient.

defaultReferencestring nullable

The default reference for the recipient.

verificationMethod'phone' | 'sms_otp' | 'biometrics' | 'email' | 'other'

charges'SHA' | 'OUR' | 'BEN' nullable

intermediaryBankIdentifierstring nullable

The intermediary bank identifier: either a BIC or a numeric account number.

paymentPurposeCodestring nullable

The payment purpose code, in ISO 200222 format.

defaultPurposestring required

The purpose of the payment.

dateLastPaidstring date-time

createdAtstring date-time

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAtstring date-time

The date the Resource was last modified. ISO 8601 format without milliseconds.

archivedAtstring date-time

createdBystring

updatedBystring

Example response

{
  "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": [
    {
      "name": "William Walker",
      "email": "test@example.com"
    }
  ],
  "address": {
    "countryCode": "AD",
    "address": "123 Fake Street",
    "city": "London",
    "postcode": "SW1A 1AA"
  },
  "validation": {
    "nameMatch": true,
    "reason": "string",
    "reasonCode": "N000",
    "actualName": "William Walker"
  },
  "bankAddress": {
    "bankName": "Brilliant Bank",
    "fullBankName": "Brilliant Bank Plc",
    "city": "Enfield",
    "postcode": "EN1 3JY",
    "countryCode": "AD",
    "address": "1 High Street"
  },
  "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"
}