Payments

Create a refund

Create a refund. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

post/api/v1/refunds

Request

Idempotency-Keystring

Retry-safe key for create operations.

paymentIdstring required

amountMinorinteger

reasonstring

metadataobject

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

Refund created

idstring required

object'refund' required

livemodeboolean required

createdAtstring date-time required

paymentIdstring required

The payment's id, as GET /api/v1/payments/{id} takes it.

amountMinorinteger required

currencystring required

status'pending' | 'succeeded' | 'failed' required

reasonstring nullable required

metadataobject required

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

No recorded changes to this operation across all 1 revision of this API.