DocumentationDocumentationAPI ReferenceAPI ReferenceContact ↗Contact ↗ (opens in a new tab)
  • Onbrails API Reference
  • Getting Started with Brails
    • Create Customer [POST]
    • Get Customer [GET]
    • Update Customer [PUT]
    • List Customer [GET]
  • Beneficiaries
    • Get Supported Countries [GET]
    • Get Country Requirement [GET]
    • Add Beneficiary [POST]
    • Get Beneficiary [GET]
    • List Beneficiaries [GET]
  • Payouts
    • Initiate Payout [POST]
    • Finalize Payout [POST]
    • Attach Payout Document [POST]
  • Exchange Rates
    • Get all exchange rates [GET]
    • Get exchange rate by currency [GET]
  • Transactions
    • List Transactions [GET]
    • Get Transaction [GET]
  • Wallets
    • Get Wallets [GET]
    • Initialize Swap [POST]
    • Finalize Swap [POST]
    • Register card user [POST]
    • Create card [POST]
    • Top up card [POST]
    • List cards [GET]
    • List card users [GET]
    • Fetch card user [GET]
    • Fetch card [GET]
    • List transactions on a card [GET]
    • List card transactions [GET]
    • Card withdrawal [POST]
    • Freeze card [POST]
    • Unfreeze card [POST]
    • Mock card transaction [POST]
    • Terminate card [POST]
    • Create virtual account [POST]
    • Get virtual account [GET]
    • Get all virtual accounts [GET]
    • Get all virtual account transactions [GET]
    • Initialize Collection [POST]
Question? Give us feedback → (opens in a new tab)Edit this page
API Reference
Beneficiaries

Beneficiaries


Manage beneficiaries for payouts

Creating beneficiaries for the various countries we support requires custom fields. Please refer to the beneficiary guide to see the sample requests per country.

List Customer [GET]Get Supported Countries [GET]

© 2025 Brails