Skip to main content
POST
This endpoint creates a refund for a captured payment. Refunds can be partial or full amount.

Authentication

This endpoint requires a valid API key with payments:write permissions.

Path Parameters

id
string
required
The payment ID to refund

Request Body

amount
integer
Amount to refund in cents (defaults to full payment amount)
reason
string
required
Refund reason: “duplicate”, “fraudulent”, “requested_by_customer”, “defective”, “other”
notes
string
Internal notes about the refund
notify_customer
boolean
Whether to send refund notification email (default: true)
metadata
object
Additional metadata for the refund

Response

Returns the refund object.