Skip to main content
POST
Create a refund
Creates an asynchronous refund request against a successful checkout. See the refunds guide for the lifecycle and constraints.
Rate limited to 1 request per second.

Request

Headers: Authorization: Bearer <client_secret>, Content-Type: application/json, and X-Signature (request signing).
checkout_id
string (uuid)
required
The ID of the checkout to refund β€” the data.id from create checkout.
amount
integer
required
Amount to refund, in cents. Up to the checkout amount minus any previously refunded amounts. Partial refunds are supported; issue several if needed.

Example

Response

200
data.id
string (uuid)
The refund request ID β€” persist it and poll get refund to track completion.
data.attributes.status
string
Starts at requested; progresses through pending to complete (or failed). See the refund lifecycle.

Errors