Refunds

Creates and retrieves details for refunds issued by a merchant or their staff within a specified date range. Includes refund amounts, payment references, processing fees, destination details, and status tracking.

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.
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.
Unlinked	Boolean	True	Flag indicating whether or not the refund is linked to an existing payment in Square.
DestinationType	String	False	The destination type for this refund. The allowed values are CARD, BANK_ACCOUNT, WALLET, BUY_NOW_PAY_LATER, CASH, EXTERNAL, SQUARE_ACCOUNT.
DestinationDetailsCardDetailsCardId	String	True	Unique Id for this card, generated by Square.
DestinationDetailsCardDetailsCardLast4	String	True	The last 4 digits of the card number.
DestinationDetailsCardDetailsCardCardholderName	String	True	The name of the cardholder.
DestinationDetailsCardDetailsCardCustomerId	String	True	The Id of a customer to be associated with the card.
DestinationDetailsCardDetailsCardMerchantId	String	True	The Id of the merchant associated with the card.
DestinationDetailsCardDetailsCardReferenceId	String	True	An optional user-defined reference Id that associates this card with another entity in an external system. For example, a customer ID from an external customer management system.
DestinationDetailsCardDetailsCardBin	String	True	The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.
DestinationDetailsCardDetailsCardVersion	Int64	True	Current version number of the card. Increments with each card update. Requests to update an existing Card object will be rejected unless the version in the request matches the current version for the Card.
DestinationDetailsCardDetailsEntryMethod	String	True	The method used to enter the card's details for the refund.
DestinationDetailsCardDetailsAuthResultCode	String	True	The authorization code provided by the issuer when a refund is approved.
DestinationDetailsCashDetailsSellerSuppliedMoneyAmount	Int64	True	The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Monetary amounts can be positive or negative.
DestinationDetailsCashDetailsSellerSuppliedMoneyCurrency	String	True	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
DestinationDetailsCashDetailsChangeBackMoneyAmount	Int64	True	The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Monetary amounts can be positive or negative.
DestinationDetailsCashDetailsChangeBackMoneyCurrency	String	True	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
DestinationDetailsExternalDetailsType	String	True	The type of external refund the seller paid to the buyer.
DestinationDetailsExternalDetailsSource	String	True	A description of the external refund source.
DestinationDetailsExternalDetailsSourceId	String	True	Id linking the refund to its originating external source.
TeamMemberId	String	True	Id of the team member associated with processing the refund, if applicable.
TerminalRefundId	String	True	ID of the refund processed through Square Terminal, if applicable.

SSIS Components for Square

Refunds

Table Specific Information

Select

Insert

Columns