Skip to main content
POST
Create a refund

Authorizations

X-API-KEY
string
header
required

Body

application/json

Refund to create

invoiceId
string
required
Example:

"inv_123"

Response

OK

amount
integer

Amount is the refunded amount in the smallest currency unit (e.g. cents).

Example:

5000

completedAt
string<date-time>

CompletedAt is the RFC 3339 timestamp at which the refund succeeded; absent until then.

Example:

"2024-02-20T14:05:00Z"

createdAt
string
creatorId
string
data
string
failureReason
string

FailureReason is the reason the refund failed, populated only for failed refunds.

Example:

"insufficient_funds"

id
string
identityId
string
invoiceId
string<uuid>

InvoiceID is the ID of the invoice the refund was issued against.

Example:

"550e8400-e29b-41d4-a716-446655440000"

object
string
previousAttributes
object
receiptKey
string

ReceiptKey is the storage key of the refund receipt, when one is available.

Example:

"receipts/re_1a2b3c.pdf"

ref
string
status
enum<string>

Status is the current state of the refund as it progresses through processing.

Available options:
pending,
succeeded,
failed
Example:

"succeeded"

updatedAt
string