Step 1: create a recipient

To send funds to a third party, you first need to create a recipient (beneficiary). Once you submit your request, we'll double-check that the bank details you've provided are valid.

info

We also provide an endpoint that allows you to validate bank details without having to create a recipient. This endpoint isn't enabled by default, so please contact your account manager if you'd like to use it.

In this example, we're using a bank account number and bank code, but you can also supply an account number and BIC, or an IBAN. See the API reference for more information.

SandboxProduction

Copy

Copied

curl -i -X POST \
  'https://api-sandbox.equalsmoney.com/v2/recipients?accountId={accountId}' \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountNumber": "31510604",
    "bankCode": "100000",
    "name": "William Walker",
    "currency": "USD",
    "verificationMethod": "phone",
    "recipientAddress": {
      "country": "GB"
    }
  }'

Copy

Copied

curl -i -X POST \
  'https://api.equalsmoney.com/v2/recipients?accountId={accountId}' \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountNumber": "31510604",
    "bankCode": "100000",
    "name": "William Walker",
    "currency": "USD",
    "verificationMethod": "phone",
    "recipientAddress": {
      "country": "GB"
    }
  }'

If your request is successful, you'll receive a 201 response and a RecipientCreated webhook.

Copy

Copied

{
  "recipientId": "8lciyups6",
  "timestamp": 1672915765801
}