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

string
required
The payment ID to refund

Request Body

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

Response

Returns the refund object.