<- Terminal API

Terminal API

Create terminal refund

POST

 /v2/terminals/refunds

Creates a request to refund an Interac payment completed on a Square Terminal.

Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see Refunds API.

Permissions:PAYMENTS_WRITE

Guide

Create a Terminal refund

Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

A unique string that identifies this CreateRefund request. Keys can be any valid string but must be unique for every CreateRefund request.

See Idempotency keys for more information.

Min Length
1
Max Length
64
Link to section

refund

The refund to create.

Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

refund

The created TerminalRefund.