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. Most payout flows are server-to-server; some provider routes can return an HPP redirect when extra recipient data is 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.
If you do not have all provider-required fields at payout creation time, send the method identifiers you have. For supported routes, Exirom can redirect the recipient to HPP to collect the missing data. See APM Data Collection.
#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. If no additional data is required, the response usually returns transactionStatus: "PROCESSING" immediately. If data collection is required, redirect the recipient to the returned apmResponseData.redirectUrl.
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/info/{id} as a fallback if the webhook is not received — it returns the status along with declineCode on failure.
#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/info/{id} — Check APM payout status and retrieve full details
- APM Data Collection — HPP collection for provider-required fields
- APM Payload References — Complete apmPayload field reference
- Checksum Authentication — HMAC-SHA256 signing
- APM Payment Flow — Incoming payment flow for comparison