/ Guides / Payments / Tutorial / List all recipients

Step 2: list all recipients

Now that we know you have at least one recipient, let's try getting a list of all the recipients on your account.

SandboxProduction
Copy
Copied
curl -i -X GET \
  'https://api-sandbox.equalsmoney.com/v2/recipients?accountId={accountId}' \
  -H 'Authorization: ApiKey {apiKey}'
Copy
Copied
curl -i -X GET \
  'https://api.equalsmoney.com/v2/recipients?accountId={accountId}' \
  -H 'Authorization: ApiKey {apiKey}'

If your request is successful, you'll receive a 200 response containing a list of recipients.

Copy
Copied
  "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"
      }
    },
  ]
}

You can also retrieve details about a specific recipient, based on their ID.

SandboxProduction
Copy
Copied
curl -i -X GET \
  'https://api-sandbox.equalsmoney.com/v2/recipients/{recipientId}?accountId={accountId}' \
  -H 'Authorization: ApiKey {apiKey}'
Copy
Copied
curl -i -X GET \
  'https://api.equalsmoney.com/v2/recipients/{recipientId}?accountId={accountId}' \
  -H 'Authorization: ApiKey {apiKey}'

If your request is successful, you'll receive a 200 response.

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

Next