Object Index / Definition

You are viewing an old version of the API
Refund
V1

Note We recommend using the Square API (V2) for all new development when possible.

V1Refund

Properties

Name Description
created_at
string

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

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.

merchant_id
string
payment_id
string

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.

processed_at
string

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

reason
string

The merchant-specified reason for the refund.

refunded_additive_tax
V1​Payment​Tax [ ]

All of the additive taxes associated with the refund.

refunded_additive_tax_money
V1​Money

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

refunded_discount_money
V1​Money

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

refunded_inclusive_tax
V1​Payment​Tax [ ]

All of the inclusive taxes associated with the refund.

refunded_inclusive_tax_money
V1​Money

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

refunded_money
V1​Money

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

refunded_processing_fee_money
V1​Money

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

refunded_surcharge_money
V1​Money

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

refunded_surcharges
V1​Payment​Surcharge [ ]

A list of all surcharges associated with the refund.

refunded_tax_money
V1​Money

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

refunded_tip_money
V1​Money

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

type
string

The type of refund

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?