Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

The ReceivedCredit object 

Treasury
Received Credits
The ReceivedCredit 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 ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.

    Possible enum values
    account_closed

    Funds can’t be sent to a closed FinancialAccount.

    account_frozen

    Funds can’t be sent to a frozen FinancialAccount.

    international_transaction

    International transactions can’t be sent to FinancialAccount.

    other

    Funds can’t be sent to FinancialAccount for other reasons.

  • financial_accountnullable string

    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.

  • initiating_payment_method_detailsobject

    Details about the PaymentMethod used to send a ReceivedCredit.

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

      • initiating_payment_method_details.billing_details.addressobject

        Billing address.

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

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

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

    • linked_flows.credit_reversalnullable string

      The CreditReversal created as a result of this ReceivedCredit being reversed.

    • linked_flows.issuing_authorizationnullable string

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

    • linked_flows.issuing_transactionnullable string

      Set if the ReceivedCredit is also viewable as an Issuing transaction object.

    • linked_flows.source_flownullable string

      ID of the source flow. Set if network is stripe and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.

    • linked_flows.source_flow_detailsnullable objectExpandable

      The expandable object of the source flow.

      • linked_flows.source_flow_details.credit_reversalnullable object

        Details about a CreditReversal.

        • linked_flows.source_flow_details.credit_reversal.idstring

          Unique identifier for the object.

        • linked_flows.source_flow_details.credit_reversal.objectstring

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

        • linked_flows.source_flow_details.credit_reversal.amountinteger

          Amount (in cents) transferred.

        • linked_flows.source_flow_details.credit_reversal.createdtimestamp

          Time at which the object was created. Measured in seconds since the Unix epoch.

        • linked_flows.source_flow_details.credit_reversal.currencyenum

          Three-letter ISO currency code, in lowercase. Must be a supported currency.

        • linked_flows.source_flow_details.credit_reversal.financial_accountstring

          The FinancialAccount to reverse funds from.

        • linked_flows.source_flow_details.credit_reversal.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_flows.source_flow_details.credit_reversal.livemodeboolean

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

        • linked_flows.source_flow_details.credit_reversal.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.

        • linked_flows.source_flow_details.credit_reversal.networkenum

          The rails used to reverse the funds.

        • linked_flows.source_flow_details.credit_reversal.received_creditstring

          The ReceivedCredit being reversed.

        • linked_flows.source_flow_details.credit_reversal.statusenum

          Status of the CreditReversal

          Possible enum values
          canceled

          The CreditReversal has been canceled before it has been sent to the network and no funds have left the account. (Currently not supported).

          posted

          The CreditReversal has been sent to the network and funds have left the account (with the Transaction posting)

          processing

          The CreditReversal starting state. Funds are “held” by a pending Transaction (but they are still part of the current balance).

        • linked_flows.source_flow_details.credit_reversal.status_transitionsobject

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

          • linked_flows.source_flow_details.credit_reversal.status_transitions.posted_atnullable timestamp

            Timestamp describing when the CreditReversal changed status to posted

        • linked_flows.source_flow_details.credit_reversal.transactionnullable stringExpandable

          The Transaction associated with this object.

      • linked_flows.source_flow_details.outbound_paymentnullable object

        Details about an OutboundPayment.

        • linked_flows.source_flow_details.outbound_payment.idstring

          Unique identifier for the object.

        • linked_flows.source_flow_details.outbound_payment.objectstring

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

        • linked_flows.source_flow_details.outbound_payment.amountinteger

          Amount (in cents) transferred.

        • linked_flows.source_flow_details.outbound_payment.cancelableboolean

          Returns true if the object can be canceled, and false otherwise.

        • linked_flows.source_flow_details.outbound_payment.createdtimestamp

          Time at which the object was created. Measured in seconds since the Unix epoch.

        • linked_flows.source_flow_details.outbound_payment.currencyenum

          Three-letter ISO currency code, in lowercase. Must be a supported currency.

        • linked_flows.source_flow_details.outbound_payment.customernullable string

          ID of the customer to whom an OutboundPayment is sent.

        • linked_flows.source_flow_details.outbound_payment.descriptionnullable string

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

        • linked_flows.source_flow_details.outbound_payment.destination_payment_methodnullable string

          The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data.

        • linked_flows.source_flow_details.outbound_payment.destination_payment_method_detailsnullable object

          Details about the PaymentMethod for an OutboundPayment.

          • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_detailsobject

            Contact details for the person or business receiving the OutboundPayment.

            • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.addressobject

              Billing address.

              • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.citynullable string

                City, district, suburb, town, or village.

              • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.countrynullable string

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

              • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line1nullable string

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

              • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line2nullable string

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

              • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.postal_codenullable string

                ZIP or postal code.

              • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.statenullable string

                State, county, province, or region.

            • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.emailnullable string

              Email address.

            • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.namenullable string

              Full name.

          • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_accountnullable object

            Details about the financial_account.

            • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_account.idstring

              Token of the FinancialAccount.

            • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_account.networkenum

              The rails used to send funds.

          • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.typeenum

            The type of the payment method used in the OutboundPayment.

            Possible enum values
            financial_account
            us_bank_account

          • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_accountnullable object

            Details about the us_bank_account.

            • linked_flows.source_flow_details.outbound_payment.destination_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

            • linked_flows.source_flow_details.outbound_payment.destination_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

            • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.bank_namenullable string

              Name of the bank associated with the bank account.

            • linked_flows.source_flow_details.outbound_payment.destination_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.

            • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.last4nullable string

              Last four digits of the bank account number.

            • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.mandatenullable stringExpandable

              ID of the mandate used to make this payment.

            • linked_flows.source_flow_details.outbound_payment.destination_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.

              Possible enum values
              ach

              ACH network

              us_domestic_wire

              US domestic wire network

            • linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.routing_numbernullable string

              Routing number of the bank account.

        • linked_flows.source_flow_details.outbound_payment.end_user_detailsnullable object

          Details about the end user.

          • linked_flows.source_flow_details.outbound_payment.end_user_details.ip_addressnullable string

            IP address of the user initiating the OutboundPayment. Set if present is set to true. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.

          • linked_flows.source_flow_details.outbound_payment.end_user_details.presentboolean

            true if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, false.

        • linked_flows.source_flow_details.outbound_payment.expected_arrival_datetimestamp

          The date when funds are expected to arrive in the destination account.

        • linked_flows.source_flow_details.outbound_payment.financial_accountstring

          The FinancialAccount that funds were pulled from.

        • linked_flows.source_flow_details.outbound_payment.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_flows.source_flow_details.outbound_payment.livemodeboolean

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

        • linked_flows.source_flow_details.outbound_payment.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.

        • linked_flows.source_flow_details.outbound_payment.returned_detailsnullable object

          Details about a returned OutboundPayment. Only set when the status is returned.

          • linked_flows.source_flow_details.outbound_payment.returned_details.codeenum

            Reason for the return.

            Possible enum values
            account_closed

            The destination has been closed.

            account_frozen

            The destination has been frozen.

            bank_account_restricted

            The destination 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 destination bank account is no longer valid because its branch has changed ownership.

            declined

            The destination has declined this OutboundPayment.

            incorrect_account_holder_name

            The destination bank notified us that the bank account holder name on file is incorrect.

            invalid_account_number

            The destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.

            invalid_currency

            The destination was unable to process this OutboundPayment because of its currency.

            no_account

            The destination bank account details on file are probably incorrect. No bank account exists with these details.

            other

            The destination could not process this OutboundPayment.

          • linked_flows.source_flow_details.outbound_payment.returned_details.transactionstringExpandable

            The Transaction associated with this object.

        • linked_flows.source_flow_details.outbound_payment.statement_descriptorstring

          The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).

        • linked_flows.source_flow_details.outbound_payment.statusenum

          Current status of the OutboundPayment: processing, failed, posted, returned, canceled. An OutboundPayment is processing if it has been created and is pending. The status changes to posted once the OutboundPayment has been “confirmed” and funds have left the account, or to failed or canceled. If an OutboundPayment fails to arrive at its destination, its status will change to returned.

        • linked_flows.source_flow_details.outbound_payment.status_transitionsobject

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

          • linked_flows.source_flow_details.outbound_payment.status_transitions.canceled_atnullable timestamp

            Timestamp describing when an OutboundPayment changed status to canceled.

          • linked_flows.source_flow_details.outbound_payment.status_transitions.failed_atnullable timestamp

            Timestamp describing when an OutboundPayment changed status to failed.

          • linked_flows.source_flow_details.outbound_payment.status_transitions.posted_atnullable timestamp

            Timestamp describing when an OutboundPayment changed status to posted.

          • linked_flows.source_flow_details.outbound_payment.status_transitions.returned_atnullable timestamp

            Timestamp describing when an OutboundPayment changed status to returned.

        • linked_flows.source_flow_details.outbound_payment.tracking_detailsnullable object

          Details about network-specific tracking information if available.

          • linked_flows.source_flow_details.outbound_payment.tracking_details.achnullable object

            ACH network tracking details.

            • linked_flows.source_flow_details.outbound_payment.tracking_details.ach.trace_idstring

              ACH trace ID of the OutboundPayment for payments sent over the ach network.

          • linked_flows.source_flow_details.outbound_payment.tracking_details.typeenum

            The US bank account network used to send funds.

            Possible enum values
            ach
            us_domestic_wire

          • linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wirenullable object

            US domestic wire network tracking details.

            • linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire.chipsnullable string

              CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the us_domestic_wire network.

            • linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire.imadnullable string

              IMAD of the OutboundPayment for payments sent over the us_domestic_wire network.

            • linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire.omadnullable string

              OMAD of the OutboundPayment for payments sent over the us_domestic_wire network.

        • linked_flows.source_flow_details.outbound_payment.transactionstringExpandable

          The Transaction associated with this object.

      • linked_flows.source_flow_details.outbound_transfernullable objectPreview feature

        Details about an OutboundTransfer.

        • linked_flows.source_flow_details.outbound_transfer.idstring

          Unique identifier for the object.

        • linked_flows.source_flow_details.outbound_transfer.objectstring

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

        • linked_flows.source_flow_details.outbound_transfer.amountinteger

          Amount (in cents) transferred.

        • linked_flows.source_flow_details.outbound_transfer.cancelableboolean

          Returns true if the object can be canceled, and false otherwise.

        • linked_flows.source_flow_details.outbound_transfer.createdtimestamp

          Time at which the object was created. Measured in seconds since the Unix epoch.

        • linked_flows.source_flow_details.outbound_transfer.currencyenum

          Three-letter ISO currency code, in lowercase. Must be a supported currency.

        • linked_flows.source_flow_details.outbound_transfer.descriptionnullable string

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

        • linked_flows.source_flow_details.outbound_transfer.destination_payment_methodnullable string

          The PaymentMethod used as the payment instrument for an OutboundTransfer.

        • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_detailsobject

          Details about the PaymentMethod for an OutboundTransfer

          • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_detailsobject

            Contact details for the person or business receiving the OutboundTransfer.

            • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.addressobject

              Billing address.

              • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.citynullable string

                City, district, suburb, town, or village.

              • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.countrynullable string

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

              • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line1nullable string

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

              • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line2nullable string

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

              • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.postal_codenullable string

                ZIP or postal code.

              • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.statenullable string

                State, county, province, or region.

            • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.emailnullable string

              Email address.

            • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.namenullable string

              Full name.

          • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.financial_accountnullable objectPreview feature

            Details about the financial_account.

            • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.financial_account.idstring

              Token of the FinancialAccount.

            • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.financial_account.networkenum

              The rails used to send funds.

          • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.typeenum

            The type of the payment method used in the OutboundTransfer.

          • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_accountnullable object

            Details about the us_bank_account.

            • linked_flows.source_flow_details.outbound_transfer.destination_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

            • linked_flows.source_flow_details.outbound_transfer.destination_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

            • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.bank_namenullable string

              Name of the bank associated with the bank account.

            • linked_flows.source_flow_details.outbound_transfer.destination_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.

            • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.last4nullable string

              Last four digits of the bank account number.

            • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.mandatenullable stringExpandable

              ID of the mandate used to make this payment.

            • linked_flows.source_flow_details.outbound_transfer.destination_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.

              Possible enum values
              ach

              ACH network

              us_domestic_wire

              US domestic wire network

            • linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.routing_numbernullable string

              Routing number of the bank account.

        • linked_flows.source_flow_details.outbound_transfer.expected_arrival_datetimestamp

          The date when funds are expected to arrive in the destination account.

        • linked_flows.source_flow_details.outbound_transfer.financial_accountstring

          The FinancialAccount that funds were pulled from.

        • linked_flows.source_flow_details.outbound_transfer.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_flows.source_flow_details.outbound_transfer.livemodeboolean

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

        • linked_flows.source_flow_details.outbound_transfer.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.

        • linked_flows.source_flow_details.outbound_transfer.returned_detailsnullable object

          Details about a returned OutboundTransfer. Only set when the status is returned.

          • linked_flows.source_flow_details.outbound_transfer.returned_details.codeenum

            Reason for the return.

            Possible enum values
            account_closed

            The destination has been closed.

            account_frozen

            The destination has been frozen.

            bank_account_restricted

            The destination 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 destination bank account is no longer valid because its branch has changed ownership.

            declined

            The destination has declined this OutboundTransfer.

            incorrect_account_holder_name

            The destination bank notified us that the bank account holder name on file is incorrect.

            invalid_account_number

            The destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.

            invalid_currency

            The destination was unable to process this OutboundTransfer because of its currency.

            no_account

            The destination bank account details on file are probably incorrect. No bank account exists with these details.

            other

            The destination could not process this OutboundTransfer.

          • linked_flows.source_flow_details.outbound_transfer.returned_details.transactionstringExpandable

            The Transaction associated with this object.

        • linked_flows.source_flow_details.outbound_transfer.statement_descriptorstring

          Information about the OutboundTransfer to be sent to the recipient account.

        • linked_flows.source_flow_details.outbound_transfer.statusenum

          Current status of the OutboundTransfer: processing, failed, canceled, posted, returned. An OutboundTransfer is processing if it has been created and is pending. The status changes to posted once the OutboundTransfer has been “confirmed” and funds have left the account, or to failed or canceled. If an OutboundTransfer fails to arrive at its destination, its status will change to returned.

        • linked_flows.source_flow_details.outbound_transfer.status_transitionsobject

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

          • linked_flows.source_flow_details.outbound_transfer.status_transitions.canceled_atnullable timestamp

            Timestamp describing when an OutboundTransfer changed status to canceled

          • linked_flows.source_flow_details.outbound_transfer.status_transitions.failed_atnullable timestamp

            Timestamp describing when an OutboundTransfer changed status to failed

          • linked_flows.source_flow_details.outbound_transfer.status_transitions.posted_atnullable timestamp

            Timestamp describing when an OutboundTransfer changed status to posted

          • linked_flows.source_flow_details.outbound_transfer.status_transitions.returned_atnullable timestamp

            Timestamp describing when an OutboundTransfer changed status to returned

        • linked_flows.source_flow_details.outbound_transfer.tracking_detailsnullable object

          Details about network-specific tracking information if available.

          • linked_flows.source_flow_details.outbound_transfer.tracking_details.achnullable object

            ACH network tracking details.

            • linked_flows.source_flow_details.outbound_transfer.tracking_details.ach.trace_idstring

              ACH trace ID of the OutboundTransfer for transfers sent over the ach network.

          • linked_flows.source_flow_details.outbound_transfer.tracking_details.typeenum

            The US bank account network used to send funds.

            Possible enum values
            ach
            us_domestic_wire

          • linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wirenullable object

            US domestic wire network tracking details.

            • linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire.chipsnullable string

              CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the us_domestic_wire network.

            • linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire.imadnullable string

              IMAD of the OutboundTransfer for transfers sent over the us_domestic_wire network.

            • linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire.omadnullable string

              OMAD of the OutboundTransfer for transfers sent over the us_domestic_wire network.

        • linked_flows.source_flow_details.outbound_transfer.transactionstringExpandable

          The Transaction associated with this object.

      • linked_flows.source_flow_details.payoutnullable object

        Details about a Payout.

        • linked_flows.source_flow_details.payout.idstring

          Unique identifier for the object.

        • linked_flows.source_flow_details.payout.objectstring

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

        • linked_flows.source_flow_details.payout.amountinteger

          The amount (in cents) that transfers to your bank account or debit card.

        • linked_flows.source_flow_details.payout.application_feenullable stringExpandableConnect only

          The application fee (if any) for the payout. See the Connect documentation for details.

        • linked_flows.source_flow_details.payout.application_fee_amountnullable integerConnect only

          The amount of the application fee (if any) requested for the payout. See the Connect documentation for details.

        • linked_flows.source_flow_details.payout.arrival_datetimestamp

          Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.

        • linked_flows.source_flow_details.payout.automaticboolean

          Returns true if the payout is created by an automated payout schedule and false if it’s requested manually.

        • linked_flows.source_flow_details.payout.balance_transactionnullable stringExpandable

          ID of the balance transaction that describes the impact of this payout on your account balance.

        • linked_flows.source_flow_details.payout.createdtimestamp

          Time at which the object was created. Measured in seconds since the Unix epoch.

        • linked_flows.source_flow_details.payout.currencyenum

          Three-letter ISO currency code, in lowercase. Must be a supported currency.

        • linked_flows.source_flow_details.payout.descriptionnullable string

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

        • linked_flows.source_flow_details.payout.destinationnullable stringExpandable

          ID of the bank account or card the payout is sent to.

        • linked_flows.source_flow_details.payout.failure_balance_transactionnullable stringExpandable

          If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.

        • linked_flows.source_flow_details.payout.failure_codenullable string

          Error code that provides a reason for a payout failure, if available. View our list of failure codes.

        • linked_flows.source_flow_details.payout.failure_messagenullable string

          Message that provides the reason for a payout failure, if available.

        • linked_flows.source_flow_details.payout.livemodeboolean

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

        • linked_flows.source_flow_details.payout.metadatanullable object

          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.

        • linked_flows.source_flow_details.payout.methodstring

          The method used to send this payout, which can be standard or instant. instant is supported for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts.

        • linked_flows.source_flow_details.payout.original_payoutnullable stringExpandable

          If the payout reverses another, this is the ID of the original payout.

        • linked_flows.source_flow_details.payout.reconciliation_statusenum

          If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout.

          Possible enum values
          completed

          The Balance Transactions paid out in this payout. You can query it with the Balance Transactions API.

          in_progress

          You can query the Balance Transactions paid out in this payout soon.

          not_applicable

          We don’t support listing Balance Transactions for this payout. We only support this for standard automatic payouts.

        • linked_flows.source_flow_details.payout.reversed_bynullable stringExpandable

          If the payout reverses, this is the ID of the payout that reverses this payout.

        • linked_flows.source_flow_details.payout.source_typestring

          The source balance this payout came from, which can be one of the following: card, fpx, or bank_account.

        • linked_flows.source_flow_details.payout.statement_descriptornullable string

          Extra information about a payout that displays on the user’s bank statement.

        • linked_flows.source_flow_details.payout.statusstring

          Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it’s submitted to the bank, when it becomes in_transit. The status changes to paid if the transaction succeeds, or to failed or canceled (within 5 business days). Some payouts that fail might initially show as paid, then change to failed.

        • linked_flows.source_flow_details.payout.trace_idnullable object

          A value that generates from the beneficiary’s bank that allows users to track payouts with their bank. Banks might call this a “reference number” or something similar.

          • linked_flows.source_flow_details.payout.trace_id.statusstring

            Possible values are pending, supported, and unsupported. When payout.status is pending or in_transit, this will be pending. When the payout transitions to paid, failed, or canceled, this status will become supported or unsupported shortly after in most cases. In some cases, this may appear as pending for up to 10 days after arrival_date until transitioning to supported or unsupported.

          • linked_flows.source_flow_details.payout.trace_id.valuenullable string

            The trace ID value if trace_id.status is supported, otherwise nil.

        • linked_flows.source_flow_details.payout.typeenum

          Can be bank_account or card.

      • linked_flows.source_flow_details.typeenum

        The type of the source flow that originated the ReceivedCredit.

        Possible enum values
        credit_reversal

        ReceivedCredits that were reversed and have associated CreditReversals.

        other

        ReceivedCredits created from other source flow.

        outbound_payment

        ReceivedCredits created from OutboundPayments.

        outbound_transfer

        ReceivedCredits created from OutboundPayments.

        payout

        ReceivedCredits created from Payouts.

    • linked_flows.source_flow_typenullable string

      The type of flow that originated the ReceivedCredit (for example, outbound_payment).

  • 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 rails used to send the funds.

    Possible enum values
    ach
    card
    stripe
    us_domestic_wire

  • reversal_detailsnullable object

    Details describing when a ReceivedCredit may be reversed.

    • reversal_details.deadlinenullable timestamp

      Time before which a ReceivedCredit can be reversed.

    • reversal_details.restricted_reasonnullable enum

      Set if a ReceivedCredit cannot be reversed.

      Possible enum values
      already_reversed

      A ReceivedCredit that’s already reversed has this restricted_reason. It may have a deadline populated in some cases.

      deadline_passed

      A ReceivedCredit which used to be reversible until the timestamp in deadline, but is no longer reversible. ACH ReceivedCredits are only reversible for some time after they’re created.

      network_restricted

      Network constraints prevent Stripe from allowing reversal on some ReceivedCredits, such as a ReceivedCredit from a wire transfer.

      other

      A ReceivedCredit that was reversed because of another reason.

      source_flow_restricted

      Stripe restricts users from reversing a Stripe network ReceivedCredit.

  • statusenum

    Status of the ReceivedCredit. ReceivedCredits are created either succeeded (approved) or failed (declined). If a ReceivedCredit is declined, the failure reason can be found in the failure_code field.

    Possible enum values
    failed

    The ReceivedCredit was declined, and no Transaction was created.

    succeeded

    The ReceivedCredit was approved.

  • transactionnullable stringExpandable

    The Transaction associated with this object.

The ReceivedCredit object
{
  "id": "rc_1MtkSr2eZvKYlo2CcysvUbEw",
  "object": "treasury.received_credit",
  "amount": 1000,
  "created": 1680755425,
  "currency": "usd",
  "description": "Stripe Test",
  "failure_code": null,
  "financial_account": "fa_1MtkSr2eZvKYlo2CsJozwFWD",
  "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOKVuaEGMgagXvSInCY6NpMvimqdsEKNHRrHZ3OGyVm_l5LfDMezNeY83F5Mq-rryXZ-J1z-jfFBv30wz5WxDH97VRBIzw",
  "initiating_payment_method_details": {
    "billing_details": {
      "address": {
        "city": null,
        "country": null,
        "line1": null,
        "line2": null,
        "postal_code": null,
        "state": null
      },
      "email": null,
      "name": "Jane Austen"
    },
    "type": "us_bank_account",
    "us_bank_account": {
      "bank_name": "STRIPE TEST BANK",
      "last4": "6789",
      "routing_number": "110000000"
    }
  },
  "linked_flows": {
    "credit_reversal": null,
    "issuing_authorization": null,
    "issuing_transaction": null,
    "source_flow": null,
    "source_flow_type": null
  },
  "livemode": false,
  "network": "ach",
  "reversal_details": {
    "deadline": 1681084800,
    "restricted_reason": null
  },
  "status": "succeeded",
  "transaction": "trxn_1MtkSr2eZvKYlo2CuFFh9Rh0"
}