Refunds object
A refund represents a transaction that returns value from a business to a customer. A individual payment can be refunded entirely or a general refund can be applied to an invoice.
Attributes
Unique identifier for the refund.
Unique ID of the refund in your system for linking and idempotency.
Resource type. Value will be “Refund”.
Timestamp when refund posted.
Amount of refund received by customer.
Fee, in cents, charged by payment processor for the refund.
Payment method. Possible values are: CASH
, CHECK
, CREDIT_CARD
, ACH
, STORE_CREDIT
,
OTHER
Processor used to make the payment, if any.
Any processor name can be provided and will be tracked.
Supported processors (STRIPE
, SHOPIFY
) will have additional asset balance tracking.
Customer object associated with the invoice.
Invoice ID this refund was applied to, if applicable.
This field does not need to be specified, but if invoice_line_item_id
is also specified, it must belong to this invoice.
Invoice line item ID specifying an exact product or service which was refunded.
Payment ID this refund was applied to, if applicable.