Skip to main content
POST
/
refunds
Create a Refund
curl --request POST \
  --url https://sandbox.api.hixbe.com/payment/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Hixbe-Version: <hixbe-version>' \
  --data '
{
  "charge": "ch_1Hh2Z3AbCdEf",
  "amount": 500,
  "reason": "requested_by_customer"
}
'
{
  "id": "re_123",
  "charge": "<string>",
  "amount": 123,
  "status": "succeeded",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Use your secret API key. Example: Authorization: Bearer sk_test_xxx

Headers

​
Hixbe-Version
string
default:2026-01-01
required

API version header. Use '2026-01-01' for the latest version.

​
Idempotency-Key
string

Idempotency key for safely retrying POST requests.

Body

application/json
​
charge
string
required
​
amount
integer
​
reason
string

Response

Refund created

​
id
string
required
Example:

"re_123"

​
charge
string
required
​
amount
integer
required
​
status
enum<string>
required
Available options:
pending,
succeeded,
failed
Example:

"succeeded"

​
created_at
string<date-time>