TransferReversals
Create, update, and query the available reversals belonging to a specific transfer.
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 supports the following operator: =.
- Transfer supports the following operator: =.
- AccountId supports the following operator: =.
To query the TransferReversals table, the Id of the transfer whose reversals are retrieved is required:
SELECT * FROM TransferReversals WHERE Transfer = 'tr_12345678'
In addition to Transfer, the connector supports all columns to be used as criteria in the WHERE clause of a SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve a Reversal by specifying its Id:
SELECT * FROM TransferReversals WHERE Id = 'tr_12345678' AND Transfer = 'tr_12345678'
Insert
The Transfer column is required to insert to this table:
INSERT INTO TransferReversals (Amount, Transfer) VALUES (2000, 'tr_12345678')
Update
To update Metadata or Description in this table, specify both Id and Transfer:
UPDATE TransferReversals SET Metadata = '{"Description": "test metadata update"}' WHERE Id = 'trr_13jgn4kj' AND Transfer = 'tr_12345678'
UPDATE TransferReversals SET Description = 'Test Description' WHERE Id = 'trr_13jgn4kj' AND Transfer = 'tr_12345678'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the reversal. | |
| Transfer [KEY] | String | False |
The Id of the transfer that was reversed. | |
| Amount | Integer | False |
A positive integer in cents representing how much of this transfer to reverse. | |
| RefundApplicationFee | Boolean | False |
Boolean indicating whether the application fee should be refunded when reversing this transfer. | |
| Currency | String | True |
The currency. | |
| Metadata | String | False |
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | |
| Object | String | True |
String representing the object's type. Objects of the same type share the same value. | |
| BalanceTransaction | String | True |
Balance transaction that describes the impact on your account balance. | |
| DestinationPaymentRefund | String | True |
Linked payment refund for the transfer reversal. | |
| Created | Datetime | True |
Time at which the object was created. Measured in seconds since the Unix epoch. | |
| SourceRefund | String | True |
ID of the refund responsible for the transfer reversal. |
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 |
| Description | String |
An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the dashboard. This will be unset if you POST an empty value. |
| AccountId | String |
The Id of the connected account to get Transfer reversals for. |