Payout Request APIs
Payout Request APIs provide a comprehensive set of endpoints for initiating, tracking, and reconciling outbound payments to registered beneficiaries — covering both same-currency domestic transfers and cross-currency international remittances.
By integrating with these APIs, organizations can:
Lock FX rates before sending: Use the Payout Inquiry API to obtain a guaranteed exchange rate and fee estimate for cross-currency payouts, eliminating FX uncertainty before committing to a transfer.
Initiate payouts to beneficiaries: Submit single or batch payout requests to domestic and overseas beneficiaries using flexible clearing options (SWIFT, LOCAL, AUTO) and purpose codes that satisfy regulatory reporting requirements.
Track payout outcomes in real time: Poll Get Detail Payout Request at any time to retrieve the current status and details for any payout request, or rely on the
PAYMENT_INITIAL/PAYMENT_RESULTwebhooks for asynchronous notification.
In essence, Payout Request APIs empower you to manage the complete outbound payment lifecycle — from rate locking and payment initiation through to settlement confirmation.
The backend path for every endpoint in this section is /v2/gc/payment-requests — this doc section keeps the "Payout Request" terminology for consistency, but the URLs use payment-requests. Also: Get List Distribution Records is not available — see the notice on that page.
Endpoints
Last updated
Was this helpful?