Refunds
Create and query the available refunds in Stripe.
Table Specific Information
Select
Server-Side Query Support
The component uses the Stripe 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, Charge, PaymentIntent and AccountId support the following operators: =.
- Created support the following operators: <, >, >=, <, <=, =.
You can select:
A refund by specifying its Id:
SELECT * FROM Refunds WHERE Id = 're_19keFRGOsuAdslZgO7zSbS2j'
Refunds associated with a specific charge:
SELECT * FROM Refunds WHERE Charge = 'MyChargeId'
Insert
To insert a refund, provide a specifc charge:
INSERT INTO Refunds (Charge, Amount, Reason) VALUES ('ch_fj57lKDg460322552g', 40, 'duplicate')
INSERT INTO Refunds (Charge, Amount, Reason, MetadataAggregate) values ('ch_3LrL0PHWDgcyHde00jCW5AYz', 100, 'duplicate', '[{\"A\":\"BCD\",\"E\":\"FGH\",\"I\":\"JKL\"}]')
Update
UPDATE is not supported.
Delete
Delete is not supported.
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
The Id of the refund. | |
Charge | String | False |
The Id of the charge that was refunded. | |
Amount | Integer | False |
The Amount, in cents. | |
Status | String | True |
The status of the refund. | |
BalanceTransaction | String | True |
The balance transaction that describes the impact on your account balance. | |
Created | Datetime | True |
The refund datetime. | |
Currency | String | True |
Three-letter ISO code representing the currency. | |
Reason | String | False |
The reason for the refund. | |
ReceiptNumber | String | True |
This is the transaction number that appears on email receipts sent for this refund. | |
MetadataAggregate | String | False |
The refund metadata object. | |
Description | String | True |
An arbitrary string attached to the object. Often useful for displaying to users. | |
PaymentIntent | String | False |
ID of the PaymentIntent that was refunded. | |
Object | String | True |
String representing the object's type. Objects of the same type share the same value. | |
FailureBalanceTransaction | String | True |
If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. | |
FailureReason | String | True |
If the refund failed, the reason for refund failure if known. The allowed values are lost_or_stolen_card, expired_or_canceled_card, or unknown.. | |
NextAction | String | True |
This property will describe what the refund needs in order to continue processing. | |
SourceTransferReversal | String | True |
The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. | |
TransferReversal | String | True |
If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. | |
InstructionsEmail | String | True |
For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. | |
DestinationDetailsAffirm | String | True |
If this is a affirm refund, this hash contains the transaction specific details of the affirm refund method. | |
DestinationDetailsAfterpayClearpay | String | True |
If this is a afterpay_clearpay refund, this hash contains the transaction specific details of the afterpay_clearpay refund method. | |
DestinationDetailsAlipay | String | True |
If this is a alipay refund, this hash contains the transaction specific details of the alipay refund method. | |
DestinationDetailsAmazonPay | String | True |
If this is a amazon_pay refund, this hash contains the transaction specific details of the amazon_pay refund method. | |
DestinationDetailsAuBankTransfer | String | True |
If this is a au_bank_transfer refund, this hash contains the transaction specific details of the au_bank_transfer refund method. | |
DestinationDetailsBlikReference | String | True |
If this is a blik refund, this contains the reference assigned to the refund. | |
DestinationDetailsBlikReferenceStatus | String | True |
If this is a blik refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsBrBankTransferReference | String | True |
If this is a br_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsBrBankTransferReferenceStatus | String | True |
If this is a br_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsCardReference | String | True |
If this is a card refund, this contains the value of the reference number assigned to the refund. | |
DestinationDetailsCardReferenceStatus | String | True |
If this is a card refund, this contains the status of the reference number on the refund. This can be pending, available or unavailable. | |
DestinationDetailsCardReferenceType | String | True |
If this is a card refund, this contains the type of the reference number assigned to the refund. | |
DestinationDetailsCardType | String | True |
If this is a card refund, this contains the type of refund. This can be refund, reversal, or pending. | |
DestinationDetailsCashapp | String | True |
If this is a cashapp refund, this hash contains the transaction specific details of the cashapp refund method. | |
DestinationDetailsCustomerCashBalance | String | True |
If this is a customer_cash_balance refund, this hash contains the transaction specific details of the customer_cash_balance refund method. | |
DestinationDetailsEps | String | True |
If this is a eps refund, this hash contains the transaction specific details of the eps refund method. | |
DestinationDetailsEuBankTransferReference | String | True |
If this is a eu_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsEuBankTransferReferenceStatus | String | True |
If this is a eu_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsGbBankTransferReference | String | True |
If this is a gb_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsGbBankTransferReferenceStatus | String | True |
If this is a gb_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsGiropay | String | True |
If this is a giropay refund, this hash contains the transaction specific details of the giropay refund method. | |
DestinationDetailsGrabpay | String | True |
If this is a grabpay refund, this hash contains the transaction specific details of the grabpay refund method. | |
DestinationDetailsJpBankTransferReference | String | True |
If this is a jp_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsJpBankTransferReferenceStatus | String | True |
If this is a jp_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsKlarna | String | True |
If this is a klarna refund, this hash contains the transaction specific details of the klarna refund method. | |
DestinationDetailsMultibancoReference | String | True |
If this is a multibanco refund, this contains the reference assigned to the refund. | |
DestinationDetailsMultibancoReferenceStatus | String | True |
If this is a multibanco refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsMxBankTransferReference | String | True |
If this is a mx_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsMxBankTransferReferenceStatus | String | True |
If this is a mx_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsP24Reference | String | True |
If this is a p24 refund, this contains the reference assigned to the refund. | |
DestinationDetailsP24ReferenceStatus | String | True |
If this is a p24 refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsPaynow | String | True |
If this is a paynow refund, this hash contains the transaction specific details of the paynow refund method. | |
DestinationDetailsPaypal | String | True |
If this is a paypal refund, this hash contains the transaction specific details of the paypal refund method. | |
DestinationDetailsPix | String | True |
If this is a pix refund, this hash contains the transaction specific details of the pix refund method. | |
DestinationDetailsRevolut | String | True |
If this is a revolut refund, this hash contains the transaction specific details of the revolut refund method. | |
DestinationDetailsSofort | String | True |
If this is a sofort refund, this hash contains the transaction specific details of the sofort refund method. | |
DestinationDetailsSwishReference | String | True |
If this is a swish refund, this contains the reference assigned to the refund. | |
DestinationDetailsSwishReferenceStatus | String | True |
If this is a swish refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsThBankTransferReference | String | True |
If this is a th_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsThBankTransferReferenceStatus | String | True |
If this is a th_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsType | String | True |
The type of transaction-specific details of the payment method used in the refund (e.g., card). An additional hash is included on destination_details with a name matching this value. It contains information specific to the refund transaction. | |
DestinationDetailsUsBankTransferReference | String | True |
If this is a us_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsUsBankTransferReferenceStatus | String | True |
If this is a us_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsWechatPay | String | True |
If this is a wechat_pay refund, this hash contains the transaction specific details of the wechat_pay refund method. | |
DestinationDetailsZip | String | True |
If this is a zip refund, this hash contains the transaction specific details of the zip refund method. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
AccountId | String |
The Id of the connected account to get refunds for. |