The Beneficiary APIs offer a set of functionalities to manage beneficiaries within a financial system, allowing businesses to create, view, and manage beneficiary details seamlessly.
Endpoint Descriptions
Create Beneficiary
Add a new beneficiary by providing their relevant details, such as name, account number, bank information, and other personal information. This endpoint validates the information and, upon successful creation, returns a unique beneficiary ID.
Get Beneficiary by ID
Retrieve detailed information about a specific beneficiary by using their unique ID. This endpoint returns comprehensive data on the beneficiary, including personal and account information, making it easy to review or confirm details before initiating a payment.
Get Beneficiaries
Access a complete list of all beneficiaries associated with a user or business account. This endpoint supports filters, such as by status or creation date, to help users quickly find specific beneficiaries or view active contacts.