The TransactionEntry object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

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

• balance_impactobject

  The current impact of the TransactionEntry on the FinancialAccount’s balance.

  Hide child attributes

  • balance_impact.cashinteger

    The change made to funds the user can spend right now.

  • balance_impact.inbound_pendinginteger

    The change made to funds that are not spendable yet, but will become available at a later time.

  • balance_impact.outbound_pendinginteger

    The change made to funds in the account, but not spendable because they are being held for pending outbound flows.

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

• effective_attimestamp

  When the TransactionEntry will impact the FinancialAccount’s balance.

• financial_accountstring

  The FinancialAccount associated with this object.

• flownullable string

  Token of the flow associated with the TransactionEntry.

• flow_detailsnullable objectExpandable

  Details of the flow associated with the TransactionEntry.

  Hide child attributes

  • flow_details.credit_reversalnullable object

    The CreditReversal object associated with the Transaction. Set if type=credit_reversal.

    Hide child attributes

    • flow_details.credit_reversal.idstring

      Unique identifier for the object.

    • flow_details.credit_reversal.objectstring

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

    • flow_details.credit_reversal.amountinteger

      Amount (in cents) transferred.

    • flow_details.credit_reversal.createdtimestamp

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

    • flow_details.credit_reversal.currencyenum

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

    • flow_details.credit_reversal.financial_accountstring

      The FinancialAccount to reverse funds from.

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

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

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

    • flow_details.credit_reversal.networkenum

      The rails used to reverse the funds.

    • flow_details.credit_reversal.received_creditstring

      The ReceivedCredit being reversed.

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

    • flow_details.credit_reversal.status_transitionsobject

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

      Hide child attributes

      • flow_details.credit_reversal.status_transitions.posted_atnullable timestamp

        Timestamp describing when the CreditReversal changed status to posted

    • flow_details.credit_reversal.transactionnullable stringExpandable

      The Transaction associated with this object.

  • flow_details.debit_reversalnullable object

    The DebitReversal object associated with the Transaction. Set if type=debit_reversal.

    Hide child attributes

    • flow_details.debit_reversal.idstring

      Unique identifier for the object.

    • flow_details.debit_reversal.objectstring

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

    • flow_details.debit_reversal.amountinteger

      Amount (in cents) transferred.

    • flow_details.debit_reversal.createdtimestamp

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

    • flow_details.debit_reversal.currencyenum

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

    • flow_details.debit_reversal.financial_accountnullable string

      The FinancialAccount to reverse funds from.

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

    • flow_details.debit_reversal.linked_flowsnullable object

      Other flows linked to a DebitReversal.

      Hide child attributes

      • flow_details.debit_reversal.linked_flows.issuing_disputenullable string

        Set if there is an Issuing dispute associated with the DebitReversal.

    • flow_details.debit_reversal.livemodeboolean

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

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

    • flow_details.debit_reversal.networkenum

      The rails used to reverse the funds.

    • flow_details.debit_reversal.received_debitstring

      The ReceivedDebit being reversed.

    • flow_details.debit_reversal.statusenum

      Status of the DebitReversal

      Possible enum values

      failed The network has resolved the DebitReversal against the user.

      processing The DebitReversal starting state.

      succeeded The network has resolved the DebitReversal in the users favour. A crediting Transaction is created.

    • flow_details.debit_reversal.status_transitionsobject

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

      Hide child attributes

      • flow_details.debit_reversal.status_transitions.completed_atnullable timestamp

        Timestamp describing when the DebitReversal changed status to completed.

    • flow_details.debit_reversal.transactionnullable stringExpandable

      The Transaction associated with this object.

  • flow_details.inbound_transfernullable object

    The InboundTransfer object associated with the Transaction. Set if type=inbound_transfer.

    Hide child attributes

    • flow_details.inbound_transfer.idstring

      Unique identifier for the object.

    • flow_details.inbound_transfer.objectstring

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

    • flow_details.inbound_transfer.amountinteger

      Amount (in cents) transferred.

    • flow_details.inbound_transfer.cancelableboolean

      Returns true if the InboundTransfer is able to be canceled.

    • flow_details.inbound_transfer.createdtimestamp

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

    • flow_details.inbound_transfer.currencyenum

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

    • flow_details.inbound_transfer.descriptionnullable string

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

    • flow_details.inbound_transfer.failure_detailsnullable object

      Details about this InboundTransfer’s failure. Only set when status is failed.

      Hide child attributes

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

    • flow_details.inbound_transfer.financial_accountstring

      The FinancialAccount that received the funds.

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

    • flow_details.inbound_transfer.linked_flowsobject

      Other flows linked to a InboundTransfer.

      Hide child attributes

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

    • flow_details.inbound_transfer.livemodeboolean

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

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

    • flow_details.inbound_transfer.origin_payment_methodnullable string

      The origin payment method to be debited for an InboundTransfer.

    • flow_details.inbound_transfer.origin_payment_method_detailsnullable object

      Details about the PaymentMethod for an InboundTransfer.

      Hide child attributes

      • flow_details.inbound_transfer.origin_payment_method_details.billing_detailsobject

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

        Hide child attributes

        • flow_details.inbound_transfer.origin_payment_method_details.billing_details.addressobject

          Billing address.

          Hide child attributes

          • flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.citynullable string

            City, district, suburb, town, or village.

          • flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.countrynullable string

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

          • flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.line1nullable string

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

          • flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.line2nullable string

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

          • flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.postal_codenullable string

            ZIP or postal code.

          • flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.statenullable string

            State, county, province, or region.

        • flow_details.inbound_transfer.origin_payment_method_details.billing_details.emailnullable string

          Email address.

        • flow_details.inbound_transfer.origin_payment_method_details.billing_details.namenullable string

          Full name.

      • flow_details.inbound_transfer.origin_payment_method_details.typeenum

        The type of the payment method used in the InboundTransfer.

        Possible enum values

        us_bank_account US Bank Account

      • flow_details.inbound_transfer.origin_payment_method_details.us_bank_accountnullable object

        Optional fields for us_bank_account.

        Hide child attributes

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

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

        • flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.bank_namenullable string

          Name of the bank associated with the bank account.

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

        • flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.last4nullable string

          Last four digits of the bank account number.

        • flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.mandatenullable stringExpandable

          ID of the mandate used to make this payment.

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

        • flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.routing_numbernullable string

          Routing number of the bank account.

    • flow_details.inbound_transfer.returnednullable boolean

      Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.

    • flow_details.inbound_transfer.statement_descriptorstring

      Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.

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

    • flow_details.inbound_transfer.status_transitionsobject

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

      Hide child attributes

      • flow_details.inbound_transfer.status_transitions.failed_atnullable timestamp

        Timestamp describing when an InboundTransfer changed status to failed.

      • flow_details.inbound_transfer.status_transitions.succeeded_atnullable timestamp

        Timestamp describing when an InboundTransfer changed status to succeeded.

    • flow_details.inbound_transfer.transactionnullable stringExpandable

      The Transaction associated with this object.

  • flow_details.issuing_authorizationnullable object

    The Issuing authorization object associated with the Transaction. Set if type=issuing_authorization.

    Hide child attributes

    • flow_details.issuing_authorization.idstring

      Unique identifier for the object.

    • flow_details.issuing_authorization.objectstring

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

    • flow_details.issuing_authorization.amountinteger

      The total amount that was authorized or rejected. This amount is in currency and in the smallest currency unit. amount should be the same as merchant_amount, unless currency and merchant_currency are different.

    • flow_details.issuing_authorization.amount_detailsnullable object

      Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.

      Hide child attributes

      • flow_details.issuing_authorization.amount_details.atm_feenullable integer

        The fee charged by the ATM for the cash withdrawal.

      • flow_details.issuing_authorization.amount_details.cashback_amountnullable integer

        The amount of cash requested by the cardholder.

    • flow_details.issuing_authorization.approvedboolean

      Whether the authorization has been approved.

    • flow_details.issuing_authorization.authorization_methodenum

      How the card details were provided.

      Possible enum values

      chip The card was physically present and inserted into a chip-enabled terminal. The transaction is cryptographically secured.

      contactless The card was tapped on a contactless-enabled terminal. If a digital wallet copy of the card was used, the wallet field will be present.

      keyed_in The card number was manually entered into a terminal.

      online The card was used in a card-not-present scenario, such as a transaction initiated at an online e-commerce checkout.

      swipe The card was physically swiped in a terminal.

    • flow_details.issuing_authorization.balance_transactionsarray of objects

      List of balance transactions associated with this authorization.

      Hide child attributes

      • flow_details.issuing_authorization.balance_transactions.idstring

        Unique identifier for the object.

      • flow_details.issuing_authorization.balance_transactions.objectstring

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

      • flow_details.issuing_authorization.balance_transactions.amountinteger

        Gross amount of this transaction (in cents). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.

      • flow_details.issuing_authorization.balance_transactions.available_ontimestamp

        The date that the transaction’s net funds become available in the Stripe balance.

      • flow_details.issuing_authorization.balance_transactions.balance_typeenumPreview feature

        The balance that this transaction impacts.

        Possible enum values

        issuing Balance Transactions that affect your Issuing balance

        payments Balance Transactions that affect your Payments balance

        refund_and_dispute_prefunding Balance Transactions that affect your Refund and Dispute Prefunding balance

      • flow_details.issuing_authorization.balance_transactions.createdtimestamp

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

      • flow_details.issuing_authorization.balance_transactions.currencyenum

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

      • flow_details.issuing_authorization.balance_transactions.descriptionnullable string

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

      • flow_details.issuing_authorization.balance_transactions.exchange_ratenullable float

        If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the amount in currency A, multipled by the exchange_rate, equals the amount in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent’s amount is 1000 and currency is eur. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction’s amount is 1234, its currency is usd, and the exchange_rate is 1.234.

      • flow_details.issuing_authorization.balance_transactions.feeinteger

        Fees (in cents) paid for this transaction. Represented as a positive integer when assessed.

      • flow_details.issuing_authorization.balance_transactions.fee_detailsarray of objects

        Detailed breakdown of fees (in cents) paid for this transaction.

        Hide child attributes

        • flow_details.issuing_authorization.balance_transactions.fee_details.amountinteger

          Amount of the fee, in cents.

        • flow_details.issuing_authorization.balance_transactions.fee_details.applicationnullable string

          ID of the Connect application that earned the fee.

        • flow_details.issuing_authorization.balance_transactions.fee_details.currencyenum

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

        • flow_details.issuing_authorization.balance_transactions.fee_details.descriptionnullable string

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

        • flow_details.issuing_authorization.balance_transactions.fee_details.typestring

          Type of the fee, one of: application_fee, payment_method_passthrough_fee, stripe_fee or tax.

      • flow_details.issuing_authorization.balance_transactions.netinteger

        Net impact to a Stripe balance (in cents). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by amount - fee

      • flow_details.issuing_authorization.balance_transactions.reporting_categorystring

        Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.

      • flow_details.issuing_authorization.balance_transactions.sourcenullable stringExpandable

        This transaction relates to the Stripe object.

      • flow_details.issuing_authorization.balance_transactions.statusstring

        The transaction’s net funds status in the Stripe balance, which are either available or pending.

      • flow_details.issuing_authorization.balance_transactions.typeenum

        Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, obligation_outbound, obligation_reversal_inbound, payment, payment_failure_refund, payment_network_reserve_hold, payment_network_reserve_release, payment_refund, payment_reversal, payment_unreconciled, payout, payout_cancel, payout_failure, payout_minimum_balance_hold, payout_minimum_balance_release, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, stripe_balance_payment_debit, stripe_balance_payment_debit_reversal, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, consider reporting_category instead.

        Possible enum values

        adjustment

        advance

        advance_funding

        anticipation_repayment

        application_fee

        application_fee_refund

        charge

        climate_order_purchase

        climate_order_refund

        connect_collection_transfer

        Show 34 more

    • flow_details.issuing_authorization.cardobject

      Card associated with this authorization.

      Hide child attributes

      • flow_details.issuing_authorization.card.idstring

        Unique identifier for the object.

      • flow_details.issuing_authorization.card.objectstring

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

      • flow_details.issuing_authorization.card.brandstring

        The brand of the card.

      • flow_details.issuing_authorization.card.cancellation_reasonnullable enum

        The reason why the card was canceled.

        Possible enum values

        design_rejected The design of this card was rejected by Stripe for violating our partner guidelines.

        lost The card was lost.

        stolen The card was stolen.

      • flow_details.issuing_authorization.card.cardholderobject

        The Cardholder object to which the card belongs.

        Hide child attributes

        • flow_details.issuing_authorization.card.cardholder.idstring

          Unique identifier for the object.

        • flow_details.issuing_authorization.card.cardholder.objectstring

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

        • flow_details.issuing_authorization.card.cardholder.billingobject

          The cardholder’s billing information.

          Hide child attributes

          • flow_details.issuing_authorization.card.cardholder.billing.addressobject

            The cardholder’s billing address.

            Hide child attributes

            • flow_details.issuing_authorization.card.cardholder.billing.address.citynullable string

              City, district, suburb, town, or village.

            • flow_details.issuing_authorization.card.cardholder.billing.address.countrynullable string

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

            • flow_details.issuing_authorization.card.cardholder.billing.address.line1nullable string

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

            • flow_details.issuing_authorization.card.cardholder.billing.address.line2nullable string

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

            • flow_details.issuing_authorization.card.cardholder.billing.address.postal_codenullable string

              ZIP or postal code.

            • flow_details.issuing_authorization.card.cardholder.billing.address.statenullable string

              State, county, province, or region.

        • flow_details.issuing_authorization.card.cardholder.companynullable object

          Additional information about a company cardholder.

          Hide child attributes

          • flow_details.issuing_authorization.card.cardholder.company.tax_id_providedboolean

            Whether the company’s business ID number was provided.

        • flow_details.issuing_authorization.card.cardholder.createdtimestamp

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

        • flow_details.issuing_authorization.card.cardholder.emailnullable string

          The cardholder’s email address.

        • flow_details.issuing_authorization.card.cardholder.individualnullable object

          Additional information about an individual cardholder.

          Hide child attributes

          • flow_details.issuing_authorization.card.cardholder.individual.card_issuingnullable object

            Information related to the card_issuing program for this cardholder.

            Hide child attributes

            • flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptancenullable object

              Information about cardholder acceptance of Celtic Authorized User Terms. Required for cards backed by a Celtic program.

              Hide child attributes

              • flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance.datenullable timestamp

                The Unix timestamp marking when the cardholder accepted the Authorized User Terms.

              • flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance.ipnullable string

                The IP address from which the cardholder accepted the Authorized User Terms.

              • flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance.user_agentnullable string

                The user agent of the browser from which the cardholder accepted the Authorized User Terms.

          • flow_details.issuing_authorization.card.cardholder.individual.dobnullable object

            The date of birth of this cardholder.

            Hide child attributes

            • flow_details.issuing_authorization.card.cardholder.individual.dob.daynullable integer

              The day of birth, between 1 and 31.

            • flow_details.issuing_authorization.card.cardholder.individual.dob.monthnullable integer

              The month of birth, between 1 and 12.

            • flow_details.issuing_authorization.card.cardholder.individual.dob.yearnullable integer

              The four-digit year of birth.

          • flow_details.issuing_authorization.card.cardholder.individual.first_namenullable string

            The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.

          • flow_details.issuing_authorization.card.cardholder.individual.last_namenullable string

            The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.

          • flow_details.issuing_authorization.card.cardholder.individual.verificationnullable object

            Government-issued ID document for this cardholder.

            Hide child attributes

            • flow_details.issuing_authorization.card.cardholder.individual.verification.documentnullable object

              An identifying document, either a passport or local ID card.

              Hide child attributes

              • flow_details.issuing_authorization.card.cardholder.individual.verification.document.backnullable stringExpandable

                The back of a document returned by a file upload with a purpose value of identity_document.

              • flow_details.issuing_authorization.card.cardholder.individual.verification.document.frontnullable stringExpandable

                The front of a document returned by a file upload with a purpose value of identity_document.

        • flow_details.issuing_authorization.card.cardholder.livemodeboolean

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

        • flow_details.issuing_authorization.card.cardholder.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.

        • flow_details.issuing_authorization.card.cardholder.namestring

          The cardholder’s name. This will be printed on cards issued to them.

        • flow_details.issuing_authorization.card.cardholder.phone_numbernullable string

          The cardholder’s phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.

        • flow_details.issuing_authorization.card.cardholder.preferred_localesnullable array of enums

          The cardholder’s preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.

        • flow_details.issuing_authorization.card.cardholder.requirementsobject

          Information about verification requirements for the cardholder.

          Hide child attributes

          • flow_details.issuing_authorization.card.cardholder.requirements.disabled_reasonnullable enum

            If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason.

            Possible enum values

            listed Account might be on a prohibited persons or companies list. The past_due field contains information that you need to provide before the cardholder can approve authorizations.

            rejected.listed Cardholder is rejected because they are on a third-party prohibited persons or companies list (such as financial services provider or government). Their status will be blocked.

            requirements.past_due Cardholder has outstanding requirements. The past_due field contains information that you need to provide before the cardholder can activate cards.

            under_review This cardholder has raised additional review. Stripe will make a decision and update the disabled_reason field.

          • flow_details.issuing_authorization.card.cardholder.requirements.past_duenullable array of enums

            Array of fields that need to be collected in order to verify and re-enable the cardholder.

            Possible enum values

            company.tax_id The cardholder’s business number (Tax ID).

            individual.card_issuing.user_terms_acceptance.date The Unix timestamp marking when the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users.

            individual.card_issuing.user_terms_acceptance.ip The IP address from which the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users.

            individual.dob.day The cardholder’s date of birth’s day.

            individual.dob.month The cardholder’s date of birth’s month.

            individual.dob.year The cardholder’s date of birth’s year.

            individual.first_name The cardholder’s legal first name.

            individual.last_name The cardholder’s legal last name.

            individual.verification.document The front and back of a government-issued form of identification.

        • flow_details.issuing_authorization.card.cardholder.spending_controlsnullable object

          Rules that control spending across this cardholder’s cards. Refer to our documentation for more details.

          Hide child attributes

          • flow_details.issuing_authorization.card.cardholder.spending_controls.allowed_categoriesnullable array of enums

            Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories.

            Possible enum values

            ac_refrigeration_repair

            accounting_bookkeeping_services

            advertising_services

            agricultural_cooperative

            airlines_air_carriers

            airports_flying_fields

            ambulance_services

            amusement_parks_carnivals

            antique_reproductions

            antique_shops

            Show 285 more

          • flow_details.issuing_authorization.card.cardholder.spending_controls.allowed_merchant_countriesnullable array of strings

            Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.

          • flow_details.issuing_authorization.card.cardholder.spending_controls.blocked_categoriesnullable array of enums

            Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories.

            Possible enum values

            ac_refrigeration_repair

            accounting_bookkeeping_services

            advertising_services

            agricultural_cooperative

            airlines_air_carriers

            airports_flying_fields

            ambulance_services

            amusement_parks_carnivals

            antique_reproductions

            antique_shops

            Show 285 more

          • flow_details.issuing_authorization.card.cardholder.spending_controls.blocked_merchant_countriesnullable array of strings

            Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.

          • flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limitsnullable array of objects

            Limit spending with amount-based rules that apply across this cardholder’s cards.

            Hide child attributes

            • flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits.amountinteger

              Maximum amount allowed to spend per interval. This amount is in the card’s currency and in the smallest currency unit.

            • flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits.categoriesnullable array of enums

              Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.

              Possible enum values

              ac_refrigeration_repair

              accounting_bookkeeping_services

              advertising_services

              agricultural_cooperative

              airlines_air_carriers

              airports_flying_fields

              ambulance_services

              amusement_parks_carnivals

              antique_reproductions

              antique_shops

              Show 285 more

            • flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits.intervalenum

              Interval (or event) to which the amount applies.

              Possible enum values

              all_time Limit applies to all transactions.

              daily Limit applies to a day, starting at midnight UTC.

              monthly Limit applies to a month, starting on the 1st at midnight UTC.

              per_authorization Limit applies to each authorization.

              weekly Limit applies to a week, starting on Sunday at midnight UTC.

              yearly Limit applies to a year, starting on January 1st at midnight UTC.

          • flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits_currencynullable enum

            Currency of the amounts within spending_limits.

        • flow_details.issuing_authorization.card.cardholder.statusenum

          Specifies whether to permit authorizations on this cardholder’s cards.

          Possible enum values

          active Cards attached to this cardholder can approve authorizations.

          blocked Cards attached to this cardholder will decline all authorizations with the cardholder_blocked reason. This status is non-reversible.

          inactive Cards attached to this cardholder will decline all authorizations with the cardholder_inactive reason.

        • flow_details.issuing_authorization.card.cardholder.typeenum

          One of individual or company. See Choose a cardholder type for more details.

          Possible enum values

          company The cardholder is a company or business entity, and additional information includes their tax ID. This option may not be available if your use case only supports individual cardholders.

          individual The cardholder is a person, and additional information includes first and last name, date of birth, etc. If you’re issuing Celtic Spend Cards, then Individual cardholders must accept Authorized User Terms prior to activating their card.

      • flow_details.issuing_authorization.card.createdtimestamp

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

      • flow_details.issuing_authorization.card.currencyenum

        Three-letter ISO currency code, in lowercase. Supported currencies are usd in the US, eur in the EU, and gbp in the UK.

      • flow_details.issuing_authorization.card.cvcnullable stringExpandable

        The card’s CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint.

      • flow_details.issuing_authorization.card.exp_monthinteger

        The expiration month of the card.

      • flow_details.issuing_authorization.card.exp_yearinteger

        The expiration year of the card.

      • flow_details.issuing_authorization.card.last4string

        The last 4 digits of the card number.

      • flow_details.issuing_authorization.card.livemodeboolean

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

      • flow_details.issuing_authorization.card.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.

      • flow_details.issuing_authorization.card.numbernullable stringExpandable

        The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint.

      • flow_details.issuing_authorization.card.personalization_designnullable stringExpandable

        The personalization design object belonging to this card.

      • flow_details.issuing_authorization.card.replaced_bynullable stringExpandable

        The latest card that replaces this card, if any.

      • flow_details.issuing_authorization.card.replacement_fornullable stringExpandable

        The card this card replaces, if any.

      • flow_details.issuing_authorization.card.replacement_reasonnullable enum

        The reason why the previous card needed to be replaced.

        Possible enum values

        damaged The physical card has been damaged and cannot be used at terminals. This reason is only valid for cards of type physical.

        expired The expiration date has passed or is imminent.

        lost The card was lost. This status is only valid if the card it replaces is marked as lost.

        stolen The card was stolen. This status is only valid if the card it replaces is marked as stolen.

      • flow_details.issuing_authorization.card.shippingnullable object

        Where and how the card will be shipped.

        Hide child attributes

        • flow_details.issuing_authorization.card.shipping.addressobject

          Shipping address.

          Hide child attributes

          • flow_details.issuing_authorization.card.shipping.address.citynullable string

            City, district, suburb, town, or village.

          • flow_details.issuing_authorization.card.shipping.address.countrynullable string

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

          • flow_details.issuing_authorization.card.shipping.address.line1nullable string

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

          • flow_details.issuing_authorization.card.shipping.address.line2nullable string

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

          • flow_details.issuing_authorization.card.shipping.address.postal_codenullable string

            ZIP or postal code.

          • flow_details.issuing_authorization.card.shipping.address.statenullable string

            State, county, province, or region.

        • flow_details.issuing_authorization.card.shipping.address_validationnullable object

          Address validation details for the shipment.

          Hide child attributes

          • flow_details.issuing_authorization.card.shipping.address_validation.modeenum

            The address validation capabilities to use.

            Possible enum values

            disabled The card will be shipped without validating or normalizing the shipping address.

            normalization_only The card will be shipped with the normalized address without validation. Undeliverable addresses won’t be blocked.

            validation_and_normalization The card will be shipped with the normalized, validated address. Undeliverable addresses will be blocked.

          • flow_details.issuing_authorization.card.shipping.address_validation.normalized_addressnullable object

            The normalized shipping address.

            Hide child attributes

            • flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.citynullable string

              City, district, suburb, town, or village.

            • flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.countrynullable string

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

            • flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.line1nullable string

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

            • flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.line2nullable string

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

            • flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.postal_codenullable string

              ZIP or postal code.

            • flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.statenullable string

              State, county, province, or region.

          • flow_details.issuing_authorization.card.shipping.address_validation.resultnullable enum

            The validation result for the shipping address.

            Possible enum values

            indeterminate The deliverability of the card’s shipping address could not be determined.

            likely_deliverable The card’s shipping address is likely deliverable.

            likely_undeliverable The card’s shipping address is likely undeliverable as submitted.

        • flow_details.issuing_authorization.card.shipping.carriernullable enum

          The delivery company that shipped a card.

          Possible enum values

          dhl DHL

          fedex FedEx

          royal_mail Royal Mail

          usps USPS

        • flow_details.issuing_authorization.card.shipping.customsnullable object

          Additional information that may be required for clearing customs.

          Hide child attributes

          • flow_details.issuing_authorization.card.shipping.customs.eori_numbernullable string

            A registration number used for customs in Europe. See https://www.gov.uk/eori for the UK and https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en for the EU.

        • flow_details.issuing_authorization.card.shipping.etanullable timestamp

          A unix timestamp representing a best estimate of when the card will be delivered.

        • flow_details.issuing_authorization.card.shipping.namestring

          Recipient name.

        • flow_details.issuing_authorization.card.shipping.phone_numbernullable string

          The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.

        • flow_details.issuing_authorization.card.shipping.require_signaturenullable boolean

          Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.

        • flow_details.issuing_authorization.card.shipping.serviceenum

          Shipment service, such as standard or express.

          Possible enum values

          express Cards arrive in 4 business days.

          priority Cards arrive in 2-3 business days.

          standard Cards arrive in 5-8 business days.

        • flow_details.issuing_authorization.card.shipping.statusnullable enum

          The delivery status of the card.

          Possible enum values

          canceled The card was canceled before being shipped.

          delivered The card has been delivered to its destination.

          failure The card failed to be delivered but was not returned.

          pending The card is being prepared and has not yet shipped.

          returned The card failed to be delivered and was returned to the sender.

          shipped The card has been shipped. If the card’s shipping carrier does not support tracking, this will be the card’s final status.

          submitted The card has been submitted to the printer for shipment.

        • flow_details.issuing_authorization.card.shipping.tracking_numbernullable string

          A tracking number for a card shipment.

        • flow_details.issuing_authorization.card.shipping.tracking_urlnullable string

          A link to the shipping carrier’s site where you can view detailed information about a card shipment.

        • flow_details.issuing_authorization.card.shipping.typeenum

          Packaging options.

          Possible enum values

          bulk Cards are grouped and mailed together.

          individual Cards are sent individually in an envelope.

      • flow_details.issuing_authorization.card.spending_controlsobject

        Rules that control spending for this card. Refer to our documentation for more details.

        Hide child attributes

        • flow_details.issuing_authorization.card.spending_controls.allowed_categoriesnullable array of enums

          Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories.

          Possible enum values

          ac_refrigeration_repair

          accounting_bookkeeping_services

          advertising_services

          agricultural_cooperative

          airlines_air_carriers

          airports_flying_fields

          ambulance_services

          amusement_parks_carnivals

          antique_reproductions

          antique_shops

          Show 285 more

        • flow_details.issuing_authorization.card.spending_controls.allowed_merchant_countriesnullable array of strings

          Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.

        • flow_details.issuing_authorization.card.spending_controls.blocked_categoriesnullable array of enums

          Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories.

          Possible enum values

          ac_refrigeration_repair

          accounting_bookkeeping_services

          advertising_services

          agricultural_cooperative

          airlines_air_carriers

          airports_flying_fields

          ambulance_services

          amusement_parks_carnivals

          antique_reproductions

          antique_shops

          Show 285 more

        • flow_details.issuing_authorization.card.spending_controls.blocked_merchant_countriesnullable array of strings

          Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.

        • flow_details.issuing_authorization.card.spending_controls.spending_limitsnullable array of objects

          Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its replacement_for card and that card’s replacement_for card, up the chain).

          Hide child attributes

          • flow_details.issuing_authorization.card.spending_controls.spending_limits.amountinteger

            Maximum amount allowed to spend per interval. This amount is in the card’s currency and in the smallest currency unit.

          • flow_details.issuing_authorization.card.spending_controls.spending_limits.categoriesnullable array of enums

            Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.

            Possible enum values

            ac_refrigeration_repair

            accounting_bookkeeping_services

            advertising_services

            agricultural_cooperative

            airlines_air_carriers

            airports_flying_fields

            ambulance_services

            amusement_parks_carnivals

            antique_reproductions

            antique_shops

            Show 285 more

          • flow_details.issuing_authorization.card.spending_controls.spending_limits.intervalenum

            Interval (or event) to which the amount applies.

            Possible enum values

            all_time Limit applies to all transactions.

            daily Limit applies to a day, starting at midnight UTC.

            monthly Limit applies to a month, starting on the 1st at midnight UTC.

            per_authorization Limit applies to each authorization.

            weekly Limit applies to a week, starting on Sunday at midnight UTC.

            yearly Limit applies to a year, starting on January 1st at midnight UTC.

        • flow_details.issuing_authorization.card.spending_controls.spending_limits_currencynullable enum

          Currency of the amounts within spending_limits. Always the same as the currency of the card.

      • flow_details.issuing_authorization.card.statusenum

        Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive.

        Possible enum values

        active The card can approve authorizations. If the card is linked to a cardholder with past-due requirements, you may be unable to change the card’s status to ‘active’.

        canceled The card will decline authorizations with the card_canceled reason. This status is permanent.

        inactive The card will decline authorizations with the card_inactive reason.

      • flow_details.issuing_authorization.card.typeenum

        The type of the card.

        Possible enum values

        physical A physical card will be printed and shipped. It can be used at physical terminals.

        virtual No physical card will be printed. The card can be used online and can be added to digital wallets.

      • flow_details.issuing_authorization.card.walletsnullable object

        Information relating to digital wallets (like Apple Pay and Google Pay).

        Hide child attributes

        • flow_details.issuing_authorization.card.wallets.apple_payobject

          Apple Pay Details

          Hide child attributes

          • flow_details.issuing_authorization.card.wallets.apple_pay.eligibleboolean

            Apple Pay Eligibility

          • flow_details.issuing_authorization.card.wallets.apple_pay.ineligible_reasonnullable enum

            Reason the card is ineligible for Apple Pay

            Possible enum values

            missing_agreement Apple Pay is not enabled for your account.

            missing_cardholder_contact Cardholder phone number or email required.

            unsupported_region Apple Pay is not supported in the cardholder’s country.

        • flow_details.issuing_authorization.card.wallets.google_payobject

          Google Pay Details

          Hide child attributes

          • flow_details.issuing_authorization.card.wallets.google_pay.eligibleboolean

            Google Pay Eligibility

          • flow_details.issuing_authorization.card.wallets.google_pay.ineligible_reasonnullable enum

            Reason the card is ineligible for Google Pay

            Possible enum values

            missing_agreement Google Pay is not enabled for your account.

            missing_cardholder_contact Cardholder phone number or email required.

            unsupported_region Google Pay is not supported in the cardholder’s country.

        • flow_details.issuing_authorization.card.wallets.primary_account_identifiernullable string

          Unique identifier for a card used with digital wallets

    • flow_details.issuing_authorization.cardholdernullable stringExpandable

      The cardholder to whom this authorization belongs.

    • flow_details.issuing_authorization.createdtimestamp

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

    • flow_details.issuing_authorization.currencyenum

      The currency of the cardholder. This currency can be different from the currency presented at authorization and the merchant_currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • flow_details.issuing_authorization.fleetnullable object

      Fleet-specific information for authorizations using Fleet cards.

      Hide child attributes

      • flow_details.issuing_authorization.fleet.cardholder_prompt_datanullable object

        Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.

        Hide child attributes

        • flow_details.issuing_authorization.fleet.cardholder_prompt_data.alphanumeric_idnullable string

          [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.

        • flow_details.issuing_authorization.fleet.cardholder_prompt_data.driver_idnullable string

          Driver ID.

        • flow_details.issuing_authorization.fleet.cardholder_prompt_data.odometernullable integer

          Odometer reading.

        • flow_details.issuing_authorization.fleet.cardholder_prompt_data.unspecified_idnullable string

          An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.

        • flow_details.issuing_authorization.fleet.cardholder_prompt_data.user_idnullable string

          User ID.

        • flow_details.issuing_authorization.fleet.cardholder_prompt_data.vehicle_numbernullable string

          Vehicle number.

      • flow_details.issuing_authorization.fleet.purchase_typenullable enum

        The type of purchase.

        Possible enum values

        fuel_and_non_fuel_purchase Fuel and non-fuel purchase.

        fuel_purchase Fuel-only purchase.

        non_fuel_purchase Non-fuel purchase.

      • flow_details.issuing_authorization.fleet.reported_breakdownnullable object

        More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.

        Hide child attributes

        • flow_details.issuing_authorization.fleet.reported_breakdown.fuelnullable object

          Breakdown of fuel portion of the purchase.

          Hide child attributes

          • flow_details.issuing_authorization.fleet.reported_breakdown.fuel.gross_amount_decimalnullable decimal string

            Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.

        • flow_details.issuing_authorization.fleet.reported_breakdown.non_fuelnullable object

          Breakdown of non-fuel portion of the purchase.

          Hide child attributes

          • flow_details.issuing_authorization.fleet.reported_breakdown.non_fuel.gross_amount_decimalnullable decimal string

            Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.

        • flow_details.issuing_authorization.fleet.reported_breakdown.taxnullable object

          Information about tax included in this transaction.

          Hide child attributes

          • flow_details.issuing_authorization.fleet.reported_breakdown.tax.local_amount_decimalnullable decimal string

            Amount of state or provincial Sales Tax included in the transaction amount. null if not reported by merchant or not subject to tax.

          • flow_details.issuing_authorization.fleet.reported_breakdown.tax.national_amount_decimalnullable decimal string

            Amount of national Sales Tax or VAT included in the transaction amount. null if not reported by merchant or not subject to tax.

      • flow_details.issuing_authorization.fleet.service_typenullable enum

        The type of fuel service.

        Possible enum values

        full_service Full-service fuel station purchase.

        non_fuel_transaction Non-fuel transaction.

        self_service Self-service fuel station purchase.

    • flow_details.issuing_authorization.fraud_challengesnullable array of objectsExpandable

      Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.

      Hide child attributes

      • flow_details.issuing_authorization.fraud_challenges.channelenum

        The method by which the fraud challenge was delivered to the cardholder.

        Possible enum values

        sms SMS sent to the cardholder’s phone number.

      • flow_details.issuing_authorization.fraud_challenges.statusenum

        The status of the fraud challenge.

        Possible enum values

        expired The cardholder did not respond to the challenge within 12 hours of it being sent, and it has expired. Any further response to the challenge will be ignored.

        pending The challenge has been sent to the cardholder or is about to be sent.

        rejected The cardholder responded to the challenge indicating that the authorization was fraudulent, and that similar authorizations should continue to be declined.

        undeliverable A challenge has been requested to be sent, but the cardholder is unable to receive it.

        verified The cardholder responded to the challenge indicating that the authorization was not fraudulent, and that similar authorizations should be approved.

      • flow_details.issuing_authorization.fraud_challenges.undeliverable_reasonnullable enum

        If the challenge is not deliverable, the reason why.

        Possible enum values

        no_phone_number SMS fraud challenges cannot be delivered to this cardholder because they have no phone_number.

        unsupported_phone_number SMS fraud challenges cannot be delivered to this cardholder because their phone_number is not supported

    • flow_details.issuing_authorization.fuelnullable object

      Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.

      Hide child attributes

      • flow_details.issuing_authorization.fuel.industry_product_codenullable string

        Conexxus Payment System Product Code identifying the primary fuel product purchased.

      • flow_details.issuing_authorization.fuel.quantity_decimalnullable decimal string

        The quantity of units of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.

      • flow_details.issuing_authorization.fuel.typenullable enum

        The type of fuel that was purchased.

        Possible enum values

        diesel Diesel.

        other Other.

        unleaded_plus Unleaded plus.

        unleaded_regular Unleaded regular.

        unleaded_super Unleaded super.

      • flow_details.issuing_authorization.fuel.unitnullable enum

        The units for quantity_decimal.

        Possible enum values

        charging_minute Charging minute.

        imperial_gallon Imperial gallon.

        kilogram Kilogram.

        kilowatt_hour Kilowatt-hour.

        liter Liter.

        other Other.

        pound Pound.

        us_gallon US gallon.

      • flow_details.issuing_authorization.fuel.unit_cost_decimalnullable decimal string

        The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.

    • flow_details.issuing_authorization.livemodeboolean

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

    • flow_details.issuing_authorization.merchant_amountinteger

      The total amount that was authorized or rejected. This amount is in the merchant_currency and in the smallest currency unit. merchant_amount should be the same as amount, unless merchant_currency and currency are different.

    • flow_details.issuing_authorization.merchant_currencyenum

      The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • flow_details.issuing_authorization.merchant_dataobject

      Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.

      Hide child attributes

      • flow_details.issuing_authorization.merchant_data.categorystring

        A categorization of the seller’s type of business. See our merchant categories guide for a list of possible values.

      • flow_details.issuing_authorization.merchant_data.category_codestring

        The merchant category code for the seller’s business

      • flow_details.issuing_authorization.merchant_data.citynullable string

        City where the seller is located

      • flow_details.issuing_authorization.merchant_data.countrynullable string

        Country where the seller is located

      • flow_details.issuing_authorization.merchant_data.namenullable string

        Name of the seller

      • flow_details.issuing_authorization.merchant_data.network_idstring

        Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.

      • flow_details.issuing_authorization.merchant_data.postal_codenullable string

        Postal code where the seller is located

      • flow_details.issuing_authorization.merchant_data.statenullable string

        State where the seller is located

      • flow_details.issuing_authorization.merchant_data.tax_idnullable string

        The seller’s tax identification number. Currently populated for French merchants only.

      • flow_details.issuing_authorization.merchant_data.terminal_idnullable string

        An ID assigned by the seller to the location of the sale.

      • flow_details.issuing_authorization.merchant_data.urlnullable string

        URL provided by the merchant on a 3DS request

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

    • flow_details.issuing_authorization.network_datanullable object

      Details about the authorization, such as identifiers, set by the card network.

      Hide child attributes

      • flow_details.issuing_authorization.network_data.acquiring_institution_idnullable string

        Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be null.

      • flow_details.issuing_authorization.network_data.system_trace_audit_numbernullable string

        The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer network_data.transaction_id if present, unless you have special requirements.

      • flow_details.issuing_authorization.network_data.transaction_idnullable string

        Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.

    • flow_details.issuing_authorization.pending_requestnullable object

      The pending authorization request. This field will only be non-null during an issuing_authorization.request webhook.

      Hide child attributes

      • flow_details.issuing_authorization.pending_request.amountinteger

        The additional amount Stripe will hold if the authorization is approved, in the card’s currency and in the smallest currency unit.

      • flow_details.issuing_authorization.pending_request.amount_detailsnullable object

        Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.

        Hide child attributes

        • flow_details.issuing_authorization.pending_request.amount_details.atm_feenullable integer

          The fee charged by the ATM for the cash withdrawal.

        • flow_details.issuing_authorization.pending_request.amount_details.cashback_amountnullable integer

          The amount of cash requested by the cardholder.

      • flow_details.issuing_authorization.pending_request.currencyenum

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

      • flow_details.issuing_authorization.pending_request.is_amount_controllableboolean

        If set true, you may provide amount to control how much to hold for the authorization.

      • flow_details.issuing_authorization.pending_request.merchant_amountinteger

        The amount the merchant is requesting to be authorized in the merchant_currency. The amount is in the smallest currency unit.

      • flow_details.issuing_authorization.pending_request.merchant_currencyenum

        The local currency the merchant is requesting to authorize.

      • flow_details.issuing_authorization.pending_request.network_risk_scorenullable integer

        The card network’s estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.

    • flow_details.issuing_authorization.request_historyarray of objects

      History of every time a pending_request authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.

      Hide child attributes

      • flow_details.issuing_authorization.request_history.amountinteger

        The pending_request.amount at the time of the request, presented in your card’s currency and in the smallest currency unit. Stripe held this amount from your account to fund the authorization if the request was approved.

      • flow_details.issuing_authorization.request_history.amount_detailsnullable object

        Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.

        Hide child attributes

        • flow_details.issuing_authorization.request_history.amount_details.atm_feenullable integer

          The fee charged by the ATM for the cash withdrawal.

        • flow_details.issuing_authorization.request_history.amount_details.cashback_amountnullable integer

          The amount of cash requested by the cardholder.

      • flow_details.issuing_authorization.request_history.approvedboolean

        Whether this request was approved.

      • flow_details.issuing_authorization.request_history.authorization_codenullable string

        A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter “S”, followed by a six-digit number. For example, “S498162”. Please note that the code is not guaranteed to be unique across authorizations.

      • flow_details.issuing_authorization.request_history.createdtimestamp

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

      • flow_details.issuing_authorization.request_history.currencystring

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

      • flow_details.issuing_authorization.request_history.merchant_amountinteger

        The pending_request.merchant_amount at the time of the request, presented in the merchant_currency and in the smallest currency unit.

      • flow_details.issuing_authorization.request_history.merchant_currencystring

        The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.

      • flow_details.issuing_authorization.request_history.network_risk_scorenullable integer

        The card network’s estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.

      • flow_details.issuing_authorization.request_history.reasonenum

        When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.

        Possible enum values

        account_disabled The authorization request was declined because your account is disabled. For more information, please contact us at support-issuing@stripe.com. Replaces the deprecated account_inactive and account_compliance_disabled enums.

        card_active The authorization was approved according to your Issuing default settings. Authorization outcome was not driven by real-time auth webhook or spending controls as neither were configured.

        card_canceled The authorization request was declined because the card was canceled.

        card_expired The authorization request was declined because the card has expired. Documentation for replacing an expired card can be found here.

        card_inactive The authorization request was declined because the card was inactive. To activate the card, refer to our documentation.

        cardholder_blocked The authorization request was declined because the cardholder is blocked.

        cardholder_inactive The authorization request was declined because the cardholder was inactive. You can activate the cardholder in the dashboard or via the API update endpoint.

        cardholder_verification_required The authorization was not approved because the cardholder still required verification. More details can be found by querying the API and obtaining the requirements field of the Cardholder object.

        insecure_authorization_method The authorization request was declined because an insecure authorization method was used. The authorization may be retried by inserting the chip into the terminal and/or entering the PIN at the point of sale.

        insufficient_funds The authorization request was declined because your account had insufficient funds. Documentation for topping up your Issuing Balance can be found here.

        Show 10 more

      • flow_details.issuing_authorization.request_history.reason_messagenullable string

        If the request_history.reason is webhook_error because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.

      • flow_details.issuing_authorization.request_history.requested_atnullable timestamp

        Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.

    • flow_details.issuing_authorization.statusenum

      The current status of the authorization in its lifecycle.

      Possible enum values

      closed The authorization was declined or captured through one or more transactions.

      expired The authorization was expired without capture.

      pending The authorization was created and is awaiting approval or was approved and is awaiting capture.

      reversed The authorization was reversed by the merchant.

    • flow_details.issuing_authorization.tokennullable stringPreview featureExpandable

      Token object used for this authorization. If a network token was not used for this authorization, this field will be null.

    • flow_details.issuing_authorization.transactionsarray of objects

      List of transactions associated with this authorization.

      Hide child attributes

      • flow_details.issuing_authorization.transactions.idstring

        Unique identifier for the object.

      • flow_details.issuing_authorization.transactions.objectstring

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

      • flow_details.issuing_authorization.transactions.amountinteger

        The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit.

      • flow_details.issuing_authorization.transactions.amount_detailsnullable object

        Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.

        Hide child attributes

        • flow_details.issuing_authorization.transactions.amount_details.atm_feenullable integer

          The fee charged by the ATM for the cash withdrawal.

        • flow_details.issuing_authorization.transactions.amount_details.cashback_amountnullable integer

          The amount of cash requested by the cardholder.

      • flow_details.issuing_authorization.transactions.authorizationnullable stringExpandable

        The Authorization object that led to this transaction.

      • flow_details.issuing_authorization.transactions.balance_transactionnullable stringExpandable

        ID of the balance transaction associated with this transaction.

      • flow_details.issuing_authorization.transactions.cardstringExpandable

        The card used to make this transaction.

      • flow_details.issuing_authorization.transactions.cardholdernullable stringExpandable

        The cardholder to whom this transaction belongs.

      • flow_details.issuing_authorization.transactions.createdtimestamp

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

      • flow_details.issuing_authorization.transactions.currencyenum

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

      • flow_details.issuing_authorization.transactions.disputenullable stringExpandable

        If you’ve disputed the transaction, the ID of the dispute.

      • flow_details.issuing_authorization.transactions.livemodeboolean

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

      • flow_details.issuing_authorization.transactions.merchant_amountinteger

        The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency.

      • flow_details.issuing_authorization.transactions.merchant_currencyenum

        The currency with which the merchant is taking payment.

      • flow_details.issuing_authorization.transactions.merchant_dataobject

        Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction.

        Hide child attributes

        • flow_details.issuing_authorization.transactions.merchant_data.categorystring

          A categorization of the seller’s type of business. See our merchant categories guide for a list of possible values.

        • flow_details.issuing_authorization.transactions.merchant_data.category_codestring

          The merchant category code for the seller’s business

        • flow_details.issuing_authorization.transactions.merchant_data.citynullable string

          City where the seller is located

        • flow_details.issuing_authorization.transactions.merchant_data.countrynullable string

          Country where the seller is located

        • flow_details.issuing_authorization.transactions.merchant_data.namenullable string

          Name of the seller

        • flow_details.issuing_authorization.transactions.merchant_data.network_idstring

          Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.

        • flow_details.issuing_authorization.transactions.merchant_data.postal_codenullable string

          Postal code where the seller is located

        • flow_details.issuing_authorization.transactions.merchant_data.statenullable string

          State where the seller is located

        • flow_details.issuing_authorization.transactions.merchant_data.tax_idnullable string

          The seller’s tax identification number. Currently populated for French merchants only.

        • flow_details.issuing_authorization.transactions.merchant_data.terminal_idnullable string

          An ID assigned by the seller to the location of the sale.

        • flow_details.issuing_authorization.transactions.merchant_data.urlnullable string

          URL provided by the merchant on a 3DS request

      • flow_details.issuing_authorization.transactions.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.

      • flow_details.issuing_authorization.transactions.network_datanullable object

        Details about the transaction, such as processing dates, set by the card network.

        Hide child attributes

        • flow_details.issuing_authorization.transactions.network_data.authorization_codenullable string

          A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter “S”, followed by a six-digit number. For example, “S498162”. Please note that the code is not guaranteed to be unique across authorizations.

        • flow_details.issuing_authorization.transactions.network_data.processing_datenullable string

          The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.

        • flow_details.issuing_authorization.transactions.network_data.transaction_idnullable string

          Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.

      • flow_details.issuing_authorization.transactions.purchase_detailsnullable objectExpandable

        Additional purchase information that is optionally provided by the merchant.

        Hide child attributes

        • flow_details.issuing_authorization.transactions.purchase_details.fleetnullable object

          Fleet-specific information for transactions using Fleet cards.

          Hide child attributes

          • flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_datanullable object

            Answers to prompts presented to cardholder at point of sale.

            Hide child attributes

            • flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.driver_idnullable string

              Driver ID.

            • flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.odometernullable integer

              Odometer reading.

            • flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.unspecified_idnullable string

              An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.

            • flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.user_idnullable string

              User ID.

            • flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.vehicle_numbernullable string

              Vehicle number.

          • flow_details.issuing_authorization.transactions.purchase_details.fleet.purchase_typenullable string

            The type of purchase. One of fuel_purchase, non_fuel_purchase, or fuel_and_non_fuel_purchase.

          • flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdownnullable object

            More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.

            Hide child attributes

            • flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.fuelnullable object

              Breakdown of fuel portion of the purchase.

              Hide child attributes

              • flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimalnullable decimal string

                Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.

            • flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.non_fuelnullable object

              Breakdown of non-fuel portion of the purchase.

              Hide child attributes

              • flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimalnullable decimal string

                Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.

            • flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.taxnullable object

              Information about tax included in this transaction.

              Hide child attributes

              • flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.tax.local_amount_decimalnullable decimal string

                Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.

              • flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.tax.national_amount_decimalnullable decimal string

                Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.

          • flow_details.issuing_authorization.transactions.purchase_details.fleet.service_typenullable string

            The type of fuel service. One of non_fuel_transaction, full_service, or self_service.

        • flow_details.issuing_authorization.transactions.purchase_details.flightnullable object

          Information about the flight that was purchased with this transaction.

          Hide child attributes

          • flow_details.issuing_authorization.transactions.purchase_details.flight.departure_atnullable integer

            The time that the flight departed.

          • flow_details.issuing_authorization.transactions.purchase_details.flight.passenger_namenullable string

            The name of the passenger.

          • flow_details.issuing_authorization.transactions.purchase_details.flight.refundablenullable boolean

            Whether the ticket is refundable.

          • flow_details.issuing_authorization.transactions.purchase_details.flight.segmentsnullable array of objects

            The legs of the trip.

            Hide child attributes

            • flow_details.issuing_authorization.transactions.purchase_details.flight.segments.arrival_airport_codenullable string

              The three-letter IATA airport code of the flight’s destination.

            • flow_details.issuing_authorization.transactions.purchase_details.flight.segments.carriernullable string

              The airline carrier code.

            • flow_details.issuing_authorization.transactions.purchase_details.flight.segments.departure_airport_codenullable string

              The three-letter IATA airport code that the flight departed from.

            • flow_details.issuing_authorization.transactions.purchase_details.flight.segments.flight_numbernullable string

              The flight number.

            • flow_details.issuing_authorization.transactions.purchase_details.flight.segments.service_classnullable string

              The flight’s service class.

            • flow_details.issuing_authorization.transactions.purchase_details.flight.segments.stopover_allowednullable boolean

              Whether a stopover is allowed on this flight.

          • flow_details.issuing_authorization.transactions.purchase_details.flight.travel_agencynullable string

            The travel agency that issued the ticket.

        • flow_details.issuing_authorization.transactions.purchase_details.fuelnullable object

          Information about fuel that was purchased with this transaction.

          Hide child attributes

          • flow_details.issuing_authorization.transactions.purchase_details.fuel.industry_product_codenullable string

            Conexxus Payment System Product Code identifying the primary fuel product purchased.

          • flow_details.issuing_authorization.transactions.purchase_details.fuel.quantity_decimalnullable decimal string

            The quantity of units of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.

          • flow_details.issuing_authorization.transactions.purchase_details.fuel.typestring

            The type of fuel that was purchased. One of diesel, unleaded_plus, unleaded_regular, unleaded_super, or other.

          • flow_details.issuing_authorization.transactions.purchase_details.fuel.unitstring

            The units for quantity_decimal. One of charging_minute, imperial_gallon, kilogram, kilowatt_hour, liter, pound, us_gallon, or other.

          • flow_details.issuing_authorization.transactions.purchase_details.fuel.unit_cost_decimaldecimal string

            The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.

        • flow_details.issuing_authorization.transactions.purchase_details.lodgingnullable object

          Information about lodging that was purchased with this transaction.

          Hide child attributes

          • flow_details.issuing_authorization.transactions.purchase_details.lodging.check_in_atnullable integer

            The time of checking into the lodging.

          • flow_details.issuing_authorization.transactions.purchase_details.lodging.nightsnullable integer

            The number of nights stayed at the lodging.

        • flow_details.issuing_authorization.transactions.purchase_details.receiptnullable array of objects

          The line items in the purchase.

          Hide child attributes

          • flow_details.issuing_authorization.transactions.purchase_details.receipt.descriptionnullable string

            The description of the item. The maximum length of this field is 26 characters.

          • flow_details.issuing_authorization.transactions.purchase_details.receipt.quantitynullable float

            The quantity of the item.

          • flow_details.issuing_authorization.transactions.purchase_details.receipt.totalnullable integer

            The total for this line item in cents.

          • flow_details.issuing_authorization.transactions.purchase_details.receipt.unit_costnullable integer

            The unit cost of the item in cents.

        • flow_details.issuing_authorization.transactions.purchase_details.referencenullable string

          A merchant-specific order number.

      • flow_details.issuing_authorization.transactions.tokennullable stringPreview featureExpandable

        Token object used for this transaction. If a network token was not used for this transaction, this field will be null.

      • flow_details.issuing_authorization.transactions.typeenum

        The nature of the transaction.

        Possible enum values

        capture Funds were captured by the acquirer. amount will be negative because funds are moving out of your balance. Not all captures will be linked to an authorization, as acquirers can force capture in some cases.

        refund An acquirer initiated a refund. This transaction might not be linked to an original capture, for example credits are original transactions. amount will be positive for refunds and negative for refund reversals (very rare).

      • flow_details.issuing_authorization.transactions.walletnullable enum

        The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay.

    • flow_details.issuing_authorization.verification_dataobject

      Verifications that Stripe performed on information that the cardholder provided to the merchant.

      Hide child attributes

      • flow_details.issuing_authorization.verification_data.address_line1_checkenum

        Whether the cardholder provided an address first line and if it matched the cardholder’s billing.address.line1.

        Possible enum values

        match Verification succeeded, values matched.

        mismatch Verification failed, values didn’t match.

        not_provided Verification was not performed because no value was provided.

      • flow_details.issuing_authorization.verification_data.address_postal_code_checkenum

        Whether the cardholder provided a postal code and if it matched the cardholder’s billing.address.postal_code.

        Possible enum values

        match Verification succeeded, values matched.

        mismatch Verification failed, values didn’t match.

        not_provided Verification was not performed because no value was provided.

      • flow_details.issuing_authorization.verification_data.authentication_exemptionnullable object

        The exemption applied to this authorization.

        Hide child attributes

        • flow_details.issuing_authorization.verification_data.authentication_exemption.claimed_byenum

          The entity that requested the exemption, either the acquiring merchant or the Issuing user.

          Possible enum values

          acquirer Acquiring merchant.

          issuer Issuing user.

        • flow_details.issuing_authorization.verification_data.authentication_exemption.typeenum

          The specific exemption claimed for this authorization.

          Possible enum values

          low_value_transaction Specifies an exemption for some low-value authorizations.

          transaction_risk_analysis Specifies an exemption for low-risk authorizations, determined using real-time risk analysis.

          unknown Specifies an unknown exemption type.

      • flow_details.issuing_authorization.verification_data.cvc_checkenum

        Whether the cardholder provided a CVC and if it matched Stripe’s record.

        Possible enum values

        match Verification succeeded, values matched.

        mismatch Verification failed, values didn’t match.

        not_provided Verification was not performed because no value was provided.

      • flow_details.issuing_authorization.verification_data.expiry_checkenum

        Whether the cardholder provided an expiry date and if it matched Stripe’s record.

        Possible enum values

        match Verification succeeded, values matched.

        mismatch Verification failed, values didn’t match.

        not_provided Verification was not performed because no value was provided.

      • flow_details.issuing_authorization.verification_data.postal_codenullable string

        The postal code submitted as part of the authorization used for postal code verification.

      • flow_details.issuing_authorization.verification_data.three_d_securenullable object

        3D Secure details.

        Hide child attributes

        • flow_details.issuing_authorization.verification_data.three_d_secure.resultenum

          The outcome of the 3D Secure authentication request.

          Possible enum values

          attempt_acknowledged The merchant attempted to authenticate the authorization, but the cardholder is not enrolled or was unable to reach Stripe.

          authenticated Authentication successful.

          failed Authentication failed.

          required The authorization was declined because regulatory requirements mandated an authentication for this transaction but it wasn’t submitted correctly by the merchant, and they didn’t claim an applicable exemption. Check out our 3DS documentation if you want to learn more.

    • flow_details.issuing_authorization.verified_by_fraud_challengenullable boolean

      Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.

    • flow_details.issuing_authorization.walletnullable string

      The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay. Will populate as null when no digital wallet was utilized.

  • flow_details.outbound_paymentnullable object

    The OutboundPayment object associated with the Transaction. Set if type=outbound_payment.

    Hide child attributes

    • flow_details.outbound_payment.idstring

      Unique identifier for the object.

    • flow_details.outbound_payment.objectstring

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

    • flow_details.outbound_payment.amountinteger

      Amount (in cents) transferred.

    • flow_details.outbound_payment.cancelableboolean

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

    • flow_details.outbound_payment.createdtimestamp

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

    • flow_details.outbound_payment.currencyenum

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

    • flow_details.outbound_payment.customernullable string

      ID of the customer to whom an OutboundPayment is sent.

    • flow_details.outbound_payment.descriptionnullable string

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

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

    • flow_details.outbound_payment.destination_payment_method_detailsnullable object

      Details about the PaymentMethod for an OutboundPayment.

      Hide child attributes

      • flow_details.outbound_payment.destination_payment_method_details.billing_detailsobject

        Contact details for the person or business receiving the OutboundPayment.

        Hide child attributes

        • flow_details.outbound_payment.destination_payment_method_details.billing_details.addressobject

          Billing address.

          Hide child attributes

          • flow_details.outbound_payment.destination_payment_method_details.billing_details.address.citynullable string

            City, district, suburb, town, or village.

          • flow_details.outbound_payment.destination_payment_method_details.billing_details.address.countrynullable string

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

          • flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line1nullable string

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

          • flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line2nullable string

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

          • flow_details.outbound_payment.destination_payment_method_details.billing_details.address.postal_codenullable string

            ZIP or postal code.

          • flow_details.outbound_payment.destination_payment_method_details.billing_details.address.statenullable string

            State, county, province, or region.

        • flow_details.outbound_payment.destination_payment_method_details.billing_details.emailnullable string

          Email address.

        • flow_details.outbound_payment.destination_payment_method_details.billing_details.namenullable string

          Full name.

      • flow_details.outbound_payment.destination_payment_method_details.financial_accountnullable object

        Details about the financial_account.

        Hide child attributes

        • flow_details.outbound_payment.destination_payment_method_details.financial_account.idstring

          Token of the FinancialAccount.

        • flow_details.outbound_payment.destination_payment_method_details.financial_account.networkenum

          The rails used to send funds.

      • 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

      • flow_details.outbound_payment.destination_payment_method_details.us_bank_accountnullable object

        Details about the us_bank_account.

        Hide child attributes

        • 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

        • 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

        • flow_details.outbound_payment.destination_payment_method_details.us_bank_account.bank_namenullable string

          Name of the bank associated with the bank account.

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

        • flow_details.outbound_payment.destination_payment_method_details.us_bank_account.last4nullable string

          Last four digits of the bank account number.

        • flow_details.outbound_payment.destination_payment_method_details.us_bank_account.mandatenullable stringExpandable

          ID of the mandate used to make this payment.

        • 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

        • flow_details.outbound_payment.destination_payment_method_details.us_bank_account.routing_numbernullable string

          Routing number of the bank account.

    • flow_details.outbound_payment.end_user_detailsnullable object

      Details about the end user.

      Hide child attributes

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

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

    • flow_details.outbound_payment.expected_arrival_datetimestamp

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

    • flow_details.outbound_payment.financial_accountstring

      The FinancialAccount that funds were pulled from.

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

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

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

    • flow_details.outbound_payment.returned_detailsnullable object

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

      Hide child attributes

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

      • flow_details.outbound_payment.returned_details.transactionstringExpandable

        The Transaction associated with this object.

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

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

    • flow_details.outbound_payment.status_transitionsobject

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

      Hide child attributes

      • flow_details.outbound_payment.status_transitions.canceled_atnullable timestamp

        Timestamp describing when an OutboundPayment changed status to canceled.

      • flow_details.outbound_payment.status_transitions.failed_atnullable timestamp

        Timestamp describing when an OutboundPayment changed status to failed.

      • flow_details.outbound_payment.status_transitions.posted_atnullable timestamp

        Timestamp describing when an OutboundPayment changed status to posted.

      • flow_details.outbound_payment.status_transitions.returned_atnullable timestamp

        Timestamp describing when an OutboundPayment changed status to returned.

    • flow_details.outbound_payment.tracking_detailsnullable object

      Details about network-specific tracking information if available.

      Hide child attributes

      • flow_details.outbound_payment.tracking_details.achnullable object

        ACH network tracking details.

        Hide child attributes

        • flow_details.outbound_payment.tracking_details.ach.trace_idstring

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

      • flow_details.outbound_payment.tracking_details.typeenum

        The US bank account network used to send funds.

        Possible enum values

        ach

        us_domestic_wire

      • flow_details.outbound_payment.tracking_details.us_domestic_wirenullable object

        US domestic wire network tracking details.

        Hide child attributes

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

        • flow_details.outbound_payment.tracking_details.us_domestic_wire.imadnullable string

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

        • flow_details.outbound_payment.tracking_details.us_domestic_wire.omadnullable string

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

    • flow_details.outbound_payment.transactionstringExpandable

      The Transaction associated with this object.

  • flow_details.outbound_transfernullable object

    The OutboundTransfer object associated with the Transaction. Set if type=outbound_transfer.

    Hide child attributes

    • flow_details.outbound_transfer.idstring

      Unique identifier for the object.

    • flow_details.outbound_transfer.objectstring

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

    • flow_details.outbound_transfer.amountinteger

      Amount (in cents) transferred.

    • flow_details.outbound_transfer.cancelableboolean

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

    • flow_details.outbound_transfer.createdtimestamp

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

    • flow_details.outbound_transfer.currencyenum

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

    • flow_details.outbound_transfer.descriptionnullable string

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

    • flow_details.outbound_transfer.destination_payment_methodnullable string

      The PaymentMethod used as the payment instrument for an OutboundTransfer.

    • flow_details.outbound_transfer.destination_payment_method_detailsobject

      Details about the PaymentMethod for an OutboundTransfer

      Hide child attributes

      • flow_details.outbound_transfer.destination_payment_method_details.billing_detailsobject

        Contact details for the person or business receiving the OutboundTransfer.

        Hide child attributes

        • flow_details.outbound_transfer.destination_payment_method_details.billing_details.addressobject

          Billing address.

          Hide child attributes

          • flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.citynullable string

            City, district, suburb, town, or village.

          • flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.countrynullable string

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

          • flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line1nullable string

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

          • flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line2nullable string

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

          • flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.postal_codenullable string

            ZIP or postal code.

          • flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.statenullable string

            State, county, province, or region.

        • flow_details.outbound_transfer.destination_payment_method_details.billing_details.emailnullable string

          Email address.

        • flow_details.outbound_transfer.destination_payment_method_details.billing_details.namenullable string

          Full name.

      • flow_details.outbound_transfer.destination_payment_method_details.financial_accountnullable objectPreview feature

        Details about the financial_account.

        Hide child attributes

        • flow_details.outbound_transfer.destination_payment_method_details.financial_account.idstring

          Token of the FinancialAccount.

        • flow_details.outbound_transfer.destination_payment_method_details.financial_account.networkenum

          The rails used to send funds.

      • flow_details.outbound_transfer.destination_payment_method_details.typeenum

        The type of the payment method used in the OutboundTransfer.

      • flow_details.outbound_transfer.destination_payment_method_details.us_bank_accountnullable object

        Details about the us_bank_account.

        Hide child attributes

        • 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

        • 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

        • flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.bank_namenullable string

          Name of the bank associated with the bank account.

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

        • flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.last4nullable string

          Last four digits of the bank account number.

        • flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.mandatenullable stringExpandable

          ID of the mandate used to make this payment.

        • 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

        • flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.routing_numbernullable string

          Routing number of the bank account.

    • flow_details.outbound_transfer.expected_arrival_datetimestamp

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

    • flow_details.outbound_transfer.financial_accountstring

      The FinancialAccount that funds were pulled from.

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

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

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

    • flow_details.outbound_transfer.returned_detailsnullable object

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

      Hide child attributes

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

      • flow_details.outbound_transfer.returned_details.transactionstringExpandable

        The Transaction associated with this object.

    • flow_details.outbound_transfer.statement_descriptorstring

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

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

    • flow_details.outbound_transfer.status_transitionsobject

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

      Hide child attributes

      • flow_details.outbound_transfer.status_transitions.canceled_atnullable timestamp

        Timestamp describing when an OutboundTransfer changed status to canceled

      • flow_details.outbound_transfer.status_transitions.failed_atnullable timestamp

        Timestamp describing when an OutboundTransfer changed status to failed

      • flow_details.outbound_transfer.status_transitions.posted_atnullable timestamp

        Timestamp describing when an OutboundTransfer changed status to posted

      • flow_details.outbound_transfer.status_transitions.returned_atnullable timestamp

        Timestamp describing when an OutboundTransfer changed status to returned

    • flow_details.outbound_transfer.tracking_detailsnullable object

      Details about network-specific tracking information if available.

      Hide child attributes

      • flow_details.outbound_transfer.tracking_details.achnullable object

        ACH network tracking details.

        Hide child attributes

        • flow_details.outbound_transfer.tracking_details.ach.trace_idstring

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

      • flow_details.outbound_transfer.tracking_details.typeenum

        The US bank account network used to send funds.

        Possible enum values

        ach

        us_domestic_wire

      • flow_details.outbound_transfer.tracking_details.us_domestic_wirenullable object

        US domestic wire network tracking details.

        Hide child attributes

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

        • flow_details.outbound_transfer.tracking_details.us_domestic_wire.imadnullable string

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

        • flow_details.outbound_transfer.tracking_details.us_domestic_wire.omadnullable string

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

    • flow_details.outbound_transfer.transactionstringExpandable

      The Transaction associated with this object.

  • flow_details.received_creditnullable object

    The ReceivedCredit object associated with the Transaction. Set if type=received_credit.

    Hide child attributes

    • flow_details.received_credit.idstring

      Unique identifier for the object.

    • flow_details.received_credit.objectstring

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

    • flow_details.received_credit.amountinteger

      Amount (in cents) transferred.

    • flow_details.received_credit.createdtimestamp

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

    • flow_details.received_credit.currencyenum

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

    • flow_details.received_credit.descriptionstring

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

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

    • flow_details.received_credit.financial_accountnullable string

      The FinancialAccount that received the funds.

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

    • flow_details.received_credit.initiating_payment_method_detailsobject

      Details about the PaymentMethod used to send a ReceivedCredit.

      Hide child attributes

      • flow_details.received_credit.initiating_payment_method_details.balancenullable enum

        Set when type is balance.

        Possible enum values

        payments The Stripe payments balance.

      • flow_details.received_credit.initiating_payment_method_details.billing_detailsobject

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

        Hide child attributes

        • flow_details.received_credit.initiating_payment_method_details.billing_details.addressobject

          Billing address.

          Hide child attributes

          • flow_details.received_credit.initiating_payment_method_details.billing_details.address.citynullable string

            City, district, suburb, town, or village.

          • flow_details.received_credit.initiating_payment_method_details.billing_details.address.countrynullable string

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

          • flow_details.received_credit.initiating_payment_method_details.billing_details.address.line1nullable string

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

          • flow_details.received_credit.initiating_payment_method_details.billing_details.address.line2nullable string

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

          • flow_details.received_credit.initiating_payment_method_details.billing_details.address.postal_codenullable string

            ZIP or postal code.

          • flow_details.received_credit.initiating_payment_method_details.billing_details.address.statenullable string

            State, county, province, or region.

        • flow_details.received_credit.initiating_payment_method_details.billing_details.emailnullable string

          Email address.

        • flow_details.received_credit.initiating_payment_method_details.billing_details.namenullable string

          Full name.

      • flow_details.received_credit.initiating_payment_method_details.financial_accountnullable object

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

        Hide child attributes

        • flow_details.received_credit.initiating_payment_method_details.financial_account.idstring

          The FinancialAccount ID.

        • flow_details.received_credit.initiating_payment_method_details.financial_account.networkenum

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

      • flow_details.received_credit.initiating_payment_method_details.issuing_cardnullable string

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

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

      • flow_details.received_credit.initiating_payment_method_details.us_bank_accountnullable object

        Set when type is us_bank_account.

        Hide child attributes

        • flow_details.received_credit.initiating_payment_method_details.us_bank_account.bank_namenullable string

          Bank name.

        • flow_details.received_credit.initiating_payment_method_details.us_bank_account.last4nullable string

          The last four digits of the bank account number.

        • flow_details.received_credit.initiating_payment_method_details.us_bank_account.routing_numbernullable string

          The routing number for the bank account.

    • flow_details.received_credit.linked_flowsobject

      Other flows linked to a ReceivedCredit.

      Hide child attributes

      • flow_details.received_credit.linked_flows.credit_reversalnullable string

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

      • flow_details.received_credit.linked_flows.issuing_authorizationnullable string

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

      • flow_details.received_credit.linked_flows.issuing_transactionnullable string

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

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

      • flow_details.received_credit.linked_flows.source_flow_detailsnullable objectExpandable

        The expandable object of the source flow.

        Hide child attributes

        • flow_details.received_credit.linked_flows.source_flow_details.credit_reversalnullable object

          Details about a CreditReversal.

          Hide child attributes

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.idstring

            Unique identifier for the object.

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.objectstring

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

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.amountinteger

            Amount (in cents) transferred.

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.createdtimestamp

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

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.currencyenum

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

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.financial_accountstring

            The FinancialAccount to reverse funds from.

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

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.networkenum

            The rails used to reverse the funds.

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.received_creditstring

            The ReceivedCredit being reversed.

          • flow_details.received_credit.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).

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.status_transitionsobject

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

            Hide child attributes

            • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.status_transitions.posted_atnullable timestamp

              Timestamp describing when the CreditReversal changed status to posted

          • flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.transactionnullable stringExpandable

            The Transaction associated with this object.

        • flow_details.received_credit.linked_flows.source_flow_details.outbound_paymentnullable object

          Details about an OutboundPayment.

          Hide child attributes

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.idstring

            Unique identifier for the object.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.objectstring

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.amountinteger

            Amount (in cents) transferred.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.cancelableboolean

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.createdtimestamp

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.currencyenum

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.customernullable string

            ID of the customer to whom an OutboundPayment is sent.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.descriptionnullable string

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_detailsnullable object

            Details about the PaymentMethod for an OutboundPayment.

            Hide child attributes

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_detailsobject

              Contact details for the person or business receiving the OutboundPayment.

              Hide child attributes

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

                Billing address.

                Hide child attributes

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

                  City, district, suburb, town, or village.

                • flow_details.received_credit.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).

                • flow_details.received_credit.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).

                • flow_details.received_credit.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).

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

                  ZIP or postal code.

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

                  State, county, province, or region.

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

                Email address.

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

                Full name.

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_accountnullable object

              Details about the financial_account.

              Hide child attributes

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

                Token of the FinancialAccount.

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

                The rails used to send funds.

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

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_accountnullable object

              Details about the us_bank_account.

              Hide child attributes

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

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

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

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

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

                Last four digits of the bank account number.

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

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

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

                Routing number of the bank account.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.end_user_detailsnullable object

            Details about the end user.

            Hide child attributes

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.expected_arrival_datetimestamp

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.financial_accountstring

            The FinancialAccount that funds were pulled from.

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

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.returned_detailsnullable object

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

            Hide child attributes

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

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.returned_details.transactionstringExpandable

              The Transaction associated with this object.

          • flow_details.received_credit.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).

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitionsobject

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

            Hide child attributes

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.canceled_atnullable timestamp

              Timestamp describing when an OutboundPayment changed status to canceled.

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.failed_atnullable timestamp

              Timestamp describing when an OutboundPayment changed status to failed.

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.posted_atnullable timestamp

              Timestamp describing when an OutboundPayment changed status to posted.

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.returned_atnullable timestamp

              Timestamp describing when an OutboundPayment changed status to returned.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_detailsnullable object

            Details about network-specific tracking information if available.

            Hide child attributes

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.achnullable object

              ACH network tracking details.

              Hide child attributes

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

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

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wirenullable object

              US domestic wire network tracking details.

              Hide child attributes

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

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.transactionstringExpandable

            The Transaction associated with this object.

        • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfernullable objectPreview feature

          Details about an OutboundTransfer.

          Hide child attributes

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.idstring

            Unique identifier for the object.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.objectstring

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.amountinteger

            Amount (in cents) transferred.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.cancelableboolean

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.createdtimestamp

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.currencyenum

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.descriptionnullable string

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_methodnullable string

            The PaymentMethod used as the payment instrument for an OutboundTransfer.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_detailsobject

            Details about the PaymentMethod for an OutboundTransfer

            Hide child attributes

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_detailsobject

              Contact details for the person or business receiving the OutboundTransfer.

              Hide child attributes

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

                Billing address.

                Hide child attributes

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

                  City, district, suburb, town, or village.

                • flow_details.received_credit.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).

                • flow_details.received_credit.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).

                • flow_details.received_credit.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).

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

                  ZIP or postal code.

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

                  State, county, province, or region.

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

                Email address.

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

                Full name.

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

              Details about the financial_account.

              Hide child attributes

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

                Token of the FinancialAccount.

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

                The rails used to send funds.

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.typeenum

              The type of the payment method used in the OutboundTransfer.

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_accountnullable object

              Details about the us_bank_account.

              Hide child attributes

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

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

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

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

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

                Last four digits of the bank account number.

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

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

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

                Routing number of the bank account.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.expected_arrival_datetimestamp

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.financial_accountstring

            The FinancialAccount that funds were pulled from.

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

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.returned_detailsnullable object

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

            Hide child attributes

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

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.returned_details.transactionstringExpandable

              The Transaction associated with this object.

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.statement_descriptorstring

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitionsobject

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

            Hide child attributes

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.canceled_atnullable timestamp

              Timestamp describing when an OutboundTransfer changed status to canceled

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.failed_atnullable timestamp

              Timestamp describing when an OutboundTransfer changed status to failed

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.posted_atnullable timestamp

              Timestamp describing when an OutboundTransfer changed status to posted

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.returned_atnullable timestamp

              Timestamp describing when an OutboundTransfer changed status to returned

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_detailsnullable object

            Details about network-specific tracking information if available.

            Hide child attributes

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.achnullable object

              ACH network tracking details.

              Hide child attributes

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

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

            • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wirenullable object

              US domestic wire network tracking details.

              Hide child attributes

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

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.transactionstringExpandable

            The Transaction associated with this object.

        • flow_details.received_credit.linked_flows.source_flow_details.payoutnullable object

          Details about a Payout.

          Hide child attributes

          • flow_details.received_credit.linked_flows.source_flow_details.payout.idstring

            Unique identifier for the object.

          • flow_details.received_credit.linked_flows.source_flow_details.payout.objectstring

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.amountinteger

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.application_feenullable stringExpandableConnect only

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

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

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

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.createdtimestamp

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.currencyenum

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.descriptionnullable string

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.destinationnullable stringExpandable

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

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.failure_messagenullable string

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

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

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.original_payoutnullable stringExpandable

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.payout_methodnullable string

            ID of the v2 FinancialAccount the funds are sent to.

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.reversed_bynullable stringExpandable

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

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.statement_descriptornullable string

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

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

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

            Hide child attributes

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

            • flow_details.received_credit.linked_flows.source_flow_details.payout.trace_id.valuenullable string

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

          • flow_details.received_credit.linked_flows.source_flow_details.payout.typeenum

            Can be bank_account or card.

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

      • flow_details.received_credit.linked_flows.source_flow_typenullable string

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

    • flow_details.received_credit.livemodeboolean

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

    • flow_details.received_credit.networkenum

      The rails used to send the funds.

      Possible enum values

      ach

      card

      stripe

      us_domestic_wire

    • flow_details.received_credit.reversal_detailsnullable object

      Details describing when a ReceivedCredit may be reversed.

      Hide child attributes

      • flow_details.received_credit.reversal_details.deadlinenullable timestamp

        Time before which a ReceivedCredit can be reversed.

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

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

    • flow_details.received_credit.transactionnullable stringExpandable

      The Transaction associated with this object.

  • flow_details.received_debitnullable object

    The ReceivedDebit object associated with the Transaction. Set if type=received_debit.

    Hide child attributes

    • flow_details.received_debit.idstring

      Unique identifier for the object.

    • flow_details.received_debit.objectstring

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

    • flow_details.received_debit.amountinteger

      Amount (in cents) transferred.

    • flow_details.received_debit.createdtimestamp

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

    • flow_details.received_debit.currencyenum

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

    • flow_details.received_debit.descriptionstring

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

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

    • flow_details.received_debit.financial_accountnullable string

      The FinancialAccount that funds were pulled from.

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

    • flow_details.received_debit.initiating_payment_method_detailsobject

      Details about how a ReceivedDebit was created.

      Hide child attributes

      • flow_details.received_debit.initiating_payment_method_details.balancenullable enum

        Set when type is balance.

        Possible enum values

        payments The Stripe payments balance.

      • flow_details.received_debit.initiating_payment_method_details.billing_detailsobject

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

        Hide child attributes

        • flow_details.received_debit.initiating_payment_method_details.billing_details.addressobject

          Billing address.

          Hide child attributes

          • flow_details.received_debit.initiating_payment_method_details.billing_details.address.citynullable string

            City, district, suburb, town, or village.

          • flow_details.received_debit.initiating_payment_method_details.billing_details.address.countrynullable string

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

          • flow_details.received_debit.initiating_payment_method_details.billing_details.address.line1nullable string

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

          • flow_details.received_debit.initiating_payment_method_details.billing_details.address.line2nullable string

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

          • flow_details.received_debit.initiating_payment_method_details.billing_details.address.postal_codenullable string

            ZIP or postal code.

          • flow_details.received_debit.initiating_payment_method_details.billing_details.address.statenullable string

            State, county, province, or region.

        • flow_details.received_debit.initiating_payment_method_details.billing_details.emailnullable string

          Email address.

        • flow_details.received_debit.initiating_payment_method_details.billing_details.namenullable string

          Full name.

      • flow_details.received_debit.initiating_payment_method_details.financial_accountnullable object

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

        Hide child attributes

        • flow_details.received_debit.initiating_payment_method_details.financial_account.idstring

          The FinancialAccount ID.

        • flow_details.received_debit.initiating_payment_method_details.financial_account.networkenum

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

      • flow_details.received_debit.initiating_payment_method_details.issuing_cardnullable string

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

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

      • flow_details.received_debit.initiating_payment_method_details.us_bank_accountnullable object

        Set when type is us_bank_account.

        Hide child attributes

        • flow_details.received_debit.initiating_payment_method_details.us_bank_account.bank_namenullable string

          Bank name.

        • flow_details.received_debit.initiating_payment_method_details.us_bank_account.last4nullable string

          The last four digits of the bank account number.

        • flow_details.received_debit.initiating_payment_method_details.us_bank_account.routing_numbernullable string

          The routing number for the bank account.

    • flow_details.received_debit.linked_flowsobject

      Other flows linked to a ReceivedDebit.

      Hide child attributes

      • flow_details.received_debit.linked_flows.debit_reversalnullable string

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

      • flow_details.received_debit.linked_flows.inbound_transfernullable string

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

      • flow_details.received_debit.linked_flows.issuing_authorizationnullable string

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

      • flow_details.received_debit.linked_flows.issuing_transactionnullable string

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

      • flow_details.received_debit.linked_flows.payoutnullable string

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

    • flow_details.received_debit.livemodeboolean

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

    • flow_details.received_debit.networkenum

      The network used for the ReceivedDebit.

    • flow_details.received_debit.reversal_detailsnullable object

      Details describing when a ReceivedDebit might be reversed.

      Hide child attributes

      • flow_details.received_debit.reversal_details.deadlinenullable timestamp

        Time before which a ReceivedDebit can be reversed.

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

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

    • flow_details.received_debit.transactionnullable stringExpandable

      The Transaction associated with this object.

  • flow_details.typeenum

    Type of the flow that created the Transaction. Set to the same value as flow_type.

    Possible enum values

    credit_reversal The Transaction is associated with a CreditReversal.

    debit_reversal The Transaction is associated with a DebitReversal.

    inbound_transfer The Transaction is associated with an InboundTransfer.

    issuing_authorization The Transaction is associated with an Issuing authorization.

    other The Transaction is associated with some other money movement not listed above.

    outbound_payment The Transaction is associated with an OutboundPayment.

    outbound_transfer The Transaction is associated with an OutboundTransfer.

    received_credit The Transaction is associated with a ReceivedCredit.

    received_debit The Transaction is associated with a ReceivedDebit.

• flow_typeenum

  Type of the flow associated with the TransactionEntry.

  Possible enum values

  credit_reversal The Transaction is associated with a CreditReversal.

  debit_reversal The Transaction is associated with a DebitReversal.

  inbound_transfer The Transaction is associated with an InboundTransfer.

  issuing_authorization The Transaction is associated with an Issuing authorization.

  other The Transaction is associated with some other money movement not listed above.

  outbound_payment The Transaction is associated with an OutboundPayment.

  outbound_transfer The Transaction is associated with an OutboundTransfer.

  received_credit The Transaction is associated with a ReceivedCredit.

  received_debit The Transaction is associated with a ReceivedDebit.

• livemodeboolean

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

• transactionstringExpandable

  The Transaction associated with this object.

• typeenum

  The specific money movement that generated the TransactionEntry.

  Possible enum values

  credit_reversal The TransactionEntry was generated by a CreditReversal.

  credit_reversal_posting The TransactionEntry was generated by a posted CreditReversal.

  debit_reversal The TransactionEntry was generated by a DebitReversal.

  inbound_transfer The TransactionEntry was generated by an InboundTransfer.

  inbound_transfer_return The TransactionEntry was generated by an InboundTransferReturn.

  issuing_authorization_hold The TransactionEntry was generated by an Issuing authorization hold.

  issuing_authorization_release The TransactionEntry was generated by an Issuing authorization release.

  other The TransactionEntry was generated by some other money movement.

  outbound_payment The TransactionEntry was generated by an OutboundPayment.

  outbound_payment_cancellation The TransactionEntry was generated by a cancelled OutboundPayment.

  Show 10 more