Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Recipients

Retrieve a recipient

Returns the details of a recipient.

get/recipients/{recipientId}

Path parameters

recipientIdstring required

The recipient's ID.

Example:8lciyups6

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Response

OK

idstring nullable

The recipient's ID.

accountIdstring nullable

The ID of the account to work with.

accountIdentifierstring nullable

Identifier of the account, could be iban or account number

bankIdentifierstring nullable

Identifier of the bank, could be BIC or sort code

schemeName'UK.OBIE.IBAN' | 'UK.OBIE.SortCodeAccountNumber' nullable

The name of the scheme.

namestring nullable

The recipient's name.

friendlyNamestring nullable

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

intermediaryBankIdentifierstring nullable

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

paymentNetwork'SWIFT' | 'SEPA.INSTANT' | 'SEPA.CREDITTRANSFER' | 'CHAPS' | 'UKFPS' | 'ACH' | 'WIRETRANSFER' | 'OFF_PLATFORM' | 'NIP' nullable required
purposeCodestring nullable
emailstring nullable

The recipient's email address.

defaultPurposestring nullable

The purpose of the payment.

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

The recipient's status.

sepaboolean nullable
currencystring required

The currency code, in ISO-4217 format.

bankCodestring nullable
createdBystring nullable
recipientTypestring nullable
verificationMethod'phone' | 'sms_otp' | 'biometrics' | 'email' | 'other' nullable
bankDetailsFormat'bic-accountnumber' | 'usroutingnumber-accountnumber' | 'bic-caroutingnumber-accountnumber' | 'bic-bsb-accountnumber' | 'bic-ifsc-accountnumber' | 'sortcode-accountnumber' | 'bic-clabe' | 'bic-iban' nullable

Example response

{
  "id": "8lciyups6",
  "accountId": "F50091",
  "accountIdentifier": "55555555",
  "bankIdentifier": "395744",
  "schemeName": "UK.OBIE.IBAN",
  "name": "William Walker",
  "friendlyName": "Electrician",
  "intermediaryBankIdentifier": "QBLCCCCV",
  "paymentNetwork": "SWIFT",
  "purposeCode": "string",
  "email": "string",
  "defaultPurpose": "Purpose of the payment",
  "defaultReference": "string",
  "status": "AUTHORISED",
  "sepa": true,
  "currency": "USD",
  "bankCode": "string",
  "createdBy": "string",
  "recipientType": "string",
  "verificationMethod": "phone",
  "recipientAddress": {
    "country": "string",
    "address": "123 Fake Street",
    "city": "London",
    "postcode": "SW1A 1AA"
  },
  "bankAddress": {
    "bankName": "Brilliant Bank",
    "fullBankName": "Brilliant Bank Plc",
    "city": "Enfield",
    "postcode": "EN1 3JY",
    "country": "string",
    "address": "1 High Street"
  },
  "validation": {
    "nameMatch": true,
    "reason": "string",
    "reasonCode": "N000",
    "actualName": "William Walker"
  },
  "bankDetailsFormat": "bic-accountnumber"
}