The Beneficiaries module allows users to create, manage, and maintain payout recipients for domestic and international transfers.
Users can first retrieve the required form structure using the Get Beneficiary Form Fields API, which dynamically returns mandatory fields based on beneficiary type (Individual or Business), recipient country, and currency.
Using the Create Beneficiary API, users can add new beneficiaries by providing the required personal or business details, address information, and bank account details. Once created, beneficiaries are stored securely and can be reused for future payout transactions.
The List Beneficiaries API allows users to view all added beneficiaries with support for filtering and search, making beneficiary management simple and efficient. For detailed review, the View Beneficiary API provides complete beneficiary information, including banking and address details.
If a beneficiary is no longer required, users can remove it using the Delete Beneficiary API, ensuring accurate and up-to-date beneficiary records.
Together, these APIs provide a flexible and compliant workflow for managing beneficiaries and enabling seamless payout operations.