v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Refund

The API to refund the charge

post/v1/refund

Headers

X-BUSINESS-API-KEYstring required

Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

amountnumber required

The remaining amount to be refunded.

payment_idstring uuid required

Payment ID for the successful payment request

webhookstring uri

The webhook URL

send_email'true' | 'false'

emailstring email

Example request

{
  "amount": 100.99,
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "webhook": "https://www.google.com",
  "email": "test@gmail.com"
}

Response

200

idstring

refunded_bystring

payment_idstring

amount_refundedinteger

total_amountnumber

currencystring

statusstring

payment_methodstring

provider_feeinteger

provider_fee_currencystring

refunded_atstring

created_atstring

Example response

{
  "id": "9858acaf-edc8-427d-b0e5-c32e1b1543db",
  "refunded_by": "Test QA",
  "payment_id": "984e6b86-f0e2-4283-991c-d8236f67567e",
  "amount_refunded": 13,
  "total_amount": 99.99,
  "currency": "usd",
  "payment_method": "card",
  "provider_fee_currency": "SGD",
  "refunded_at": "2025-05-21T09:17:52.000000Z",
  "created_at": "2023-01-30T16:10:17"
}