The InboundTransfer object 

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.

  Hide child attributes

  • failure_details.codeenum

    Reason for the failure.

    Possible enum values

    account_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.

  Hide child attributes

  • 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 value false 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.

  Hide child attributes

  • origin_payment_method_details.billing_detailsobject

    Contact details for the person or business referenced by the PaymentMethod.

    Hide child attributes

    • origin_payment_method_details.billing_details.addressobject

      Billing address.

      Hide child attributes

      • 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, such as the street, PO Box, or company name.

      • origin_payment_method_details.billing_details.address.line2nullable string

        Address line 2, such as the 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 values

    us_bank_account US Bank Account

  • origin_payment_method_details.us_bank_accountnullable object

    Optional fields for us_bank_account.

    Hide child attributes

    • origin_payment_method_details.us_bank_account.account_holder_typenullable enum

      Account holder type: individual or company.

      Possible enum values

      company 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 values

      checking 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 the succeeded 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, and canceled. An InboundTransfer is processing if it is created and pending. The status changes to succeeded once the funds have been “confirmed” and a transaction is created and posted. The status changes to failed if the transfer fails.

• status_transitionsobject

  Hash containing timestamps of when the object transitioned to a particular status.

  Hide child attributes

  • 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.