Beneficiary APIs

Beneficiary APIs provide merchants with the tools to register, verify, and manage the payees and bank accounts that are eligible to receive outgoing payout funds through the NeoX Global Collections platform. Before any payout can be initiated, the target recipient — whether a supplier, an overseas business partner, or an internal withdrawal account — must first be registered and activated as a beneficiary or withdrawal card.

By integrating with these APIs, organizations can:

• Register payees and suppliers: Submit beneficiary (payee or supplier) bank account details for verification, covering overseas suppliers, domestic suppliers, and withdrawal accounts across all supported clearing networks (SWIFT, LOCAL).

• Query beneficiary status: Retrieve the current registration status of any beneficiary by its original request ID, enabling merchants to confirm activation before initiating payouts.

• Browse supported banks: Access a paginated list of beneficiary banks supported for payout operations, filterable by country, to assist in validating bank details before registration.

• Register withdrawal cards: Register dedicated withdrawal (cash-out) card accounts that allow merchants and their sub-merchants to receive payout funds directly into a verified bank account.

• Monitor withdrawal card status: Retrieve the registration details and approval status of any withdrawal card to confirm readiness before scheduling payouts.

In essence, Beneficiary APIs empower you to maintain a fully verified roster of payees and withdrawal destinations, ensuring that every payout is directed to a pre-approved, compliant recipient with no delays at settlement time.

Available Endpoints

Endpoint	Method	Description
Register Beneficiary	POST	Register or update a beneficiary for outgoing payouts.
Get Detail Beneficiary	GET	Retrieve registration details and status of a beneficiary.
Get List Beneficiary Banks	GET	Retrieve a paginated list of supported beneficiary banks.
Register Withdrawal Card	POST	Register a withdrawal card account for receiving payout funds.
Get Detail Withdrawal Card	GET	Retrieve registration details and status of a withdrawal card.