Retrieve a recipient

Returns the details of a recipient.

SecurityCommonAuth
Request
path Parameters
recipientId
required
string (recipientId) <= 32 characters

The ID of the recipient to work with.

Example: dqm2gplzpd3brjeu22
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50072
Responses
200

OK

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

get/recipients/{recipientId}
Request samples 
Response samples 
application/json
{
  • "accountId": "F12345",
  • "accountIdentifier": "PK94XAOM0400102322019126",
  • "bankIdentifier": "QBLCCCCV",
  • "schemeName": "UK.OBIE.IBAN",
  • "id": "string",
  • "name": "William Walker",
  • "friendlyName": "Electrician",
  • "intermediaryBankIdentifier": "QBLCCCCV",
  • "purposeCode": "string",
  • "email": "string",
  • "defaultPurpose": "string",
  • "defaultReference": "string",
  • "sepa": true,
  • "currency": "USD",
  • "bankCode": "string",
  • "createdBy": "string",
  • "recipientType": "string",
  • "verificationMethod": "phone",
  • "recipientAddress": {
    },
  • "bankAddress": {
    },
  • "bankDetailsFormat": "bic-iban"
}