Card Payouts

The Card Payouts API provides access to all endpoints related to sending funds directly to a recipient’s card using the Exirom platform. Card payouts enable merchants to perform outbound transfers such as customer withdrawals, affiliate commissions, vendor payments, and other disbursement use cases.

A card payout is initiated by submitting a payout request with the recipient’s card details and transfer amount. Once submitted, the payout is processed asynchronously through the selected payout provider. Status updates are delivered via webhook callbacks until a terminal state is reached.

A payout request may return an initial status synchronously. If a callbackUrl is provided, Exirom will send webhook notifications reflecting the payout lifecycle and final outcome.

Note: The webhook callback is the authoritative source for the final payout result. An initial API response only confirms that the payout request was accepted for processing.

Card payouts do not require customer interaction, authentication steps, or redirection flows. Funds are transferred directly to the recipient card according to provider processing rules and settlement timelines.

Card Payout Endpoints

POST /v1/payouts/card – Initiate a new card payout transaction. GET /v1/payouts/card/status/{id} – Retrieve the current status of a card payout. GET /v1/payouts/card/info/{id} – Retrieve detailed information for a specific card payout.

API Base URL

Use the following base URLs depending on your environment:

https://$host.com/api/v1/payouts/card

https://sandbox.$host.com/api/v1/payouts/card

Authentication and Request Headers

All card payout requests must include valid authentication and standard headers.

Header	Value	Description
Content-Type	application/json	Specifies that the request body is in JSON format.
Authorization	Bearer `<AUTH_TOKEN>`	Bearer token for authentication. Replace `<AUTH_TOKEN>` with the token from the Authorization Service.

Pages in this Section

This section provides a complete walkthrough for card payout processing:

✅ Initiating a Card Payout – Instructions for creating a card payout request, including required fields, payload structure, and example API calls.

✅ Handling Payout Callbacks – Details on processing webhook notifications, validating payloads, and updating internal systems. ✅ Card Payout Callback DTO – Reference documentation for the payout callback payload and field definitions. ✅ Error Handling – Common payout errors, decline codes, and recommended recovery actions. ✅ Sandbox Card Payout Testing – How to test card payouts in the sandbox environment using test cards and credentials.

Sandbox Testing

Card payouts can be fully tested in the sandbox environment. Sandbox payouts follow the same request structure, status lifecycle, and callback behavior as live payouts, using simulated processing.

⚠️
Note
Sandbox API credentials are required. Please contact your assigned account manager to obtain access.