Skip to main content
POST
/
recipients
/
validate
Validate a recipient
curl --request POST \
  --url https://api.equalsmoney.com/v2/recipients/validate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  }
}
'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

​
accountIdentifier
string
required

Identifier of the account, could be iban or account number

Maximum string length: 34
Example:

"55555555"

​
name
string
required

The recipient's name.

Maximum string length: 256
Example:

"William Walker"

​
type
enum<string>
required

The type of the recipient.

Available options:
business,
charity,
individual
Example:

"business"

​
currencyCode
enum<string>
required
Available options:
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
Example:

"USD"

​
defaultPurpose
string
required

The purpose of the payment.

Maximum string length: 256
Example:

"Purpose of the payment"

​
address
object
required

Details about the address of the recipient.

​
bankAddress
object
required

Details about the bank's address.

​
bankIdentifier
string

Identifier of the bank, could be BIC or sort code

Maximum string length: 20
Example:

"395744"

​
displayName
string | null

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

Maximum string length: 256
Example:

"Electrician"

​
defaultReference
string | null

The default reference for the recipient.

Maximum string length: 255
Example:

"William Walker"

​
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"

​
paymentPurposeCode
string | null

The payment purpose code, in ISO 200222 format.

Pattern: ^[A-Z0-9]{3,13}$
Example:

"BKFE"

​
paymentNetwork
enum<string> | null
Available options:
SWIFT,
SEPA.INSTANT,
SEPA.CREDITTRANSFER,
CHAPS,
UKFPS,
ACH,
WIRETRANSFER
​
subscribedEmails
object[] | null
Maximum array length: 1

Response

201 - application/json

Created

​
id
string
required

The recipient's ID.

Example:

"8lciyups6"

​
status
enum<string>
required

The recipient's status.

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

"AUTHORISED"

​
accountIdentifier
string
required

Identifier of the account, could be iban or account number

Maximum string length: 34
Example:

"55555555"

​
name
string
required

The recipient's name.

Maximum string length: 256
Example:

"William Walker"

​
type
enum<string>
required

The type of the recipient.

Available options:
business,
charity,
individual
Example:

"business"

​
currencyCode
enum<string>
required
Available options:
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
Example:

"USD"

​
defaultPurpose
string
required

The purpose of the payment.

Maximum string length: 256
Example:

"Purpose of the payment"

​
address
object
required

Details about the address of the recipient.

​
bankAddress
object
required

Details about the bank's address.

​
accountId
string

The ID of the account to work with.

Example:

"F50091"

​
bankIdentifier
string

Identifier of the bank, could be BIC or sort code

Maximum string length: 20
Example:

"395744"

​
displayName
string | null

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

Maximum string length: 256
Example:

"Electrician"

​
defaultReference
string | null

The default reference for the recipient.

Maximum string length: 255
Example:

"William Walker"

​
verificationMethod
enum<string>
Available options:
phone,
sms_otp,
biometrics,
email,
other
​
charges
enum<string> | null
Available options:
SHA,
OUR,
BEN
​
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"

​
paymentPurposeCode
string | null

The payment purpose code, in ISO 200222 format.

Pattern: ^[A-Z0-9]{3,13}$
Example:

"BKFE"

​
paymentNetwork
enum<string> | null
Available options:
SWIFT,
SEPA.INSTANT,
SEPA.CREDITTRANSFER,
CHAPS,
UKFPS,
ACH,
WIRETRANSFER
​
subscribedEmails
object[] | null
Maximum array length: 1
​
validation
object
​
dateLastPaid
string<date-time>
​
createdAt
string<date-time>

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

​
updatedAt
string<date-time>

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

​
archivedAt
string<date-time>
​
createdBy
string
​
updatedBy
string