Withdrawal API
Withdrawals use provider-backed rails and must pass eligibility, fee, hold, risk, and provider-status checks before they are finalized.
Active Rail Families
- Mobile money withdrawals via routed payout partners
- International payouts via routed global payout partners
- Card balance withdrawal back to the linked wallet
- Merchant withdrawal-to-EgaCard through signed merchant APIs
Endpoints
| Endpoint | Method | Auth | Headers | Notes |
|---|---|---|---|---|
Create mobile money transfer/payment/api/v1/mobile-money/transfers/Hold funds, initiate a provider payout, and finalize or release based on provider response. |
POST | User JWT Authenticated user |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Webhooks: withdrawal.successful, wallet.debited Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Create international transfer/payment/api/v1/international/transfers/Initiate a cross-border payout using a routed international partner. |
POST | User JWT Authenticated user |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Webhooks: withdrawal.successful Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Withdraw to EgaCard from merchant/business/api/v1/public/wallets/withdraw-to-egacard/Merchant-signed API to credit an EgaCard wallet from an external platform. |
POST | Merchant HMAC Approved active merchant |
X-EGACARD-API-KEY: <merchant-public-key>X-EGACARD-SIGNATURE: <hmac-signature>X-EGACARD-TIMESTAMP: <unix-timestamp>X-EGACARD-IDEMPOTENCY-KEY: <unique-request-key> |
Idempotency: Required Webhooks: wallet.credited Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |