Skip to main content

​
Retrieve a recipient’s details

GET /v2/recipients/{recipientId}

​
Request

Use this request to retrieve details about a given recipient, based on their recipientId. 
curl -i -X GET \
  'https://api.equalsmoney.com/v2/recipients/8lqccfgmo?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

​
Path parameters

​
recipientId
string
required
The ID of the recipient that you want to retrieve details for.Allowable values: An existing recipientId

​
Query parameters

​
accountId
string
required
The ID of the account that you want to work with.Allowable values: An existing accountId (≤ 36 characters)

​
Response

If your request is successful, you’ll receive a 200 response. 
{
  "id": "8lqccfgmo",
  "accountId": "F12345",
  "accountIdentifier": "PK94XAOM0400102322019126",
  "bankIdentifier": "QBLCCCCV",
  "schemeName": "UK.OBIE.SortCodeAccountNumber",
  "name": "William Walker",
  "friendlyName": "Electrician",
  "intermediaryBankIdentifier": "QBLCCCCV",
  "paymentPurposeCode": "BKFE",
  "email": "william.walker@example.com",
  "defaultPurpose": "Payment",
  "currency": "GBP",
  "verificationMethod": "sms_otp",
  "recipientAddress": {
    "country": "GB",
    "address": "41 Middle Street",
    "city": "Enfield",
    "postcode": "EN1 3JY"
  },
  "bankAddress": {
    "bankName": "Brilliant Bank",
    "fullBankName": "Brilliant Bank",
    "country": "GB",
    "address": "223 Glossop Road",
    "city": "London",
    "postcode": "N14 4ES"
  }
}
For more detailed information about this request and its response, see the API reference.

​
List all recipients

GET /v2/recipients

​
Request

Use this request to retrieve a list of recipients associated with a given account. 
curl -i -X GET \
  'https://api.equalsmoney.com/v2/recipients?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

​
Query parameters

​
accountId
string
required
The ID of the account that you want to retrieve a list of recipients for.Allowable values: An existing accountId (≤ 36 characters)
​
limit
integer
The maximum number of results to return. For example, limit=25. By default, this is set to 100.Allowable values: [ 1 .. 1000 ]
​
offset
integer
The number of items to skip before returning results. For example, offset=200. By default, this is set to 0.Allowable values: A valid integer
​
search
string
The term(s) to search for. You can use this to filter the results.Allowable values: A valid string
​
deleted
boolean
Whether or not to return deleted recipients.Allowable values: true, false
​
status
string
Filter recipients by status.Allowable values: AUTHORISED, PENDING, UNVERIFIED, REJECTED

​
Response

If your request is successful, you’ll receive a 200 response containing a list of people. 
{
  "limit": 100,
  "offset": 0,
  "count": 2,
  "rows": [
    {
      "id": "8lqccfgmo",
      "accountId": "F12345",
      "accountIdentifier": "PK94XAOM0400102322019126",
      "bankIdentifier": "QBLCCCCV",
      "schemeName": "UK.OBIE.SortCodeAccountNumber",
      "name": "William Walker",
      "friendlyName": "Electrician",
      "intermediaryBankIdentifier": "QBLCCCCV",
      "paymentPurposeCode": "BKFE",
      "email": "william.walker@example.com",
      "defaultPurpose": "Payment",
      "currency": "GBP",
      "verificationMethod": "sms_otp",
      "recipientAddress": {
        "country": "GB",
        "address": "41 Middle Street",
        "city": "Enfield",
        "postcode": "EN1 3JY"
      },
      "bankAddress": {
        "bankName": "Brilliant Bank",
        "fullBankName": "Brilliant Bank",
        "country": "GB",
        "address": "223 Glossop Road",
        "city": "London",
        "postcode": "N14 4ES"
      }
    },
    {
      "id": "8lqccok6g",
      "accountId": "F12345",
      "accountIdentifier": "GB24BKEN10000031510604",
      "bankIdentifier": "QBLCCCCV",
      "schemeName": "UK.OBIE.IBAN",
      "name": "Alison Abraham",
      "friendlyName": "Allie Abraham",
      "intermediaryBankIdentifier": "QBLCCCCV",
      "paymentPurposeCode": "BKFE",
      "email": "alison.abrahm@example.com",
      "defaultPurpose": "Payment with exchange",
      "currency": "USD",
      "verificationMethod": "phone",
      "recipientAddress": {
        "country": "GB",
        "address": "13 Chase Road",
        "city": "Malvern",
        "postcode": "WR13 6DJ"
      },
      "bankAddress": {
        "bankName": "Brilliant Bank",
        "fullBankName": "Brilliant Bank",
        "country": "GB",
        "address": "223 Glossop Road",
        "city": "London",
        "postcode": "N14 4ES"
      }
    },
  ]
}
For more detailed information about this request and its response, see the API reference.

​
Delete a recipient

DELETE /v2/recipients/{recipientId}

​
Request

Use this request to permanently delete a recipient. 
curl -i -X DELETE \
  'https://api.equalsmoney.com/v2/recipients/8lqccfgmo?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

​
Path parameters

​
recipientId
string
required
The ID of the recipient that you want to delete.Allowable values: An existing recipientId

​
Query parameters

​
accountId
string
required
The ID of the account that you want to work with.Allowable values: An existing accountId (≤ 36 characters)

​
Response

If your request is successful, you’ll receive a 200 response containing the updated details for this person. 
{
  "success": true
}
For more detailed information about this request and its response, see the API reference.