Internal APM Redirect Flow
Force APM payments or payouts through the internal hosted checkout.
The internal APM redirect flow sends the customer to the Exirom hosted checkout before the transaction is submitted to the payment provider. It is available for both APM payments and payouts.
#Requesting the Redirect
Set requireInternalRedirectFlow to true in a payment request or payout request.
The flag works with either a minimal apmPayload or a payload that already contains method-specific data. Fields already present in the request remain attached to the transaction.
The hosted form is driven by the fields configured for the selected account and route. The flag controls whether the internal redirect is required; it does not change which fields are configured for collection.
#Redirect Response
When the internal flow is required, the initial API response contains:
transactionStatus: CUSTOMER_VERIFICATIONapmResponseData.actionType: REDIRECTIONapmResponseData.redirectUrlwith the hosted checkout URL
Redirect the customer's browser to the returned URL exactly as provided. After the customer submits the form, Exirom continues the same transaction and sends it to the selected payment provider. Use your callback endpoint or the transaction status endpoint to obtain later status changes.
#How the Decision Is Made
An internal redirect can be required by the request flag, by account configuration, or by the selected route's APM Data Collection settings.
Setting the request flag to false, or omitting it, disables only the request-level opt-in. It does not override account-level or routing rules that require the redirect.
#See Also
- APM Data Collection — How route-driven collection works
- APM Payment API — Payment request and response fields
- APM Payout API — Payout request and response fields