Skip to main content

Payout funds

Use the payout-management API to register payout bank accounts, create manual payouts, and list payout history. These endpoints use an authenticated dashboard Bearer JWT and an organization ID.
The API-reference pages for bank accounts and manual payouts require the Bearer token from an authenticated dashboard session.

Use the payout-management API

For organization-managed payouts, first add a payout bank account, then create a manual payout. Use List payouts to reconcile payout status and history.

Pay a GlobalTravelWallet user

Organizations can disburse funds directly to a GlobalTravelWallet user in any same-currency corridor:
  1. Resolve recipient: Call GET /v1/payout-recipients/gtw/{publicId} with the recipient’s 10-character publicId to verify their masked name and eligible currencies.
  2. Add payout account: Register a beneficiary using POST /v1/payout-accounts with accountType: "gtw_wallet", currency, accountName, and accountNumber set to the publicId.
  3. Execute payout: Create a payout via POST /v1/payouts. Same-currency GTW payouts execute automatically and credit the recipient’s GTW wallet instantly.

Safely handle payouts

Validate the beneficiary’s details before creating a payout. Save the payout ID and reference from the response, then show the recipient and amount in your confirmation. Never automatically retry a payout after an ambiguous network failure without first checking payout history, as a retry can result in a second transfer.