List all ReceivedDebit objects v2

Response attributes

• dataarray of objects

  The retrieved ReceivedDebits.

  Hide child attributes

  • data.idstring

    Unique identifier for the ReceivedDebit.

  • data.objectstring, value is "v2.money_management.received_debit"

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

  • data.amountobject

    Amount and currency of the ReceivedDebit.

    Hide child attributes

    • data.amount.currencystring

      A lowercase alpha3 currency code like “usd”.

    • data.amount.valueinteger

      In minor units like 123 for 1.23 USD.

  • data.bank_transfernullable object

    This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if type field value is bank_transfer.

    Hide child attributes

    • data.bank_transfer.financial_addressstring

      The Financial Address that was debited.

    • data.bank_transfer.payment_method_typeenum

      The type of the payment method used to originate the debit.

      Possible enum values

      us_bank_account The debit was originated from a US Bank Account.

    • data.bank_transfer.statement_descriptornullable string

      The statement descriptor set by the originator of the debit.

    • data.bank_transfer.us_bank_accountobject

      The payment method used to originate the debit.

      Hide child attributes

      • data.bank_transfer.us_bank_account.bank_namenullable string

        The name of the bank the debit originated from.

      • data.bank_transfer.us_bank_account.networkenum

        The bank network the debit was originated on.

        Possible enum values

        ach Funds received via ACH (Automated Clearing House) network.

      • data.bank_transfer.us_bank_account.routing_numbernullable string

        The routing number of the bank that originated the debit.

  • data.createdtimestamp

    The time at which the ReceivedDebit was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

  • data.descriptionnullable string

    Freeform string sent by the originator of the ReceivedDebit.

  • data.financial_accountstring

    Financial Account on which funds for ReceivedDebit were debited.

  • data.livemodeboolean

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

  • data.receipt_urlnullable string

    A link to the Stripe-hosted receipt for this ReceivedDebit.

  • data.statusenum

    The status of the ReceivedDebit.

    Possible enum values

    canceled The ReceivedDebit was canceled and the balance has been adjusted.

    failed The ReceivedDebit was rejected by Stripe and funds don’t change existing balance. More details why it failed can be obtained from status_details.

    pending The ReceivedDebit was successfully processed. However, the funds are not yet available for use.

    returned The ReceivedDebit was returned from the originator bank and the balance has been adjusted accordingly.

    succeeded The ReceivedDebit was successfully processed and balance reflects the withdrawn funds. Note that this is not a terminal state. The ReceivedDebit status may transition to returned even after succeeded.

  • data.status_detailsnullable object

    Detailed information about the status of the ReceivedDebit.

    Hide child attributes

    • data.status_details.failedobject

      Information that elaborates on the failed status of a ReceivedDebit. It is only present when the ReceivedDebit status is failed.

      Hide child attributes

      • data.status_details.failed.reasonenum

        The reason for the failure of the ReceivedDebit.

        Possible enum values

        financial_address_inactive Funds rejected because the associated Financial Address has been archived.

        insufficient_funds Funds rejected due to insufficient funds on balance.

        stripe_rejected Funds were rejected Stripe.

  • data.status_transitionsnullable object

    The time at which the ReceivedDebit transitioned to a particular status.

    Hide child attributes

    • data.status_transitions.canceled_atnullable timestamp

      The time when the ReceivedDebit was marked as canceled. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • data.status_transitions.failed_atnullable timestamp

      The time when the ReceivedDebit was marked as failed. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • data.status_transitions.succeeded_atnullable timestamp

      The time when the ReceivedDebit was marked as succeeded. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

  • data.typeenum

    The type of the ReceivedDebit.

    Possible enum values

    bank_transfer The ReceivedDebit is the result of an bank transfer.

    external_debit Replaced by BANK_TRANSFER, kept for backwards compatibility. The ReceivedDebit is the result of an external debit.

• next_page_urlnullable string

  The next page url.

• previous_page_urlnullable string

  The previous page url.