The InboundTransfer object 

Attributes

• idstring

  Unique identifier for the InboundTransfer.

• objectstring, value is "v2.money_management.inbound_transfer"

  String representing the object’s type. Objects of the same type share the same value of the object field.

• amountobject

  The amount in specified currency that will land in the FinancialAccount balance.

  Hide child attributes

  • amount.currencystring

    A lowercase alpha3 currency code like “usd”.

  • amount.valueinteger

    In minor units like 123 for 1.23 USD.

• createdtimestamp

  Creation time of the InboundTransfer. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

• descriptionstring

  A freeform text field provided by user, containing metadata.

• fromobject

  A nested object containing information about the origin of the InboundTransfer.

  Hide child attributes

  • from.debitedobject

    The amount in specified currency that was debited from the Payment Method.

    Hide child attributes

    • from.debited.currencystring

      A lowercase alpha3 currency code like “usd”.

    • from.debited.valueinteger

      In minor units like 123 for 1.23 USD.

  • from.payment_methodobject

    The Payment Method object used to create the InboundTransfer.

    Hide child attributes

    • from.payment_method.typestring

      The type of object this destination represents. For a us bank account, we expect us_bank_account.

    • from.payment_method.us_bank_accountnullable string

      The destination US bank account identifier. eg “usba_***”.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• receipt_urlnullable string

  A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.

• toobject

  A nested object containing information about the destination of the InboundTransfer.

  Hide child attributes

  • to.creditedobject

    The amount by which the FinancialAccount balance is credited.

    Hide child attributes

    • to.credited.currencystring

      A lowercase alpha3 currency code like “usd”.

    • to.credited.valueinteger

      In minor units like 123 for 1.23 USD.

  • to.financial_accountstring

    The FinancialAccount that funds will land in.

• transfer_historyarray of objects

  A list of history objects, representing changes in the state of the InboundTransfer.

  Hide child attributes

  • transfer_history.idstring

    A unique ID for the HistoryEntry.

  • transfer_history.bank_debit_failednullable object

    The history entry for a failed InboundTransfer.

    Hide child attributes

    • transfer_history.bank_debit_failed.failure_reasonenum

      The return reason for the failed InboundTransfer.

      Possible enum values

      bank_account_closed The Failure Reason when the user’s external Bank Account is closed.

      bank_account_not_found The Failure Reason when the user’s Bank Account is not found.

      bank_debit_could_not_be_processed The Failure Reason when the debit cannot be processed for any other reason.

      bank_debit_not_authorized The Failure Reason when the user hasn’t authorized the debit with their bank.

      insufficient_funds The Failure Reason when there aren’t sufficient funds in the user’s bank account.

  • transfer_history.bank_debit_processingnullable object

    The history entry for a processing InboundTransfer.

  • transfer_history.bank_debit_queuednullable object

    The history entry for a queued InboundTransfer.

  • transfer_history.bank_debit_returnednullable object

    The history entry for a returned InboundTransfer.

    Hide child attributes

    • transfer_history.bank_debit_returned.return_reasonenum

      The return reason for the returned InboundTransfer.

      Possible enum values

      bank_account_closed The Failure Reason when the user’s external Bank Account is closed.

      bank_account_not_found The Failure Reason when the user’s Bank Account is not found.

      bank_debit_could_not_be_processed The Failure Reason when the debit cannot be processed for any other reason.

      bank_debit_not_authorized The Failure Reason when the user hasn’t authorized the debit with their bank.

      insufficient_funds The Failure Reason when there aren’t sufficient funds in the user’s bank account.

  • transfer_history.bank_debit_succeedednullable object

    The history entry for a succeeded InboundTransfer.

  • transfer_history.createdtimestamp

    Creation time of the HistoryEntry in RFC 3339 format and UTC.

  • transfer_history.effective_attimestamp

    Effective at time of the HistoryEntry in RFC 3339 format and UTC.

  • transfer_history.levelenum

    The Level of the HistoryEntry.

    Possible enum values

    canonical History events that are canonical.

    debug History events that are meant to provide additional information for debugging.

  • transfer_history.typeenum

    The type of the HistoryEntry.

    Possible enum values

    bank_debit_failed History Entry type for an InboundTransfer that has failed.

    bank_debit_processing History Entry type for an InboundTransfer that is processing.

    bank_debit_queued History Entry type for a queued InboundTransfer.

    bank_debit_returned History Entry type for an InboundTransfer that has returned, after initially being successful.

    bank_debit_succeeded History Entry type for an InboundTransfer that has succeeded.