Skip to main content

Overview

The Beneficiaries API provides operations for managing beneficiaries used in payments. You can create, update, retrieve, and list beneficiaries through this API.

Creating Beneficiaries​

To create beneficiaries, make a POST request to the /api/v1/beneficiaries endpoint. The request body should include a BeneficiaryRequest object. For more details, please refer to the Create Beneficiary API documentation.

info

If you attempt to create a beneficiary with an accountNumber that already exists, the system will detect the duplicate and respond with a 409 Conflict error. In this case, you should update the existing beneficiary instead.:::

Updating a Beneficiary​

To update a beneficiary, make a PUT request to the /api/v1/beneficiaries/{id} endpoint. The request body should include an BeneficiaryRequest object.

For more details, please refer to the Update Beneficiary API documentation.

info

Each time a beneficiary is updated, a new unique ID is generated. The previous beneficiary ID becomes invalid after the update.

Retrieving a Beneficiary​

To retrieve a beneficiary, make a GET request to the /api/v1/beneficiaries/{id} endpoint. For more details, please refer to the Get Beneficiary API documentation.

Listing beneficiaries​

To list all beneficiaries, make a GET request to the /api/v1/beneficiaries endpoint. For more details, please refer to the List beneficiaries API documentation.