Payment Request
Refund
Payment Request
Refund
POST
/v1/refund
X-BUSINESS-API-KEY*
X-Requested-With
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": 0,
"payment_id": "<payment_id>"
}'{
"status": "200",
"example": "{\n \"id\": \"9858acaf-edc8-427d-b0e5-c32e1b1543db\",\n \"payment_id\": \"984e6b86-f0e2-4283-991c-d8236f67567e\",\n \"amount_refunded\": 13,\n \"total_amount\": 99.99,\n \"currency\": \"usd\",\n \"status\": null,\n \"payment_method\": \"card\",\n \"created_at\": \"2023-01-30T16:10:17\"\n}"
}Authorizations
X-BUSINESS-API-KEYheaderrequired
string
Headers
X-Requested-With
Default: "XMLHttpRequest"string
Body
application/json
amountrequired
integer
Amount to refund
email
string
payment_idrequired
string
Payment ID for the successful payment request
send_email
boolean
webhook
string
The webhook URL
Response
200 - application/json
amount_refunded
Default: "0"integer
created_at
string
currency
string
id
string
payment_id
string
payment_method
string
status
any
total_amount
Default: "0"number
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": 0,
"payment_id": "<payment_id>"
}'{
"status": "200",
"example": "{\n \"id\": \"9858acaf-edc8-427d-b0e5-c32e1b1543db\",\n \"payment_id\": \"984e6b86-f0e2-4283-991c-d8236f67567e\",\n \"amount_refunded\": 13,\n \"total_amount\": 99.99,\n \"currency\": \"usd\",\n \"status\": null,\n \"payment_method\": \"card\",\n \"created_at\": \"2023-01-30T16:10:17\"\n}"
}