Refund
Kind: Object
One refund raised against a payment, and what the payment gateway says became of it. Refunds are raised by the cancellation and returns flows.
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id |
ID! |
|
amount |
Money! |
|
state |
RefundState! |
Only SETTLED means the customer has the money. ACCEPTED is the gateway holding it (pending, on hold or awaiting approval), FAILED is the gateway giving up, and UNKNOWN is a gateway that never said either way. |
reason |
String! |
|
needsReview |
Boolean! |
Conflicting evidence or a replacement needs staff reconciliation. |
acceptedAt |
DateTime |
|
settledAt |
DateTime |
|
manual |
Boolean! |
Settled by hand (cash on delivery, bank transfer) rather than through a payment gateway, so no gateway status update will ever arrive for it. |
externalRefundId |
String! |
The gateway’s own refund reference, to reconcile against. |
createdAt |
DateTime! |
|
gateway |
String! |
The gateway that took the money and therefore owes it back — not necessarily the one taking payments today. |
payment |
Payment |
|
order |
Order |
The order this refund is against. |