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.curl -i -X GET \
'https://api-sandbox.equalsmoney.com/v2/recipients?accountId={accountId}' \
-H 'Authorization: ApiKey {apiKey}'
curl -i -X GET \
'https://api.equalsmoney.com/v2/recipients?accountId={accountId}' \
-H 'Authorization: ApiKey {apiKey}'
200 response containing a list of recipients.
"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"
}
},
]
}
curl -i -X GET \
'https://api-sandbox.equalsmoney.com/v2/recipients/{recipientId}?accountId={accountId}' \
-H 'Authorization: ApiKey {apiKey}'
curl -i -X GET \
'https://api.equalsmoney.com/v2/recipients/{recipientId}?accountId={accountId}' \
-H 'Authorization: ApiKey {apiKey}'
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"
}
}