Transfers
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True | The Id of the transfer. | |
Currency | String | False | The currency. | |
Amount | Integer | False | Amount (in cents) to be transferred to your bank account. | |
AmountReversed | Integer | False | Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). | |
ApplicationFee | String | False | The application fee. | |
BalanceTransaction | String | False | Balance transaction that describes the impact of this transfer on your account balance. | |
Created | Datetime | True | Time that this record of the transfer was first created. | |
Date | Datetime | True | Date the transfer is scheduled to arrive in the bank. This doesn't factor in delays like weekends or bank holidays. | |
Description | String | False | Internal-only description of the transfer. | |
Destination | String | False | The Id of the bank account, card, or Stripe account the transfer was sent to. | |
DestinationPayment | String | True | If the destination is a Stripe account, this will be the Id of the payment that the destination account received for the transfer. | |
FailureCode | String | True | Error code explaining reason for transfer failure if available. | |
FailureMessage | String | True | Message to user further explaining reason for transfer failure if available. | |
Reversed | Boolean | True | Whether or not the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be 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 | False | Extra information about a transfer to be displayed on the user's bank statement. | |
Status | String | True | Current status of the transfer. | |
Type | String | True | The type of the transfer.Can be card, bank_account, or stripe_account. | |
MetadataAggregate | String | False | The transfer metadata object. |
Pseudo-Columns
Name | Type | Description |
AccountId | String | The Id of the connected account to get transfers for. |
Last updated