Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
V1Transactions

CreateRefund

Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.

You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment.

Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them.

post/v1/{location_id}/refunds

Path parameters

location_idstring required

The ID of the original payment's associated location.

Request body

payment_idstring required

The ID of the payment to refund. If you are creating a PARTIAL refund for a split tender payment, instead provide the id of the particular tender you want to refund.

reasonstring required

The reason for the refund.

request_idempotence_keystring

An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once.

typestring required

The type of refund (FULL or PARTIAL).

Response

Success

created_atstring

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

is_exchangeboolean

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_idstring
payment_idstring

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.

processed_atstring

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

reasonstring

The merchant-specified reason for the refund.

typestring

The type of refund