Refunds
Create and query the details for all Refunds initiated by a merchant or any of the mobile staff of the merchant during a date range.
Table Specific Information
Select
By default this table returns all refunds initiated by a merchant or any of the merchants mobile staff starting from January 1, 2013, as in the following query:
SELECT * FROM Refunds WHERE Id = '12345' SELECT * FROM Refunds WHERE Status = 'COMPLETED' AND LocationId = '92BYHNBR6W77E' SELECT * FROM Refunds WHERE LocationId = '9J0M984DXGA7W' // To get the refund for a given location
Insert
To insert a Refund, specify the PaymentId, RefundedMoneyAmount, RefundedMoneyCurrency.
INSERT INTO Refunds (PaymentId, RefundedMoneyAmount, RefundedMoneyCurrency) VALUES ('UNOE3kv2BZwqHlJ830RCt5YCuaB', 100, 'USD')
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique ID for this refund, generated by Square. |
TenderId | String | False |
The Square-issued Id of the transaction tender the refund is applied to. |
RefundedMoneyAmount | Int64 | False |
The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. |
RefundedMoneyCurrency | String | False |
The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD. |
RefundedAppFeeMoneyAmount | Int64 | False |
The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. |
RefundedAppFeeMoneyCurrency | String | False |
The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD. |
CreatedAt | Datetime | False |
The time when the merchant initiated the refund for Square to process. |
LocationId | String | False |
The Id of the location. |
OrderId | String | False |
The ID of the order associated with the refund. |
PaymentId | String | False |
The ID of the payment associated with this refund. |
ProcessingFeeMoneyAmount | Int64 | False |
Processing fees and fee adjustments assessed by Square for this refund. The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. |
ProcessingFeeMoneyCurrency | String | False |
Processing fees and fee adjustments assessed by Square for this refund. The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD. |
ProcessingFeeEffectiveAt | Datetime | False |
Processing fees and fee adjustments assessed by Square for this refund. The timestamp of when the fee takes effect, in RFC 3339 format. |
ProcessingFeeType | String | False |
Processing fees and fee adjustments assessed by Square for this refund. The type of fee assessed or adjusted. The fee type can be INITIAL or ADJUSTMENT. |
Reason | String | False |
The merchant-specified reason for the refund. |
Status | String | False |
The refund's status The allowed values are COMPLETED, FAILED, PENDING, REJECTED. |
UpdatedAt | Datetime | False |
The timestamp of when the refund was last updated, in RFC 3339 format. |