Cards Refund

Refunds

The Refunds API provides access to all endpoints related to reversing previously processed transactions within the Exirom platform. Refunds allow merchants to return funds to a customer for a completed payment, either partially or in full, using the original payment method and processing context.

Refunds are always linked to an existing transaction and require a valid transactionId from the original payment. Once a refund request is submitted, Exirom processes it asynchronously through the original payment provider and reports status updates via webhook callbacks.

A refund request may return an initial status synchronously. If a callbackUrl was provided, Exirom will also send webhook notifications reflecting the refund lifecycle until a terminal status is reached.

Note: The webhook callback is the authoritative source for the final refund outcome. While an initial response may indicate that the refund was accepted for processing, the final success or failure is confirmed only once the callback is received.

Refunds preserve the original transaction context, including currency, FX rate (if applicable), and payment routing. The refund amount is always specified in the original order currency, while any currency conversion back to the customer is handled automatically by the platform.

Refunds do not require customer interaction and do not involve redirection or authentication steps such as 3D Secure.

Refund Endpoints

POST /v1/payments/refund – Initiate a full or partial refund for an existing transaction. GET /v1/payments/refund/status/{id} – Retrieve the current status of a refund transaction. GET /v1/payments/refund/info/{id} – Retrieve detailed information for a specific refund.

API Base URL

Use the following base URLs depending on your environment:

https://$host.com/api/v1/payments/refund

https://sandbox.$host.com/api/v1/payments/refund

Authentication and Request Headers

All refund requests must include the same authentication and header requirements as payment requests.

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 refund processing:

✅ Initiating a Refund – Instructions for creating a full or partial refund request, including required fields and example payloads.updating internal systems. ✅ FX Refund Behavior – Rules and examples for refunds involving currency conversion, including callback amount handling. ✅ Sandbox Refund Testing – How to test refunds in the sandbox environment using test transactions and credentials.