Refund: Get Details by ID
Related API Reference
API Reference: Get Payments by ID
Overview
- The Retrieve Refund Details function allows you to access all information related to a specific refund transaction by its ID.
- This includes the refund's current status, the details, and any relevant reference data.
- Use this feature to monitor progress, perform reconciliations, or provide customer support
How It Works
Refund Status Model
The following table summarizes the statuses a refund may go through:
Status | Description |
|---|---|
ACCEPTED | The refund request was received and passed the validations on our side and will be processed shortly |
DECLINED | The refund request was rejected either during internal validation or by the Payment Method. |
REFUND_REQUESTED | The refund has been submitted to the Payment Method Operator for processing. |
REFUND_ISSUED | [Optional] The refund has been formally issued, but the final outcome of money delivery is not yet known and will later be confirmed as either REFUNDED or REFUND_FAILED |
REFUNDED | The Payment Method confirmed that the refund was successfully processed. Money should be returned to the payer. |
REFUND_FAILED | [Optional] The Payment Method confirmed that the refund could not be delivered to the payer. |
ERROR | A technical issue occurred while processing the refund (system error, communication failure, etc.). |
When to Use
- Get details of the refund transaction
- Check the status of a refund operation.
- Audit and reconcile transactions for your records.
- Support customer queries about a specific payment & refund process.
Refund Structure
| Attribute | Description |
|---|---|
Id | Unique identifier of the refund generated by the platform. |
intentId | An ID of the linked intent. |
paymentId | An ID of the original payment, the refund was requested for. |
refundSubmittedAmount | The amount and currency submitted in the original transaction request. |
refundAuthAmount | The amount and currency successfully processed (can differ due to FX or fees). |
refundExchangeRate | The FX rate used for currency conversion if applicable. |
reason | The specified refund reason - free text |
status | Current state of the payment (e.g. ACCEPTED, REFUND_REQUESTED, ...) |
createdAt | Transaction creation date. |
updatedAt | Transaction last update date. |
Updated 6 days ago