Sign in

v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB
Payments

Create refund

Issues a refund against a payment. The total of refund amounts cannot exceed the payment's amount.

post/refunds/

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Request body

idstring
paymentinteger required

Payment ID being refunded.

amountnumber required
balancenumber

Remaining refundable balance after this refund.

reason'duplicate' | 'fraudulent' | 'requested_by_customer' required
notestring nullable
receiptstring required
status'failed' | 'succeeded'
metadataobject
createdstring date-time
updatedstring date-time

Response

Refund created.

idstring
paymentinteger required

Payment ID being refunded.

amountnumber required
balancenumber

Remaining refundable balance after this refund.

reason'duplicate' | 'fraudulent' | 'requested_by_customer' required
notestring nullable
receiptstring required
status'failed' | 'succeeded'
metadataobject
createdstring date-time
updatedstring date-time