Transfers

Represents transfers of funds to connected accounts or bank accounts, including the amount, destination, source transaction, and reversal details.

Table-Specific Information

SELECT

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


Column	Supported Operators
Id	=
AccountId	=
Destination	=
Created	<, >, >=, <, <=, =

You can select:

A transfer by specifying its Id:

SELECT * FROM Transfers WHERE Id = 'tr_12345678'

A transfer created after a specific date:

SELECT * FROM Transfers WHERE Created > '2023-07-21 19:00:27.0'

Created can also be used twice to specify a range:

SELECT * FROM Transfers WHERE Created >= '2023-01-01 00:00:00.0' AND Created <= '2023-12-31 23:59:59.0'

INSERT

Currency, Amount, and Destination are required to insert into this table. The destination is the Id of a connected Stripe account:

INSERT INTO Transfers (Amount, Currency, Destination, TransferGroup) VALUES (1000, 'USD', 'acct_19abC2DFGl5DVRzj', 'ORDER_95')

UPDATE

To update a transfer, set a description or metadata and specify an Id in the WHERE clause:

UPDATE Transfers SET Description = 'New desc', MetadataAggregate = '{\"test\" : \"test\"}' WHERE Id = 'tr_123456788'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the transfer.
Currency	String	False		The three-letter ISO currency code of the transfer, in lowercase.
Amount	Integer	False		The amount, in cents, to be transferred to your bank account.
AmountReversed	Integer	True		The amount, in cents, reversed. This can be less than the amount attribute on the transfer if a partial reversal was issued.
BalanceTransaction	String	True		The balance transaction that describes the impact of this transfer on your account balance.
Created	Datetime	True		The time at which this record of the transfer was first created, measured in seconds since the Unix epoch.
Date	Datetime	True		The date the transfer is scheduled to arrive in the bank. This does not factor in delays such as weekends or bank holidays.
Description	String	False		An internal-only description of the transfer.
Destination	String	False		The Id of the bank account, card, or Stripe account to which the transfer was sent.
DestinationPayment	String	True		The Id of the payment that the destination account received for the transfer, if the destination is a Stripe account.
FailureCode	String	True		An error code explaining the reason for the transfer failure, if available.
FailureMessage	String	True		A message to the user that further explains the reason for the transfer failure, if available.
Reversed	Boolean	True		Indicates whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute is false.
SourceTransaction	String	False		The Id of the charge or other transaction that was used to fund the transfer. If null, the transfer was funded from the available balance.
SourceType	String	False		The source balance this transfer came from.
StatementDescriptor	String	True		Extra information about the transfer to be displayed on the user's bank statement.
Status	String	True		The current status of the transfer.
Type	String	True		The type of the transfer, such as card, bank_account, or stripe_account.
MetadataAggregate	String	False		The set of key-value pairs that you can attach to the transfer.
Object	String	True		The string representing the object's type. Objects of the same type share the same value.
Livemode	Boolean	True		Indicates whether the object exists in live mode. Has the value true if the object exists in live mode, or the value false if the object exists in test mode.
ReversalsAggregate	String	True		The list of reversals that have been applied to the transfer.
TransferGroup	String	False		A string that identifies this transaction as part of a group.

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
AccountId	String	The Id of the connected account to get transfers for.