Retrieve a recipient

Returns the details of a recipient.

SecurityCommonAuth
Request
path Parameters
recipientId
required
string

The recipient's ID.

Example: 8lciyups6
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
Responses
200

OK

get/recipients/{recipientId}
Request samples 
Response samples 
application/json
{
  • "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": {
    },
  • "bankAddress": {
    },
  • "validation": {
    },
  • "bankDetailsFormat": "bic-accountnumber"
}