Skip to main content
GET
/
recipients
/
{recipientId}
Retrieve a recipient
curl --request GET \
  --url https://api.equalsmoney.com/v2/recipients/{recipientId} \
  --header 'Authorization: <api-key>'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
recipientId
string
required

The recipient's ID.

Example:

"8lciyups6"

Query Parameters

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Response

200 - application/json

OK

​
paymentNetwork
enum<string> | null
required
Available options:
SWIFT,
SEPA.INSTANT,
SEPA.CREDITTRANSFER,
CHAPS,
UKFPS,
ACH,
WIRETRANSFER
​
status
enum<string>
required

The recipient's status.

Available options:
UNVERIFIED,
PENDING,
AUTHORISED,
REJECTED
Example:

"AUTHORISED"

​
currency
string
required

The currency code, in ISO-4217 format.

Pattern: ^[A-Z]{3}$
Example:

"USD"

​
id
string | null

The recipient's ID.

Example:

"8lciyups6"

​
accountId
string | null

The ID of the account to work with.

Example:

"F50091"

​
accountIdentifier
string | null

Identifier of the account, could be iban or account number

Maximum string length: 34
Example:

"55555555"

​
bankIdentifier
string | null

Identifier of the bank, could be BIC or sort code

Maximum string length: 20
Example:

"395744"

​
schemeName
enum<string> | null

The name of the scheme.

Available options:
UK.OBIE.IBAN,
UK.OBIE.SortCodeAccountNumber
​
name
string | null

The recipient's name.

Maximum string length: 256
Example:

"William Walker"

​
friendlyName
string | null

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

Maximum string length: 256
Example:

"Electrician"

​
intermediaryBankIdentifier
string | null

The BIC of the intermediary bank.

Pattern: ^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?
Example:

"QBLCCCCV"

​
purposeCode
string | null
​
email
string | null

The recipient's email address.

Maximum string length: 256
​
defaultPurpose
string | null

The purpose of the payment.

Maximum string length: 256
Example:

"Purpose of the payment"

​
defaultReference
string | null
​
sepa
boolean | null
​
bankCode
string | null
​
createdBy
string | null
​
recipientType
string | null
​
verificationMethod
enum<string> | null
Available options:
phone,
sms_otp,
biometrics,
email,
other
​
recipientAddress
object

Details about the address of the recipient.

​
bankAddress
object

Details about the bank's address.

​
validation
object
​
bankDetailsFormat
enum<string> | null
Available options:
bic-accountnumber,
usroutingnumber-accountnumber,
bic-caroutingnumber-accountnumber,
bic-bsb-accountnumber,
bic-ifsc-accountnumber,
sortcode-accountnumber,
bic-clabe,
bic-iban