Refund Object Fields

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.

Field	Description
`refund_tax_amount`	Refund tax amount.
`refund_total_amount`	The total amount that is to be refunded for a full refund.
`refund_note_url`	Refund note URL.
`refund_amount`	The amount for a partial refund. Used if no value is specified in the `refund_total_amount` field.
`refund_note_number`	Sequential refund note number.
`refund_key`	Refund identifier.
`refund_note_subnumber`	Sequential refund note subnumber.
`line_key`	Response-only field. For more information, see Inactive and Response-Only Fields.
`refund_timestamp`	The time that the refund is issued. The format is `yyyy-MM-dd'T'HH:mm:ssZZZ`. The default value is the merchant's timezone. The value is used in the invoice and to apply currency conversions.
`refund_unique_reference`	Refund unique reference per line.
`refund_fees`	List of fees calculated for this refund. See Refund Fees section below.
`refund_amount_trimmed`	Indicates whether the refund amount has been trimmed or not. The value can be `true` or `false`.
`refund_reason`	Free text used to specify a reason for the refund.

Refund Fees

Field	Description
`currency_code`	3-letter ISO currency code.
`amount`	Amount in designated currency.
`fx_rate`	Foreign exchange rate used in calculation
`fx_date`	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.
`fx_source`	The institution that supplied the rate used for the currency conversion.
`seller_code`	The seller code for which the fee applies.
`type`	Choose of the following types: `amount-fee`: Use this if you want the fee to be calculated based on the amounts. `tax-fee`: Use this value if you want to denote a tax amount that needs to be treated as a fee, (where the tax liability is the seller's).
`rule`	The tax rule that was applied. This decides what type of fee is applied in the `type` field.
`free_key`	A unique key that you can use to identify the transaction.
`correlated_fee_key`	The key used to identify the keys of related fees.