Refund Object Fields
Read about what fields you can use to model refunds.
If the sale is partially or fully refunded and it qualifies for a tax refund from the tax authority, relevant information needs to be sent back to the API.
|Refund tax amount.|
|The total amount that is to be refunded for a full refund.|
|Refund note URL.|
|The amount for a partial refund. Used if no value is specified in the |
|Sequential refund note number.|
|Sequential refund note subnumber.|
|Response-only field. For more information, see Inactive and Response-Only Fields.|
|The time that the refund is issued. The format is |
The default value is the merchant's timezone.
The value is used in the invoice and to apply currency conversions.
|Refund unique reference per line.|
|List of fees calculated for this refund. See Refund Fees section below.|
|Indicates whether the refund amount has been trimmed or not. The value can be |
|Free text used to specify a reason for the refund.|
|3-letter ISO currency code.|
|Amount in designated currency.|
|Foreign exchange rate used in calculation|
|The date that is used to generate the rate when the currency is converted for the refund.|
This defaults to the transaction's order date.
|The institution that supplied the rate used for the currency conversion.|
|The seller code for which the fee applies.|
|Choose of the following types:|
|The tax rule that was applied.|
This decides what type of fee is applied in the
|A unique key that you can use to identify the transaction.|
|The key used to identify the keys of related fees.|
Updated about 2 months ago