POST
/
v1
/
refund
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": 123,
  "payment_id": "<string>",
  "webhook": "<string>",
  "send_email": true,
  "email": "<string>"
}'
"{\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}"

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json
​
amount
integer
required

Amount to refund

​
payment_id
string
required

Payment ID for the successful payment request

​
webhook
string

The webhook URL

​
send_email
boolean
​
email
string

Response

200 - application/json
200
​
id
string
Example:

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

​
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"

​
created_at
string
Example:

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

Was this page helpful?