TransferReversals

Returns the available reversals belonging to a specific transfer and supports creating and updating them.

Table-Specific Information

SELECT

The add-in 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 add-in.


Column	Supported Operators
Id	=
Transfer	=
AccountId	=

To query the TransferReversals table, the Id of the transfer whose reversals are retrieved is required:

SELECT * FROM TransferReversals WHERE 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 the Id and Transfer values:

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		Indicates 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		The string representing the object's type. Objects of the same type share the same value.
BalanceTransaction	String	True		The balance transaction that describes the impact on your account balance.
DestinationPaymentRefund	String	True		The linked payment refund for the transfer reversal.
Created	Datetime	True		The date and time at which the object was created, measured in seconds since the Unix epoch.
SourceRefund	String	True		The Id of the refund responsible for the transfer reversal.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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.