Refund Object Fields

Learn about the fields used to model refund transactions.

These field references describe the fields in a refund object. For more information about refunds, see Refunds.

The following fields are available:

Field	Description
`refund_tax_amount`	The tax amount to refund.
`refund_total_amount`	The total amount to refund.
`refund_note_url`	The URL of the refund note.
`refund_amount`	The refund amount. Used if `refund_total_amount` is not specified.
`refund_note_number`	The sequential refund note number.
`refund_key`	The refund identifier.
`refund_note_subnumber`	The sequential refund note subnumber.
`line_key`	The `line_key` for the transaction.
`refund_timestamp`	The time when the refund is issued. Use the `yyyy-MM-dd'T'HH:mm:ssZZZ` format. The default is the merchant's time zone. The service uses this value on the invoice and for currency conversions.
`refund_unique_reference`	The unique refund reference for the line.
`refund_amount_trimmed`	Indicates whether the refund amount was trimmed. The value can be `true` or `false`.
`refund_reason`	The reason for the refund.

Updated 17 days ago

Did this page help you?