APM Payout Flow
How APM payouts (e-wallets, bank transfers) work end-to-end.
APM payouts send funds to a recipient via an alternative payment method — such as an e-wallet, bank transfer, or mobile wallet. The flow is fully server-to-server with no customer redirect required.
#1. Prepare the apmPayload
The apmPayload identifies the recipient and payment method. The required fields depend on the method:
| Method | Key Fields |
|---|---|
| E-wallet (e.g. PayPal) | paymentMethod, email |
| Bank Transfer (SEPA) | paymentMethod, accountHolderName, iban, bic |
| Mobile Wallet | paymentMethod, msisdn |
See APM Payload References for the complete field reference per method.
#2. Compute the Checksum
All APM requests require an HMAC-SHA256 checksum for authentication. See Checksum Authentication for the signing algorithm.
#3. Initiate the Payout
Send POST /api/v1/payouts/apm with the apmPayload, amount, currency, and your callbackUrl. The response returns transactionStatus: "PROCESSING" immediately.
Payout processing is always asynchronous. Never retry on
PROCESSING.
#4. Final Status via Webhook
When the APM provider settles the payout, Exirom sends a webhook to your callbackUrl:
- SUCCEED — funds delivered to recipient
- FAILED — payout rejected by the APM provider
Use GET /api/v1/payouts/apm/status/{id} as a fallback if the webhook is not received.
#Settlement Timing
Settlement timing varies by APM provider and method:
| Method Type | Typical Settlement |
|---|---|
| E-wallet | Near-instant |
| Bank transfer (SEPA) | 1–2 business days |
| Mobile wallet | Varies by carrier |
#Related
- API Reference: POST /api/v1/payouts/apm — Full endpoint spec, Try It
- API Reference: GET /api/v1/payouts/apm/status/{id} — Check APM payout status
- APM Payload References — Complete apmPayload field reference
- Checksum Authentication — HMAC-SHA256 signing
- APM Payment Flow — Incoming payment flow for comparison