Retrieve a recipient - Equals Documentation

GET

recipients

{recipientId}

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/recipients/{recipientId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/recipients/{recipientId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.equalsmoney.com/v2/recipients/{recipientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.equalsmoney.com/v2/recipients/{recipientId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/recipients/{recipientId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

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

paymentNetwork

enum<string> | null

required

Available options:

SWIFT,

SEPA.INSTANT,

SEPA.CREDITTRANSFER,

CHAPS,

UKFPS,

ACH,

WIRETRANSFER,

OFF_PLATFORM,

NIP

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"

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 intermediary bank identifier: either a BIC or a numeric account number.

Pattern: ^([0-9]+|[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?)$

Example:

"QBLCCCCV"

purposeCode

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.

Show child attributes

bankAddress

object

Details about the bank's address.

Show child attributes

validation

object

Show child attributes

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

⌘I

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/recipients/{recipientId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/recipients/{recipientId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.equalsmoney.com/v2/recipients/{recipientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.equalsmoney.com/v2/recipients/{recipientId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/recipients/{recipientId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
}