CData Python Connector for Stripe

Build 23.0.8839

Refunds

Create and query the available refunds in Stripe.

Table Specific Information

Select

Server-Side Query Support

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

  • Id, Charge, PaymentIntent and AccountId support the following operators: =.
  • Created support the following operators: <,>>=,<,<=,=.

The provider supports the use of all columns as criteria in the WHERE clause of SELECT statements, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-a Refund by specifying its Id:

SELECT * FROM Refunds WHERE Id = 're_19keFRGOsuAdslZgO7zSbS2j'

-Refunds for the charge specified by Charge Id:

SELECT * FROM Refunds WHERE Charge = 'MyChargeId'

Insert

To insert a refund, provide a Charge Id.

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.

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.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839