This endpoint is used to initiate a refund for a previously successful payment transaction. Refunds are processed asynchronously and may require settlement confirmation from the acquiring bank or local payment partner.\ You can use this endpoint to trigger partial or full refunds, depending on your integration.
💸 Refund Request
Endpoint:
POST https://secure.carusell.world/pay/refund
🕒 Recent Requests
Log in with your api_key to view request and response history.
📥 Request Structure
The request must contain two key parameters:
data: A base64-encoded JSON string with refund request details.sign: A HMAC-SHA256 signature based on the encodeddata, created using yoursecret_key.
Signature Formula:
sign = HMAC_SHA256(base64(data), secret_key)🔧 Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
data | string | ✅ | A base64-encoded JSON string with refund details (e.g. transaction ID, amount, reason) |
sign | string | ✅ | HMAC signature created using the data and your secret_key |
✅ Response
Status Code: 200 OK
Example:
{
"status": "received",
"refund_id": "rfd_123456",
"message": "Refund request submitted"
}Refund status should be checked later using the /get_orders_data endpoint or via webhook notifications.
### 📄 Description
Use this endpoint to request a full or partial refund of a successfully processed payment via the Carusell Payment Gateway.
You must send a `data` object (base64-encoded JSON) that includes refund information, and a `sign` parameter generated using your `secret_key` for request verification.
Once submitted, the refund request is queued and processed by the appropriate acquiring partner. Final status can be tracked via `/get_orders_data` or callbacks.