Object Index
/ Definition
You are viewing an old version of the API
Refund
V1
Object Index / Definition
Note We recommend using the Square API (V2) for all new development when possible.
V1Refund
Properties
| Name | Description |
|---|---|
type
|
The type of refund See V1RefundType for possible values |
reason
|
The merchant-specified reason for the refund. |
refunded_money
|
The amount of money refunded. This amount is always negative. |
refunded_processing_fee_money
|
The amount of processing fee money refunded. This amount is always positive. |
refunded_tax_money
|
The total amount of tax money refunded. This amount is always negative. |
refunded_additive_tax_money
|
The amount of additive tax money refunded. This amount is always negative. |
refunded_additive_tax
|
All of the additive taxes associated with the refund. |
refunded_inclusive_tax_money
|
The amount of inclusive tax money refunded. This amount is always negative. |
refunded_inclusive_tax
|
All of the inclusive taxes associated with the refund. |
refunded_tip_money
|
The amount of tip money refunded. This amount is always negative. |
refunded_discount_money
|
The amount of discount money refunded. This amount is always positive. |
refunded_surcharge_money
|
The amount of surcharge money refunded. This amount is always negative. |
refunded_surcharges
|
A list of all surcharges associated with the refund. |
created_at
|
The time when the merchant initiated the refund for Square to process, in ISO 8601 format. |
processed_at
|
The time when Square processed the refund on behalf of the merchant, in ISO 8601 format. |
payment_id
|
A Square-issued ID associated with the refund. For single-tender refunds, paymentid is the ID of the original payment ID. For split-tender refunds, paymentid is the ID of the original tender. For exchange-based refunds (isexchange == true), paymentid is the ID of the original payment ID even if the payment includes other tenders. |
merchant_id
|
|
is_exchange
|
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. |