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.

Refund

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_fees`	The list of fees used to calculate the refund. See Refund fees.
`refund_amount_trimmed`	Indicates whether the refund amount was trimmed. The value can be `true` or `false`.
`refund_reason`	The reason for the refund.

Refund fees

Field	Description
`currency_code`	The three-letter ISO currency code.
`amount`	The amount in the specified currency.
`fx_rate`	The foreign exchange rate used for the calculation.
`fx_date`	The date used to determine the exchange rate when converting the refund currency. Defaults to the transaction's order date.
`fx_source`	The institution that supplied the exchange rate used for the currency conversion.
`seller_code`	The seller code to which the fee applies.
`type`	The fee type. Possible values: `amount-fee`—Calculates the fee based on the amount. `tax-fee`—Identifies a tax amount that is treated as a fee when the seller is liable for the tax.
`rule`	The tax rule that was applied. This rule determines the fee type specified in the `type` field.
`free_key`	The unique key used to identify the transaction.
`correlated_fee_key`	The key used to identify related fees.

Updated 14 days ago

Did this page help you?