Refund data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
total_amount | number | No | |
payment_id | string | No | (reference to PaymentPayment) |
currency | string | No | |
notes | string | No | |
status | enum | No | Values: SUCCEEDED, PENDING, FAILED, CANCELED |
reference | string | No | |
refunded_at | string (date-time) | No | Date and time the refund occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
reason | enum | No | Why the refund was issued Values: DUPLICATE, FRAUDULENT, REQUESTED_BY_CUSTOMER, OTHER |
tender_type | enum | No | Normalized tender category the refund was returned to; mirrors PaymentPayment.tender_type Values: CARD, CASH, GIFT_CARD, BANK_TRANSFER, WALLET, CHECK, STORE_CREDIT, BUY_NOW_PAY_LATER, EXTERNAL, OTHER |
metadata | PaymentMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?