Retrieve beneficiaries
Retrieve a list of beneficiaries
Call Get list of beneficiaries API to retrieve saved beneficiary information. You can specify the time period when the beneficiary was created (from_date, to_date) and the pagination parameters (page_num, page_size) to refine the results. You can also use other filters such as bank_account_number, company_name, entity_type, and nick_name. The response will return a list of beneficiaries, each in the same manner as in the response body of Create a beneficiary API.
Example request
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.
Example response
Retrieve details of a beneficiary
Call Get a beneficiary by ID API to retrieve details of a specific saved beneficiary, by specifying the beneficiary_id in the endpoint URL. A successful request will return the beneficiary details in the same manner as in the response body of Create a new beneficiary API.
Example request
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.