Skip to main content

Overview

A beneficiary is the recipient of a payout. You create a beneficiary once with their identity and payment details, then reference them by ID whenever you send a payout. Beneficiaries can be:
  • Individuals — a person receiving funds (freelancer, contractor, customer refund)
  • Businesses — a company receiving funds (supplier, vendor, partner)

Creating a beneficiary

curl https://api.antonpayments.com/v1/beneficiaries \
  -X POST \
  -H "Authorization: Bearer ak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "individual",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "[email protected]",
    "country": "GB",
    "currency": "GBP",
    "bank_account": {
      "account_number": "12345678",
      "sort_code": "123456"
    }
  }'

Payment details

Beneficiaries need payment routing information. The required fields depend on the destination country and rail:
Country/RailRequired Fields
US (ACH)account_number, routing_number
UK (FPS)account_number, sort_code
EU (SEPA)iban
International (SWIFT)iban or account_number, swift_code

Instruments

For beneficiaries that receive payments through multiple methods (e.g., bank account and mobile wallet), you can attach multiple instruments to a single beneficiary. See the Instruments API for details.

Beneficiary verification

In production, beneficiaries undergo compliance screening when first used in a payout. This includes:
  • Name matching — Verifying the name matches the bank account holder
  • Sanctions screening — OFAC, PEP, and global sanctions list checks
  • Country checks — Ensuring the destination country is not blocked
Beneficiary screening happens automatically during payout creation. You don’t need to call a separate verification endpoint.

Listing beneficiaries

Retrieve all beneficiaries with pagination:
curl "https://api.antonpayments.com/v1/beneficiaries?limit=20&offset=0" \
  -H "Authorization: Bearer ak_test_..."

Deleting beneficiaries

Deleting a beneficiary is permanent. Any pending payouts to this beneficiary will still complete, but you won’t be able to create new payouts to them.
curl https://api.antonpayments.com/v1/beneficiaries/ben_abc123 \
  -X DELETE \
  -H "Authorization: Bearer ak_test_..."