Guides
API References
- Payment Request
- Recurring Billing
- Charges
- Payout
- Account
- Orders
- Products
- Product Category
- Customers
- Staffs
- Invoice
- Webhook Events
- Static QR Codes
- Notifications
- Terminal
Payment Request
Refund
The API to refund the charge
POST
/
v1
/
refund
Copy
curl --request POST \
--url https://api.sandbox.hit-pay.com/v1/refund \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '{
"amount": 100,
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook": "https://www.google.com",
"send_email": "true",
"email": "test@gmail.com"
}'
Copy
{
"id": "9ef6957e-6b1b-4e08-8cde-d5f5c908418d",
"refunded_by": "QA SG",
"payment_id": "9a934d94-a41f-46c7-a934-c1ebf2436008",
"amount_refunded": 1,
"total_amount": 96.49,
"currency": "sgd",
"status": "succeeded",
"payment_method": "card",
"provider_fee": null,
"provider_fee_currency": null,
"refunded_at": "2025-05-21T09:17:52.000000Z",
"created_at": "2025-05-21T17:17:52"
}
Headers
Example:
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Body
application/json
Response
200 - application/json
200
The response is of type object
.
Was this page helpful?
Copy
curl --request POST \
--url https://api.sandbox.hit-pay.com/v1/refund \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '{
"amount": 100,
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook": "https://www.google.com",
"send_email": "true",
"email": "test@gmail.com"
}'
Copy
{
"id": "9ef6957e-6b1b-4e08-8cde-d5f5c908418d",
"refunded_by": "QA SG",
"payment_id": "9a934d94-a41f-46c7-a934-c1ebf2436008",
"amount_refunded": 1,
"total_amount": 96.49,
"currency": "sgd",
"status": "succeeded",
"payment_method": "card",
"provider_fee": null,
"provider_fee_currency": null,
"refunded_at": "2025-05-21T09:17:52.000000Z",
"created_at": "2025-05-21T17:17:52"
}
Assistant
Responses are generated using AI and may contain mistakes.