TerminalRefunds

Create and query Square Terminal refund requests.

Table Specific Information

Select

The driver uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the driver.

Id supports the following operator: =.
CreatedAt supports the following operators: =, >=, <=, >, <.
DeviceId supports the following operator: =.
Status supports the following operator: =.

Retrieve all terminal refunds:

SELECT * FROM TerminalRefunds

Retrieve a specific terminal refund:

SELECT * FROM TerminalRefunds WHERE Id = 'refund_id_here'

Retrieve completed terminal refunds:

SELECT * FROM TerminalRefunds WHERE Status = 'COMPLETED'

Insert

To create a terminal refund, you must specify the PaymentId, AmountMoneyAmount, AmountMoneyCurrency, DeviceId, Reason, and IdempotencyKey columns.

INSERT INTO TerminalRefunds (PaymentId, AmountMoneyAmount, AmountMoneyCurrency, DeviceId, Reason, IdempotencyKey) VALUES ('PAYMENT_ID', 100, 'USD', 'DEVICE_ID', 'Customer request', 'unique-idempotency-key')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique ID of this Terminal refund.
PaymentId	String	False	The unique ID of the payment being refunded.
AmountMoneyAmount	Int64	False	The amount of money, inclusive of tax_money, that the TerminalRefund should return. Limited to the amount taken in the original payment minus any completed or pending refunds.
AmountMoneyCurrency	String	False	The currency of the refund, in ISO 4217 format (e.g., USD). The allowed values are UNKNOWN_CURRENCY, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SLE, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMK, ZMW, BTC, XUS.
DeviceId	String	False	The unique ID of the device intended for this TerminalRefund. The Id can be retrieved from /v2/devices api.
Reason	String	False	A description of the reason for the refund. Maximum 192 characters.
DeadlineDuration	String	False	The RFC 3339 duration, after which the refund is automatically canceled. A TerminalRefund that is PENDING is automatically CANCELED and has a cancellation reason of TIMED_OUT. Default: 5 minutes from creation. Maximum: 5 minutes.
RefundId	String	True	The reference to the payment refund created by completing this TerminalRefund.
OrderId	String	True	The reference to the Square order ID for the payment identified by the payment_id.
Status	String	True	The status of the TerminalRefund. Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, or COMPLETED. The allowed values are PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED.
LocationId	String	True	The location of the device where the TerminalRefund was directed.
AppId	String	True	The ID of the application that created the refund.
CancelReason	String	True	Present if the status is CANCELED. The allowed values are BUYER_CANCELED, SELLER_CANCELED, TIMED_OUT.
CreatedAt	Datetime	True	The time when the TerminalRefund was created, as an RFC 3339 timestamp.
UpdatedAt	Datetime	True	The time when the TerminalRefund was last updated, as an RFC 3339 timestamp.

Pseudocolumns

Pseudo column fields are used in the WHERE clause of SELECT statements (unless stated otherwise) and offer a more granular control over the tuples that are returned from the data source.