Refund Object Fields

More information about Refunds is provided in the Refunds topic.

The following fields are used to model refunds:

Field	Description
`refund_tax_amount`	Refund tax amount.
`refund_total_amount`	The total amount that is to be refunded for a refund.
`refund_note_url`	Refund note URL.
`refund_amount`	The amount for a 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`	You must include the `line_key` in your Refund Transaction requests.
`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_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.