Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- amountinteger
Amount (in cents) transferred.
- cancelableboolean
Returns
true
if the InboundTransfer is able to be canceled. - createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- currencyenum
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- descriptionnullable string
An arbitrary string attached to the object. Often useful for displaying to users.
- failure_
detailsnullable object Details about this InboundTransfer’s failure. Only set when status is
failed
.- failure_details.
codeenum Reason for the failure.
Possible enum valuesaccount_
closed The bank account has been closed.
account_
frozen The bank account has been frozen.
bank_
account_ restricted The bank account has restrictions on either the type or number of transfers allowed. This normally indicates that the bank account is a savings or other non-checking account.
bank_
ownership_ changed The bank account is no longer valid because its branch has changed ownership.
debit_
not_ authorized Debit transactions are not approved on the bank account.
incorrect_
account_ holder_ address The bank notified us that the bank account holder address on file is incorrect.
incorrect_
account_ holder_ name The bank notified us that the bank account holder name on file is incorrect.
incorrect_
account_ holder_ tax_ id The bank notified us that the bank account holder tax ID on file is incorrect.
insufficient_
funds The bank account has insufficient funds to cover the debit transaction.
invalid_
account_ number The bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.
Show 3 more
- financial_
accountstring The FinancialAccount that received the funds.
- hosted_
regulatory_ receipt_ urlnullable string A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
- linked_
flowsobject Other flows linked to a InboundTransfer.
- linked_flows.
received_ debitnullable string If funds for this flow were returned after the flow went to the
succeeded
state, this field contains a reference to the ReceivedDebit return.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - metadataobject
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.
- origin_
payment_ methodnullable string The origin payment method to be debited for an InboundTransfer.
- origin_
payment_ method_ detailsnullable object Details about the PaymentMethod for an InboundTransfer.
- origin_payment_method_details.
billing_ detailsobject Contact details for the person or business referenced by the PaymentMethod.
- origin_payment_method_details.
billing_details. addressobject Billing address.
- origin_payment_method_details.
billing_details. address. citynullable string City, district, suburb, town, or village.
- origin_payment_method_details.
billing_details. address. countrynullable string Two-letter country code (ISO 3166-1 alpha-2).
- origin_payment_method_details.
billing_details. address. line1nullable string Address line 1 (e.g., street, PO Box, or company name).
- origin_payment_method_details.
billing_details. address. line2nullable string Address line 2 (e.g., apartment, suite, unit, or building).
- origin_payment_method_details.
billing_details. address. postal_ codenullable string ZIP or postal code.
- origin_payment_method_details.
billing_details. address. statenullable string State, county, province, or region.
- origin_payment_method_details.
billing_details. emailnullable string Email address.
- origin_payment_method_details.
billing_details. namenullable string Full name.
- origin_payment_method_details.
typeenum The type of the payment method used in the InboundTransfer.
Possible enum valuesus_
bank_ account US Bank Account
- origin_payment_method_details.
us_ bank_ accountnullable object Optional fields for
us_
.bank_ account - origin_payment_method_details.
us_bank_account. account_ holder_ typenullable enum Account holder type: individual or company.
Possible enum valuescompany
Account belongs to a company
individual
Account belongs to an individual
- origin_payment_method_details.
us_bank_account. account_ typenullable enum Account type: checkings or savings. Defaults to checking if omitted.
Possible enum valueschecking
Bank account type is checking
savings
Bank account type is savings
- origin_payment_method_details.
us_bank_account. bank_ namenullable string Name of the bank associated with the bank account.
- origin_payment_method_details.
us_bank_account. fingerprintnullable string Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- origin_payment_method_details.
us_bank_account. last4nullable string Last four digits of the bank account number.
- origin_payment_method_details.
us_bank_account. mandatenullable stringExpandable ID of the mandate used to make this payment.
- origin_payment_method_details.
us_bank_account. networkenum The network rails used. See the docs to learn more about money movement timelines for each network type.
- origin_payment_method_details.
us_bank_account. routing_ numbernullable string Routing number of the bank account.
- returnednullable boolean
Returns
true
if the funds for an InboundTransfer were returned after the InboundTransfer went to thesucceeded
state. - statement_
descriptorstring Statement descriptor shown when funds are debited from the source. Not all payment networks support
statement_
.descriptor - statusenum
Status of the InboundTransfer:
processing
,succeeded
,failed
, andcanceled
. An InboundTransfer isprocessing
if it is created and pending. The status changes tosucceeded
once the funds have been “confirmed” and atransaction
is created and posted. The status changes tofailed
if the transfer fails. - status_
transitionsobject Hash containing timestamps of when the object transitioned to a particular
status
.- status_transitions.
failed_ atnullable timestamp Timestamp describing when an InboundTransfer changed status to
failed
. - status_transitions.
succeeded_ atnullable timestamp Timestamp describing when an InboundTransfer changed status to
succeeded
.
- transactionnullable stringExpandable
The Transaction associated with this object.