AI agent? Read this page as Markdown at /payment/refund/model.md — append .md to any docs URL, or start from /llms.txt.

Refund data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
total_amountnumber
payment_idstring
(reference to PaymentPayment)
currencystring
notesstring
status enum
Valid values:
"SUCCEEDED"
"PENDING"
"FAILED"
"CANCELED"
referencestring
refunded_atdate
Date and time the refund occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
reason enum
Valid values:
"DUPLICATE"
"FRAUDULENT"
"REQUESTED_BY_CUSTOMER"
"OTHER"
Why the refund was issued
tender_type enum
Valid values:
"CARD"
"CASH"
"GIFT_CARD"
"BANK_TRANSFER"
"WALLET"
Normalized tender category the refund was returned to; mirrors PaymentPayment.tender_type
Are we missing anything? Let us know
Was this page helpful?