• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Refund
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

V1Refund

Properties

Name Description
type
string

The type of refund

reason
string

The merchant-specified reason for the refund.

refunded_money
Money

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

refunded_processing_fee_money
Money

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

refunded_tax_money
Money

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

refunded_additive_tax_money
Money

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

refunded_additive_tax
PaymentTax [ ]

All of the additive taxes associated with the refund.

refunded_inclusive_tax_money
Money

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

refunded_inclusive_tax
PaymentTax [ ]

All of the inclusive taxes associated with the refund.

refunded_tip_money
Money

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

refunded_discount_money
Money

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

refunded_surcharge_money
Money

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

refunded_surcharges
PaymentSurcharge [ ]

A list of all surcharges associated with the refund.

created_at
string

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

processed_at
string

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

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.

merchant_id
string
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.

Share Feedback

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