<- Object

Object

All versions ->

V1Refund

V1Refund

Link to section

Properties

Link to section

type

string

The type of refund

Link to section

reason

string

The merchant-specified reason for the refund.

Link to section

refunded_money

The amount of money refunded. This amount is always negative.

Link to section

refunded_processing_fee_money

The amount of processing fee money refunded. This amount is always positive.

Link to section

refunded_tax_money

The total amount of tax money refunded. This amount is always negative.

Link to section

refunded_additive_tax_money

The amount of additive tax money refunded. This amount is always negative.

Link to section

refunded_additive_tax

All of the additive taxes associated with the refund.

Link to section

refunded_inclusive_tax_money

The amount of inclusive tax money refunded. This amount is always negative.

Link to section

refunded_inclusive_tax

All of the inclusive taxes associated with the refund.

Link to section

refunded_tip_money

The amount of tip money refunded. This amount is always negative.

Link to section

refunded_discount_money

The amount of discount money refunded. This amount is always positive.

Link to section

refunded_surcharge_money

The amount of surcharge money refunded. This amount is always negative.

Link to section

refunded_surcharges

A list of all surcharges associated with the refund.

Link to section

created_at

string

The time when the merchant initiated the refund for Square to process, in ISO 8601 format.

Link to section

processed_at

string

The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.

Link to section

payment_id

string

A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.

Link to section

merchant_id

string

Link to section

is_exchange

boolean

Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.