POST
Create a refund

Authorizations

x-api-key
string
header
required

Server-side merchant API key. Never expose it in browser code.

Headers

Idempotency-Key
string

Retry-safe key for create operations.

Body

application/json
paymentId
string
required
amountMinor
integer
Required range: x >= 1
reason
string
metadata
object

Response

Refund created

id
string
required
paymentId
string
required
amount
object
required
status
enum<string>
required
Available options:
pending,
succeeded,
failed,
cancelled
reason
string
metadata
object