Skip to main content
POST
/
v3
/
refund
/
{id}
/
cancel
Cancel Refund
curl --request POST \
  --url https://service-sandbox.tazapay.com/v3/refund/{id}/cancel \
  --header 'Authorization: Basic <encoded-value>'
{
  "status": "success",
  "message": "refund cancelled successfully.",
  "data": {
    "id": "rfd_afiuabfia23wifaiofnioa12nfianff",
    "object": "refund",
    "payin": "chk_cirsp2sl4ar024j0akj0",
    "amount": 5000,
    "currency": "USD",
    "customer_receives": {},
    "payment_attempt": "pat_ahbfiuahfiuaiofnioain",
    "reason": "Damaged Goods",
    "metadata": {},
    "status": "cancelled",
    "status_description": "",
    "webhook_url": "https://mystore.webhook.tazapay.refund/",
    "created_at": "2023-07-23 23:59:56"
  }
}
A request to cancel the refund can only be made if the refund object is in the initiated state. If the refund is in any other state, the API call will result in an error.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

ID of the existing refund object to be cancelled

Response

200 - application/json

200

​
status
string

Indicates whether the refund creation request was successful.

​
message
string

Describes the outcome of the refund operation.

​
data
object

Contains detailed information about a refund.

​
balance_transaction
string

Balance transaction associated with the refund

​
reference_id
string

Reference id linked to the refund

​
holding_currency
string

Holding currency to which the refund is credited