Object Index

You are viewing an old version of the API

2022-11-16

Version 2022-11-16

• All Versions

Refund

V1

Connect V1 APIs and webhooks

Use the Square API for all new development. See When to use Connect V1 to learn more about working with V1 endpoints.

The type of refund

The merchant-specified reason for the refund.

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

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

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

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

All of the additive taxes associated with the refund.

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

All of the inclusive taxes associated with the refund.

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

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

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

A list of all surcharges associated with the refund.

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

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

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.

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.