Create a refund
Issues a refund against a paid invoice. The refund may be queued for review depending on the portal’s billing configuration.
Authorizations
Body
Refund to create
"inv_123"
Response
OK
Amount is the refunded amount in the smallest currency unit (e.g. cents).
5000
CompletedAt is the RFC 3339 timestamp at which the refund succeeded; absent until then.
"2024-02-20T14:05:00Z"
FailureReason is the reason the refund failed, populated only for failed refunds.
"insufficient_funds"
InvoiceID is the ID of the invoice the refund was issued against.
"550e8400-e29b-41d4-a716-446655440000"
ReceiptKey is the storage key of the refund receipt, when one is available.
"receipts/re_1a2b3c.pdf"
Status is the current state of the refund as it progresses through processing.
pending, succeeded, failed "succeeded"