The ReceivedDebit 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.

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

• descriptionstring

  An arbitrary string attached to the object. Often useful for displaying to users.

• failure_codenullable enum

  Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn’t have sufficient funds, is closed, or is frozen.

  Possible enum values

  account_closed Funds can’t be pulled from a closed FinancialAccount.

  account_frozen Funds can’t be pulled from a frozen FinancialAccount.

  insufficient_funds The FinancialAccount doesn’t have a sufficient balance.

  international_transaction International transactions can’t pull funds from the FinancialAccount.

  other Funds can’t be pulled from the FinancialAccount for other reasons.

• financial_accountnullable string

  The FinancialAccount that funds were pulled from.

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

• initiating_payment_method_detailsobject

  Details about how a ReceivedDebit was created.

  Hide child attributes

  • initiating_payment_method_details.balancenullable enum

    Set when type is balance.

    Possible enum values

    payments The Stripe payments balance.

  • initiating_payment_method_details.billing_detailsobject

    The contact details of the person or business referenced by the received payment method details.

    Hide child attributes

    • initiating_payment_method_details.billing_details.addressobject

      Billing address.

      Hide child attributes

      • initiating_payment_method_details.billing_details.address.citynullable string

        City, district, suburb, town, or village.

      • initiating_payment_method_details.billing_details.address.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • initiating_payment_method_details.billing_details.address.line1nullable string

        Address line 1 (e.g., street, PO Box, or company name).

      • initiating_payment_method_details.billing_details.address.line2nullable string

        Address line 2 (e.g., apartment, suite, unit, or building).

      • initiating_payment_method_details.billing_details.address.postal_codenullable string

        ZIP or postal code.

      • initiating_payment_method_details.billing_details.address.statenullable string

        State, county, province, or region.

    • initiating_payment_method_details.billing_details.emailnullable string

      Email address.

    • initiating_payment_method_details.billing_details.namenullable string

      Full name.

  • initiating_payment_method_details.financial_accountnullable object

    Set when type is financial_account. This is a FinancialAccount ID.

    Hide child attributes

    • initiating_payment_method_details.financial_account.idstring

      The FinancialAccount ID.

    • initiating_payment_method_details.financial_account.networkenum

      The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over stripe.

  • initiating_payment_method_details.issuing_cardnullable string

    Set when type is issuing_card. This is an Issuing Card ID.

  • initiating_payment_method_details.typeenum

    Polymorphic type matching the originating money movement’s source. This can be an external account, a Stripe balance, or a FinancialAccount.

  • initiating_payment_method_details.us_bank_accountnullable object

    Set when type is us_bank_account.

    Hide child attributes

    • initiating_payment_method_details.us_bank_account.bank_namenullable string

      Bank name.

    • initiating_payment_method_details.us_bank_account.last4nullable string

      The last four digits of the bank account number.

    • initiating_payment_method_details.us_bank_account.routing_numbernullable string

      The routing number for the bank account.

• linked_flowsobject

  Other flows linked to a ReceivedDebit.

  Hide child attributes

  • linked_flows.debit_reversalnullable string

    The DebitReversal created as a result of this ReceivedDebit being reversed.

  • linked_flows.inbound_transfernullable string

    Set if the ReceivedDebit is associated with an InboundTransfer’s return of funds.

  • linked_flows.issuing_authorizationnullable string

    Set if the ReceivedDebit was created due to an Issuing Authorization object.

  • linked_flows.issuing_transactionnullable string

    Set if the ReceivedDebit is also viewable as an Issuing Dispute object.

  • linked_flows.payoutnullable string

    Set if the ReceivedDebit was created due to a Payout object.

• livemodeboolean

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

• networkenum

  The network used for the ReceivedDebit.

• reversal_detailsnullable object

  Details describing when a ReceivedDebit might be reversed.

  Hide child attributes

  • reversal_details.deadlinenullable timestamp

    Time before which a ReceivedDebit can be reversed.

  • reversal_details.restricted_reasonnullable enum

    Set if a ReceivedDebit can’t be reversed.

    Possible enum values

    already_reversed A ReceivedDebit that’s already reversed has this restricted_reason. It may have a deadline populated.

    deadline_passed A ReceivedDebit that used to be reversible until the timestamp in deadline, but is no longer reversible. ACH ReceivedDebits are only reversible for some time after they’re created.

    network_restricted Network constraints prevent Stripe from allowing reversal on some ReceivedDebits.

    other A ReceivedDebit that was reversed because of another reason.

    source_flow_restricted A ReceivedDebit that can’t be reversed because its source_flow is not reversible.

• statusenum

  Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code.

  Possible enum values

  failed The ReceivedDebit was declined, and no Transaction was created.

  succeeded The ReceivedDebit was approved.

• transactionnullable stringExpandable

  The Transaction associated with this object.