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

The component 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 component.

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

For example, the following queries are processed server-side:

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, and RefundedMoneyCurrency.

INSERT INTO Refunds (PaymentId, RefundedMoneyAmount, RefundedMoneyCurrency) VALUES ('UNOE3kv2BZwqHlJ830RCt5YCuaB', 100, 'USD')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	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	True	The time when the merchant initiated the refund for Square to process.
LocationId	String	False	The Id of the location.
OrderId	String	True	The Id of the order associated with the refund.
PaymentId	String	False	The Id of the payment associated with this refund.
ProcessingFeeMoneyAmount	Int64	True	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	True	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	True	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	True	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. The allowed values are INITIAL, ADJUSTMENT.
Reason	String	False	The merchant-specified reason for the refund.
Status	String	True	The refund's status. The allowed values are COMPLETED, FAILED, PENDING, REJECTED.
UpdatedAt	Datetime	True	The timestamp of when the refund was last updated, in RFC 3339 format.
Unlinked	Boolean	False	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. The allowed values are KEYED, SWIPED, EMV, ON_FILE, CONTACTLESS.
DestinationDetailsCardDetailsAuthResultCode	String	True	The authorization code provided by the issuer when a refund is approved.
DestinationDetailsCashDetailsSellerSuppliedMoneyAmount	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. Monetary amounts can be positive or negative.
DestinationDetailsCashDetailsSellerSuppliedMoneyCurrency	String	False	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	False	The type of external refund the seller paid to the buyer. The allowed values are CHECK, BANK_TRANSFER, OTHER_GIFT_CARD, CRYPTO, SQUARE_CASH, SOCIAL, EXTERNAL, EMONEY, CARD, STORED_BALANCE, FOOD_VOUCHER, OTHER.
DestinationDetailsExternalDetailsSource	String	False	A description of the external refund source.
DestinationDetailsExternalDetailsSourceId	String	False	Id linking the refund to its originating external source.
TeamMemberId	String	False	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.
DestinationDetailsCardDetailsCardCardBrand	String	True	The card's brand. The allowed values are VISA, MASTERCARD, AMERICAN_EXPRESS, DISCOVER, DISCOVER_DINERS, JCB, CHINA_UNIONPAY, SQUARE_GIFT_CARD, SQUARE_CAPITAL_CARD, INTERAC, EFTPOS, FELICA, OTHER_BRAND.
DestinationDetailsCardDetailsCardExpMonth	Int64	True	The expiration month of the associated card as an integer between 1 and 12.
DestinationDetailsCardDetailsCardExpYear	Int64	True	The four-digit year of the card's expiration date.
DestinationDetailsCardDetailsCardFingerprint	String	True	Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.
DestinationDetailsCardDetailsCardCardType	String	True	The type of the card. The allowed values are UNKNOWN_CARD_TYPE, CREDIT, DEBIT.
DestinationDetailsCardDetailsCardPrepaidType	String	True	Indicates whether the Card is prepaid or not. The allowed values are UNKNOWN_PREPAID_TYPE, NOT_PREPAID, PREPAID.
DestinationDetailsCardDetailsCardEnabled	Boolean	True	Indicates whether or not a card can be used for payments.
DestinationDetailsCardDetailsCardCoBrand	String	True	The card's co-brand, if any. The allowed values are UNKNOWN, AFTERPAY, CLEARPAY.
DestinationDetailsCardDetailsCardIssuerAlert	String	True	An alert issued by the card issuer about the status of the card.
DestinationDetailsCardDetailsCardIssuerAlertAt	Datetime	True	The timestamp when the issuer alert was generated, in RFC 3339 format.
DestinationDetailsCardDetailsCardHsaFsa	Boolean	True	Indicates whether the card is a Health Savings Account (HSA) or Flexible Spending Account (FSA) card.
DestinationDetailsCardDetailsCardCreatedAt	Datetime	True	The timestamp when the card was created, in RFC 3339 format.
DestinationDetailsCardDetailsCardDisabledAt	Datetime	True	The timestamp when the card was disabled, in RFC 3339 format.
DestinationDetailsCardDetailsCardBillingAddressLine1	String	True	The first line of the address.
DestinationDetailsCardDetailsCardBillingAddressLine2	String	True	The second line of the address, if any.
DestinationDetailsCardDetailsCardBillingAddressLine3	String	True	The third line of the address, if any.
DestinationDetailsCardDetailsCardBillingAddressAdministrativeDistrictLevel1	String	True	A civil entity within the address's country. In the US, this is the state.
DestinationDetailsCardDetailsCardBillingAddressAdministrativeDistrictLevel2	String	True	A civil entity within the address's administrative_district_level_1. In the US, this is the county.
DestinationDetailsCardDetailsCardBillingAddressAdministrativeDistrictLevel3	String	True	A civil entity within the address's administrative_district_level_2, if any.
DestinationDetailsCardDetailsCardBillingAddressCountry	String	True	The address's country, in ISO 3166-1-alpha-2 format.
DestinationDetailsCardDetailsCardBillingAddressFirstName	String	True	Optional first name when it's representing recipient.
DestinationDetailsCardDetailsCardBillingAddressLastName	String	True	Optional last name when it's representing recipient.
DestinationDetailsCardDetailsCardBillingAddressLocality	String	True	The city or town of the address.
DestinationDetailsCardDetailsCardBillingAddressPostalCode	String	True	The address's postal code.
DestinationDetailsCardDetailsCardBillingAddressSubLocality	String	True	A civil region within the address's locality, if any.
DestinationDetailsCardDetailsCardBillingAddressSubLocality2	String	True	A civil region within the address's sublocality, if any.
DestinationDetailsCardDetailsCardBillingAddressSubLocality3	String	True	A civil region within the address's sublocality_2, if any.

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.