Skip to main content
POST
Refund

Headers

X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json
amount
number
required

The remaining amount to be refunded.

Example:

100.99

payment_id
string<uuid>
required

Payment ID for the successful payment request

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

webhook
string<uri>

The webhook URL

Example:

"https://www.google.com"

send_email
enum<string>
Available options:
true,
false
email
string<email>

Response

200 - application/json

200

id
string
Example:

"9858acaf-edc8-427d-b0e5-c32e1b1543db"

refunded_by
string
Example:

"Test QA"

payment_id
string
Example:

"984e6b86-f0e2-4283-991c-d8236f67567e"

amount_refunded
integer
default:0
Example:

13

total_amount
number
default:0
Example:

99.99

currency
string
Example:

"usd"

status
string
default:succeeded
payment_method
string
Example:

"card"

provider_fee
integer
Example:

1.1

provider_fee_currency
string
Example:

"SGD"

refunded_at
string
Example:

"2025-05-21T09:17:52.000000Z"

created_at
string
Example:

"2023-01-30T16:10:17"

Last modified on June 11, 2026