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
id/requestId, enabling merchants to confirm activation before initiating payouts.Register withdrawal accounts: Register a dedicated withdrawal (cash-out) account that allows merchants and their sub-merchants to receive payout funds directly into a verified bank account — via the same Register Beneficiary API, using
type=WITHDRAW_ACCOUNT.
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.
Get List Beneficiary Banks, Register Withdrawal Card, and Get Detail Withdrawal Card are not available as separate endpoints. Withdrawal accounts are registered/queried through the same Register/Get Beneficiary endpoints using type=WITHDRAW_ACCOUNT — see the notices on those pages.
Available Endpoints
POST
Register a beneficiary (including withdrawal accounts, via type=WITHDRAW_ACCOUNT) for outgoing payouts.
PUT
Update fields on a previously registered beneficiary (only when status is INIT or APPROVED).
POST
Submit supporting documents for a beneficiary in WAIT_SUPPLEMENT status.
Last updated
Was this helpful?