The Transaction object
Attributes
id(string) Unique identifier for the object.object(string) String representing the object’s type. Objects of the same type share the same value.amount(integer) Amount (in cents) transferred.balance_impact(object) The change made to each of the FinancialAccount’s sub-balances by the Transaction.balance_impact.cash(integer) The change made to funds the user can spend right now.balance_impact.inbound_pending(integer) The change made to funds that are not spendable yet, but will become available at a later time.balance_impact.outbound_pending(integer) The change made to funds in the account, but not spendable because they are being held for pending outbound flows.
created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.description(string) An arbitrary string attached to the object. Often useful for displaying to users.entries(object, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.entries.object(string) String representing the object’s type. Objects of the same type share the same value. Always has the valuelist.entries.data(array of objects) Details about each object.entries.data.id(string) Unique identifier for the object.entries.data.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.balance_impact(object) The current impact of the TransactionEntry on the FinancialAccount’s balance.entries.data.balance_impact.cash(integer) The change made to funds the user can spend right now.entries.data.balance_impact.inbound_pending(integer) The change made to funds that are not spendable yet, but will become available at a later time.entries.data.balance_impact.outbound_pending(integer) The change made to funds in the account, but not spendable because they are being held for pending outbound flows.
entries.data.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.effective_at(timestamp) When the TransactionEntry will impact the FinancialAccount’s balance.entries.data.financial_account(string) The FinancialAccount associated with this object.entries.data.flow(string, nullable) Token of the flow associated with the TransactionEntry.entries.data.flow_details(object, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) Details of the flow associated with the TransactionEntry.entries.data.flow_details.credit_reversal(object, nullable) The CreditReversal object associated with the Transaction. Set iftype=credit_reversal.entries.data.flow_details.credit_reversal.id(string) Unique identifier for the object.entries.data.flow_details.credit_reversal.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.credit_reversal.amount(integer) Amount (in cents) transferred.entries.data.flow_details.credit_reversal.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.credit_reversal.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.credit_reversal.financial_account(string) The FinancialAccount to reverse funds from.entries.data.flow_details.credit_reversal.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.credit_reversal.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.credit_reversal.metadata(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.entries.data.flow_details.credit_reversal.network(enum) The rails used to reverse the funds.entries.data.flow_details.credit_reversal.received_credit(string) The ReceivedCredit being reversed.entries.data.flow_details.credit_reversal.status(enum) Status of the CreditReversal Possible enum values:canceledThe CreditReversal has been canceled before it has been sent to the network and no funds have left the account. (Currently not supported).postedThe CreditReversal has been sent to the network and funds have left the account (with the Transaction posting)processingThe CreditReversal starting state. Funds are “held” by a pending Transaction (but they are still part of the current balance).
entries.data.flow_details.credit_reversal.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.entries.data.flow_details.credit_reversal.status_transitions.posted_at(timestamp, nullable) Timestamp describing when the CreditReversal changed status toposted
entries.data.flow_details.credit_reversal.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.debit_reversal(object, nullable) The DebitReversal object associated with the Transaction. Set iftype=debit_reversal.entries.data.flow_details.debit_reversal.id(string) Unique identifier for the object.entries.data.flow_details.debit_reversal.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.debit_reversal.amount(integer) Amount (in cents) transferred.entries.data.flow_details.debit_reversal.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.debit_reversal.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.debit_reversal.financial_account(string, nullable) The FinancialAccount to reverse funds from.entries.data.flow_details.debit_reversal.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.debit_reversal.linked_flows(object, nullable) Other flows linked to a DebitReversal.entries.data.flow_details.debit_reversal.linked_flows.issuing_dispute(string, nullable) Set if there is an Issuing dispute associated with the DebitReversal.
entries.data.flow_details.debit_reversal.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.debit_reversal.metadata(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.entries.data.flow_details.debit_reversal.network(enum) The rails used to reverse the funds.entries.data.flow_details.debit_reversal.received_debit(string) The ReceivedDebit being reversed.entries.data.flow_details.debit_reversal.status(enum) Status of the DebitReversal Possible enum values:failedThe network has resolved the DebitReversal against the user.processingThe DebitReversal starting state.succeededThe network has resolved the DebitReversal in the users favour. A crediting Transaction is created.
entries.data.flow_details.debit_reversal.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.entries.data.flow_details.debit_reversal.status_transitions.completed_at(timestamp, nullable) Timestamp describing when the DebitReversal changed status tocompleted.
entries.data.flow_details.debit_reversal.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.inbound_transfer(object, nullable) The InboundTransfer object associated with the Transaction. Set iftype=inbound_transfer.entries.data.flow_details.inbound_transfer.id(string) Unique identifier for the object.entries.data.flow_details.inbound_transfer.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.inbound_transfer.amount(integer) Amount (in cents) transferred.entries.data.flow_details.inbound_transfer.cancelable(boolean) Returnstrueif the InboundTransfer is able to be canceled.entries.data.flow_details.inbound_transfer.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.inbound_transfer.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.inbound_transfer.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.inbound_transfer.failure_details(object, nullable) Details about this InboundTransfer’s failure. Only set when status isfailed.entries.data.flow_details.inbound_transfer.failure_details.code(enum) Reason for the failure. Possible enum values:account_closedThe bank account has been closed.account_frozenThe bank account has been frozen.bank_account_restrictedThe 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_changedThe bank account is no longer valid because its branch has changed ownership.debit_not_authorizedDebit transactions are not approved on the bank account.incorrect_account_holder_addressThe bank notified us that the bank account holder address on file is incorrect.incorrect_account_holder_nameThe bank notified us that the bank account holder name on file is incorrect.incorrect_account_holder_tax_idThe bank notified us that the bank account holder tax ID on file is incorrect.insufficient_fundsThe bank account has insufficient funds to cover the debit transaction.invalid_account_numberThe bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe bank was unable to process this transfer because of its currency. This is probably because the bank account can’t accept payments in that currency.no_accountThe bank account details on file are probably incorrect. No bank account exists with these details.otherThe bank could not process this transfer.
entries.data.flow_details.inbound_transfer.financial_account(string) The FinancialAccount that received the funds.entries.data.flow_details.inbound_transfer.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.inbound_transfer.linked_flows(object) Other flows linked to a InboundTransfer.entries.data.flow_details.inbound_transfer.linked_flows.received_debit(string, nullable) If funds for this flow were returned after the flow went to thesucceededstate, this field contains a reference to the ReceivedDebit return.
entries.data.flow_details.inbound_transfer.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.inbound_transfer.metadata(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.entries.data.flow_details.inbound_transfer.origin_payment_method(string, nullable) The origin payment method to be debited for an InboundTransfer.entries.data.flow_details.inbound_transfer.origin_payment_method_details(object, nullable) Details about the PaymentMethod for an InboundTransfer.entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details(object) Contact details for the person or business referenced by the PaymentMethod.entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address(object) Billing address.entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details.email(string, nullable) Email address.entries.data.flow_details.inbound_transfer.origin_payment_method_details.billing_details.name(string, nullable) Full name.
entries.data.flow_details.inbound_transfer.origin_payment_method_details.type(enum) The type of the payment method used in the InboundTransfer. Possible enum values:us_bank_accountUS Bank Account
entries.data.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account(object, nullable) Optional fields forus_bank_account.entries.data.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
entries.data.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
entries.data.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.bank_name(string, nullable) Name of the bank associated with the bank account.entries.data.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.entries.data.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.last4(string, nullable) Last four digits of the bank account number.entries.data.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the mandate used to make this payment.entries.data.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.network(enum) The network rails used. See the docs to learn more about money movement timelines for each network type.entries.data.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.routing_number(string, nullable) Routing number of the bank account.
entries.data.flow_details.inbound_transfer.returned(boolean, nullable) Returnstrueif the funds for an InboundTransfer were returned after the InboundTransfer went to thesucceededstate.entries.data.flow_details.inbound_transfer.statement_descriptor(string) Statement descriptor shown when funds are debited from the source. Not all payment networks supportstatement_descriptor.entries.data.flow_details.inbound_transfer.status(enum) Status of the InboundTransfer:processing,succeeded,failed, andcanceled. An InboundTransfer isprocessingif it is created and pending. The status changes tosucceededonce the funds have been “confirmed” and atransactionis created and posted. The status changes tofailedif the transfer fails.entries.data.flow_details.inbound_transfer.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.entries.data.flow_details.inbound_transfer.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an InboundTransfer changed status tofailed.entries.data.flow_details.inbound_transfer.status_transitions.succeeded_at(timestamp, nullable) Timestamp describing when an InboundTransfer changed status tosucceeded.
entries.data.flow_details.inbound_transfer.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.issuing_authorization(object, nullable) The Issuing authorization object associated with the Transaction. Set iftype=issuing_authorization.entries.data.flow_details.issuing_authorization.id(string) Unique identifier for the object.entries.data.flow_details.issuing_authorization.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.issuing_authorization.amount(integer) The total amount that was authorized or rejected. This amount is incurrencyand in the smallest currency unit.amountshould be the same asmerchant_amount, unlesscurrencyandmerchant_currencyare different.entries.data.flow_details.issuing_authorization.amount_details(object, nullable) Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit.entries.data.flow_details.issuing_authorization.amount_details.atm_fee(integer, nullable) The fee charged by the ATM for the cash withdrawal.entries.data.flow_details.issuing_authorization.amount_details.cashback_amount(integer, nullable) The amount of cash requested by the cardholder.
entries.data.flow_details.issuing_authorization.approved(boolean) Whether the authorization has been approved.entries.data.flow_details.issuing_authorization.authorization_method(enum) How the card details were provided. Possible enum values:chipThe card was physically present and inserted into a chip-enabled terminal. The transaction is cryptographically secured.contactlessThe card was present and tapped on a contactless-enabled terminal. If a digital wallet copy of the card was used, the wallet field will be present.keyed_inThe card number was manually entered into a terminal. Card presence is unknown and will be set to nil in testmode, but livemode values will depend on the actual card presence at the time of the transactiononlineThe card was used in a card-not-present scenario, such as a transaction initiated at an online e-commerce checkout.swipeThe card was physically present and swiped in a terminal.
entries.data.flow_details.issuing_authorization.balance_transactions(array of objects) List of balance transactions associated with this authorization.entries.data.flow_details.issuing_authorization.balance_transactions.id(string) Unique identifier for the object.entries.data.flow_details.issuing_authorization.balance_transactions.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.issuing_authorization.balance_transactions.amount(integer) Gross amount of this transaction (in the smallest currency unit). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.entries.data.flow_details.issuing_authorization.balance_transactions.available_on(timestamp) The date that the transaction’s net funds become available in the Stripe balance.entries.data.flow_details.issuing_authorization.balance_transactions.balance_type(enum) The balance that this transaction impacts. Possible enum values:issuingBalance Transactions that affect your Issuing balancepaymentsBalance Transactions that affect your Payments balancerefund_and_dispute_prefundingBalance Transactions that affect your Refund and Dispute Prefunding balancerisk_reservedBalance Transactions that affect your Risk Reserved balance
entries.data.flow_details.issuing_authorization.balance_transactions.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.issuing_authorization.balance_transactions.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.issuing_authorization.balance_transactions.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.issuing_authorization.balance_transactions.exchange_rate(float, nullable) If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then theamountin currency A, multipled by theexchange_rate, equals theamountin currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent’samountis1000andcurrencyiseur. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction’samountis1234, itscurrencyisusd, and theexchange_rateis1.234.entries.data.flow_details.issuing_authorization.balance_transactions.fee(integer) Fees (in the smallest currency unit) paid for this transaction. Represented as a positive integer when assessed.entries.data.flow_details.issuing_authorization.balance_transactions.fee_details(array of objects) Detailed breakdown of fees (in the smallest currency unit) paid for this transaction.entries.data.flow_details.issuing_authorization.balance_transactions.fee_details.amount(integer) Amount of the fee, in cents.entries.data.flow_details.issuing_authorization.balance_transactions.fee_details.application(string, nullable) ID of the Connect application that earned the fee.entries.data.flow_details.issuing_authorization.balance_transactions.fee_details.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.issuing_authorization.balance_transactions.fee_details.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.issuing_authorization.balance_transactions.fee_details.type(string) Type of the fee, one of:application_fee,payment_method_passthrough_fee,stripe_fee,tax, orwithheld_tax.
entries.data.flow_details.issuing_authorization.balance_transactions.net(integer) Net impact to a Stripe balance (in the smallest currency unit). 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 byamount-feeentries.data.flow_details.issuing_authorization.balance_transactions.reporting_category(string) Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.entries.data.flow_details.issuing_authorization.balance_transactions.source(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) This transaction relates to the Stripe object.entries.data.flow_details.issuing_authorization.balance_transactions.status(string) The transaction’s net funds status in the Stripe balance, which are eitheravailableorpending.entries.data.flow_details.issuing_authorization.balance_transactions.type(enum) Transaction type:adjustment,advance,advance_funding,anticipation_repayment,application_fee,application_fee_refund,charge,climate_order_purchase,climate_order_refund,connect_collection_transfer,contribution,inbound_transfer,inbound_transfer_reversal,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,reserve_hold,reserve_release,stripe_fee,stripe_fx_fee,stripe_balance_payment_debit,stripe_balance_payment_debit_reversal,tax_fee,topup,topup_reversal,transfer,transfer_cancel,transfer_failure,transfer_refund, orfee_credit_funding. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, considerreporting_categoryinstead. Possible enum values:adjustmentadvanceadvance_fundinganticipation_repaymentapplication_feeapplication_fee_refundchargeclimate_order_purchaseclimate_order_refundconnect_collection_transfercontributionfee_credit_fundinginbound_transferinbound_transfer_reversalissuing_authorization_holdissuing_authorization_releaseissuing_disputeissuing_transactionobligation_outboundobligation_reversal_inboundpaymentpayment_failure_refundpayment_network_reserve_holdpayment_network_reserve_releasepayment_refundpayment_reversalpayment_unreconciledpayoutpayout_cancelpayout_failurepayout_minimum_balance_holdpayout_minimum_balance_releaserefundrefund_failurereserve_holdreserve_releasereserve_transactionreserved_fundsstripe_balance_payment_debitstripe_balance_payment_debit_reversalstripe_feestripe_fx_feetax_feetopuptopup_reversaltransfertransfer_canceltransfer_failuretransfer_refund
entries.data.flow_details.issuing_authorization.card(object) Card associated with this authorization.entries.data.flow_details.issuing_authorization.card.id(string) Unique identifier for the object.entries.data.flow_details.issuing_authorization.card.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.issuing_authorization.card.brand(string) The brand of the card.entries.data.flow_details.issuing_authorization.card.cancellation_reason(enum, nullable) The reason why the card was canceled. Possible enum values:design_rejectedThe design of this card was rejected by Stripe for violating our partner guidelines.fulfillment_errorThere was an error in fulfilling the card. This reason is only valid for cards of typephysical.lostThe card was lost.stolenThe card was stolen.
entries.data.flow_details.issuing_authorization.card.cardholder(object) The Cardholder object to which the card belongs.entries.data.flow_details.issuing_authorization.card.cardholder.id(string) Unique identifier for the object.entries.data.flow_details.issuing_authorization.card.cardholder.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.issuing_authorization.card.cardholder.billing(object) The cardholder’s billing information.entries.data.flow_details.issuing_authorization.card.cardholder.billing.address(object) The cardholder’s billing address.entries.data.flow_details.issuing_authorization.card.cardholder.billing.address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.issuing_authorization.card.cardholder.billing.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.issuing_authorization.card.cardholder.billing.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.issuing_authorization.card.cardholder.billing.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.issuing_authorization.card.cardholder.billing.address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.issuing_authorization.card.cardholder.billing.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.issuing_authorization.card.cardholder.company(object, nullable) Additional information about acompanycardholder.entries.data.flow_details.issuing_authorization.card.cardholder.company.tax_id_provided(boolean) Whether the company’s business ID number was provided.
entries.data.flow_details.issuing_authorization.card.cardholder.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.issuing_authorization.card.cardholder.email(string, nullable) The cardholder’s email address.entries.data.flow_details.issuing_authorization.card.cardholder.individual(object, nullable) Additional information about anindividualcardholder.entries.data.flow_details.issuing_authorization.card.cardholder.individual.card_issuing(object, nullable) Information related to the card_issuing program for this cardholder.entries.data.flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance(object, nullable) Information about cardholder acceptance of Celtic Authorized User Terms. Required for cards backed by a Celtic program.entries.data.flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance.date(timestamp, nullable) The Unix timestamp marking when the cardholder accepted the Authorized User Terms.entries.data.flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance.ip(string, nullable) The IP address from which the cardholder accepted the Authorized User Terms.entries.data.flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance.user_agent(string, nullable) The user agent of the browser from which the cardholder accepted the Authorized User Terms.
entries.data.flow_details.issuing_authorization.card.cardholder.individual.dob(object, nullable) The date of birth of this cardholder.entries.data.flow_details.issuing_authorization.card.cardholder.individual.dob.day(integer, nullable) The day of birth, between 1 and 31.entries.data.flow_details.issuing_authorization.card.cardholder.individual.dob.month(integer, nullable) The month of birth, between 1 and 12.entries.data.flow_details.issuing_authorization.card.cardholder.individual.dob.year(integer, nullable) The four-digit year of birth.
entries.data.flow_details.issuing_authorization.card.cardholder.individual.first_name(string, nullable) 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.entries.data.flow_details.issuing_authorization.card.cardholder.individual.last_name(string, nullable) 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.entries.data.flow_details.issuing_authorization.card.cardholder.individual.verification(object, nullable) Government-issued ID document for this cardholder.entries.data.flow_details.issuing_authorization.card.cardholder.individual.verification.document(object, nullable) An identifying document, either a passport or local ID card.entries.data.flow_details.issuing_authorization.card.cardholder.individual.verification.document.back(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The back of a document returned by a file upload with apurposevalue ofidentity_document.entries.data.flow_details.issuing_authorization.card.cardholder.individual.verification.document.front(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The front of a document returned by a file upload with apurposevalue ofidentity_document.
entries.data.flow_details.issuing_authorization.card.cardholder.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.issuing_authorization.card.cardholder.metadata(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.entries.data.flow_details.issuing_authorization.card.cardholder.name(string) The cardholder’s name. This will be printed on cards issued to them.entries.data.flow_details.issuing_authorization.card.cardholder.phone_number(string, nullable) 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.entries.data.flow_details.issuing_authorization.card.cardholder.preferred_locales(array of enums, nullable) The cardholder’s preferred locales (languages), ordered by preference. Locales can beda,de,en,es,fr,it,pl, orsv. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.entries.data.flow_details.issuing_authorization.card.cardholder.requirements(object) Information about verification requirements for the cardholder.entries.data.flow_details.issuing_authorization.card.cardholder.requirements.disabled_reason(enum, nullable) Ifdisabled_reasonis present, all cards will decline authorizations withcardholder_verification_requiredreason. Possible enum values:listedAccount might be on a prohibited persons or companies list. Thepast_duefield contains information that you need to provide before the cardholder can approve authorizations.rejected.listedCardholder is rejected because they are on a third-party prohibited persons or companies list (such as financial services provider or government). Their status will beblocked.requirements.past_dueCardholder has outstanding requirements. Thepast_duefield contains information that you need to provide before the cardholder can activate cards.under_reviewThis cardholder has raised additional review. Stripe will make a decision and update thedisabled_reasonfield.
entries.data.flow_details.issuing_authorization.card.cardholder.requirements.past_due(array of enums, nullable) Array of fields that need to be collected in order to verify and re-enable the cardholder. Possible enum values:company.tax_idThe cardholder’s business number (Tax ID).individual.card_issuing.user_terms_acceptance.dateThe Unix timestamp marking when the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users.individual.card_issuing.user_terms_acceptance.ipThe IP address from which the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users.individual.dob.dayThe cardholder’s date of birth’s day.individual.dob.monthThe cardholder’s date of birth’s month.individual.dob.yearThe cardholder’s date of birth’s year.individual.first_nameThe cardholder’s legal first name.individual.last_nameThe cardholder’s legal last name.individual.verification.documentThe front and back of a government-issued form of identification.
entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls(object, nullable) Rules that control spending across this cardholder’s cards. Refer to our documentation for more details.entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.allowed_card_presences(array of enums, nullable) Array of card presence statuses from which authorizations will be allowed. Possible options arepresent,not_present. All other statuses will be blocked. Cannot be set withblocked_card_presences. Provide an empty value to unset this control. Possible enum values:not_presentpresent
entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.allowed_categories(array of enums, nullable) Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set withblocked_categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.allowed_merchant_countries(array of strings, nullable) 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 withblocked_merchant_countries. Provide an empty value to unset this control.entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.blocked_card_presences(array of enums, nullable) Array of card presence statuses from which authorizations will be declined. Possible options arepresent,not_present. Cannot be set withallowed_card_presences. Provide an empty value to unset this control. Possible enum values:not_presentpresent
entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.blocked_categories(array of enums, nullable) Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set withallowed_categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.blocked_merchant_countries(array of strings, nullable) 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 withallowed_merchant_countries. Provide an empty value to unset this control.entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits(array of objects, nullable) Limit spending with amount-based rules that apply across this cardholder’s cards.entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits.amount(integer) Maximum amount allowed to spend per interval. This amount is in the card’s currency and in the smallest currency unit.entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits.categories(array of enums, nullable) Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits.interval(enum) Interval (or event) to which the amount applies. Possible enum values:all_timeLimit applies to all transactions.dailyLimit applies to a day, starting at midnight UTC.monthlyLimit applies to a month, starting on the 1st at midnight UTC.per_authorizationLimit applies to each authorization.weeklyLimit applies to a week, starting on Sunday at midnight UTC.yearlyLimit applies to a year, starting on January 1st at midnight UTC.
entries.data.flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits_currency(enum, nullable) Currency of the amounts withinspending_limits.
entries.data.flow_details.issuing_authorization.card.cardholder.status(enum) Specifies whether to permit authorizations on this cardholder’s cards. Possible enum values:activeA platform has enabled the cardholder to approve authorizations made with their attached cards. However, if Stripe hasn’t yet verified the cardholder’s identity information, authorizations might still be blocked.blockedCards attached to this cardholder will decline all authorizations with thecardholder_blockedreason. This status is non-reversible.inactiveCards attached to this cardholder will decline all authorizations with thecardholder_inactivereason.
entries.data.flow_details.issuing_authorization.card.cardholder.type(enum) One ofindividualorcompany. See Choose a cardholder type for more details. Possible enum values:companyThe 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.individualThe 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.
entries.data.flow_details.issuing_authorization.card.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.issuing_authorization.card.currency(enum) Three-letter ISO currency code, in lowercase. Supported currencies areusdin the US,eurin the EU, andgbpin the UK.entries.data.flow_details.issuing_authorization.card.cvc(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The card’s CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with theexpandparameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint.entries.data.flow_details.issuing_authorization.card.exp_month(integer) The expiration month of the card.entries.data.flow_details.issuing_authorization.card.exp_year(integer) The expiration year of the card.entries.data.flow_details.issuing_authorization.card.last4(string) The last 4 digits of the card number.entries.data.flow_details.issuing_authorization.card.latest_fraud_warning(object, nullable) Stripe’s assessment of whether this card’s details have been compromised. If this property isn’t null, cancel and reissue the card to prevent fraudulent activity risk.entries.data.flow_details.issuing_authorization.card.latest_fraud_warning.started_at(timestamp, nullable) Timestamp of the most recent fraud warning.entries.data.flow_details.issuing_authorization.card.latest_fraud_warning.type(enum, nullable) The type of fraud warning that most recently took place on this card. This field updates with every new fraud warning, so the value changes over time. If populated, cancel and reissue the card. Possible enum values:card_testing_exposureThe card’s credentials were used successfully in a card testing attempt. Requires Advanced Fraud Tools.fraud_dispute_filedThe cardholder filed a fraud dispute for a transactionthird_party_reportedThe card was reported compromised by a third partyuser_indicated_fraudThe cardholder indicated that a fraudulent transaction occurred. Requires Advanced Fraud Tools.
entries.data.flow_details.issuing_authorization.card.lifecycle_controls(object, nullable) Rules that control the lifecycle of this card, such as automatic cancellation. Refer to our documentation for more details.entries.data.flow_details.issuing_authorization.card.lifecycle_controls.cancel_after(object) Cancels the card after the specified conditions are met.entries.data.flow_details.issuing_authorization.card.lifecycle_controls.cancel_after.payment_count(integer) The card is automatically cancelled when it makes this number of non-zero payment authorizations and transactions. The count includes penny authorizations, but doesn’t include non-payment actions, such as authorization advice.
entries.data.flow_details.issuing_authorization.card.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.issuing_authorization.card.metadata(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.entries.data.flow_details.issuing_authorization.card.number(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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 theexpandparameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint.entries.data.flow_details.issuing_authorization.card.personalization_design(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The personalization design object belonging to this card.entries.data.flow_details.issuing_authorization.card.replaced_by(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The latest card that replaces this card, if any.entries.data.flow_details.issuing_authorization.card.replacement_for(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The card this card replaces, if any.entries.data.flow_details.issuing_authorization.card.replacement_reason(enum, nullable) The reason why the previous card needed to be replaced. Possible enum values:damagedThe physical card has been damaged and cannot be used at terminals. This reason is only valid for cards of typephysical.expiredThe expiration date has passed or is imminent.fulfillment_errorThere was an error in fulfilling the card. This reason is only valid for cards of typephysical.lostThe card was lost. This status is only valid if the card it replaces is marked as lost.stolenThe card was stolen. This status is only valid if the card it replaces is marked as stolen.
entries.data.flow_details.issuing_authorization.card.second_line(string, nullable) Text separate from cardholder name, printed on the card.entries.data.flow_details.issuing_authorization.card.shipping(object, nullable) Where and how the card will be shipped.entries.data.flow_details.issuing_authorization.card.shipping.address(object) Shipping address.entries.data.flow_details.issuing_authorization.card.shipping.address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.issuing_authorization.card.shipping.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.issuing_authorization.card.shipping.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.issuing_authorization.card.shipping.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.issuing_authorization.card.shipping.address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.issuing_authorization.card.shipping.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.issuing_authorization.card.shipping.address_validation(object, nullable) Address validation details for the shipment.entries.data.flow_details.issuing_authorization.card.shipping.address_validation.mode(enum) The address validation capabilities to use. Possible enum values:disabledThe card will be shipped without validating or normalizing the shipping address.normalization_onlyThe card will be shipped with the normalized address without validation. Undeliverable addresses won’t be blocked.validation_and_normalizationThe card will be shipped with the normalized, validated address. Undeliverable addresses will be blocked.
entries.data.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address(object, nullable) The normalized shipping address.entries.data.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.issuing_authorization.card.shipping.address_validation.result(enum, nullable) The validation result for the shipping address. Possible enum values:indeterminateThe deliverability of the card’s shipping address could not be determined.likely_deliverableThe card’s shipping address is likely deliverable.likely_undeliverableThe card’s shipping address is likely undeliverable as submitted.
entries.data.flow_details.issuing_authorization.card.shipping.carrier(enum, nullable) The delivery company that shipped a card. Possible enum values:dhlDHLfedexFedExroyal_mailRoyal MailuspsUSPS
entries.data.flow_details.issuing_authorization.card.shipping.customs(object, nullable) Additional information that may be required for clearing customs.entries.data.flow_details.issuing_authorization.card.shipping.customs.eori_number(string, nullable) 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.
entries.data.flow_details.issuing_authorization.card.shipping.eta(timestamp, nullable) A unix timestamp representing a best estimate of when the card will be delivered.entries.data.flow_details.issuing_authorization.card.shipping.name(string) Recipient name.entries.data.flow_details.issuing_authorization.card.shipping.phone_number(string, nullable) 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.entries.data.flow_details.issuing_authorization.card.shipping.require_signature(boolean, nullable) 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.entries.data.flow_details.issuing_authorization.card.shipping.service(enum) Shipment service, such asstandardorexpress. Possible enum values:expressCards arrive in 4 business days.priorityCards arrive in 2-3 business days.standardCards arrive in 5-8 business days.
entries.data.flow_details.issuing_authorization.card.shipping.status(enum, nullable) The delivery status of the card. Possible enum values:canceledThe card was canceled before being shipped.deliveredThe card has been delivered to its destination.failureThe card failed to be delivered but was not returned.pendingThe card is being prepared and has not yet shipped.returnedThe card failed to be delivered and was returned to the sender.shippedThe card has been shipped. If the card’s shipping carrier does not support tracking, this will be the card’s final status.submittedThe card has been submitted to the printer for shipment.
entries.data.flow_details.issuing_authorization.card.shipping.tracking_number(string, nullable) A tracking number for a card shipment.entries.data.flow_details.issuing_authorization.card.shipping.tracking_url(string, nullable) A link to the shipping carrier’s site where you can view detailed information about a card shipment.entries.data.flow_details.issuing_authorization.card.shipping.type(enum) Packaging options. Possible enum values:bulkCards are grouped and mailed together.individualCards are sent individually in an envelope.
entries.data.flow_details.issuing_authorization.card.spending_controls(object) Rules that control spending for this card. Refer to our documentation for more details.entries.data.flow_details.issuing_authorization.card.spending_controls.allowed_card_presences(array of enums, nullable) Array of card presence statuses from which authorizations will be allowed. Possible options arepresent,not_present. All other statuses will be blocked. Cannot be set withblocked_card_presences. Provide an empty value to unset this control. Possible enum values:not_presentpresent
entries.data.flow_details.issuing_authorization.card.spending_controls.allowed_categories(array of enums, nullable) Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set withblocked_categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
entries.data.flow_details.issuing_authorization.card.spending_controls.allowed_merchant_countries(array of strings, nullable) 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 withblocked_merchant_countries. Provide an empty value to unset this control.entries.data.flow_details.issuing_authorization.card.spending_controls.blocked_card_presences(array of enums, nullable) Array of card presence statuses from which authorizations will be declined. Possible options arepresent,not_present. Cannot be set withallowed_card_presences. Provide an empty value to unset this control. Possible enum values:not_presentpresent
entries.data.flow_details.issuing_authorization.card.spending_controls.blocked_categories(array of enums, nullable) Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set withallowed_categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
entries.data.flow_details.issuing_authorization.card.spending_controls.blocked_merchant_countries(array of strings, nullable) 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 withallowed_merchant_countries. Provide an empty value to unset this control.entries.data.flow_details.issuing_authorization.card.spending_controls.spending_limits(array of objects, nullable) Limit spending with amount-based rules that apply across any cards this card replaced (i.e., itsreplacement_forcard and that card’sreplacement_forcard, up the chain).entries.data.flow_details.issuing_authorization.card.spending_controls.spending_limits.amount(integer) Maximum amount allowed to spend per interval. This amount is in the card’s currency and in the smallest currency unit.entries.data.flow_details.issuing_authorization.card.spending_controls.spending_limits.categories(array of enums, nullable) Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
entries.data.flow_details.issuing_authorization.card.spending_controls.spending_limits.interval(enum) Interval (or event) to which the amount applies. Possible enum values:all_timeLimit applies to all transactions.dailyLimit applies to a day, starting at midnight UTC.monthlyLimit applies to a month, starting on the 1st at midnight UTC.per_authorizationLimit applies to each authorization.weeklyLimit applies to a week, starting on Sunday at midnight UTC.yearlyLimit applies to a year, starting on January 1st at midnight UTC.
entries.data.flow_details.issuing_authorization.card.spending_controls.spending_limits_currency(enum, nullable) Currency of the amounts withinspending_limits. Always the same as the currency of the card.
entries.data.flow_details.issuing_authorization.card.status(enum) Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults toinactive. Possible enum values:activeThe 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’.canceledThe card will decline authorizations with thecard_canceledreason. This status is permanent.inactiveThe card will decline authorizations with thecard_inactivereason.
entries.data.flow_details.issuing_authorization.card.type(enum) The type of the card. Possible enum values:physicalA physical card will be printed and shipped. It can be used at physical terminals.virtualNo physical card will be printed. The card can be used online and can be added to digital wallets.
entries.data.flow_details.issuing_authorization.card.wallets(object, nullable) Information relating to digital wallets (like Apple Pay and Google Pay).entries.data.flow_details.issuing_authorization.card.wallets.apple_pay(object) Apple Pay Detailsentries.data.flow_details.issuing_authorization.card.wallets.apple_pay.eligible(boolean) Apple Pay Eligibilityentries.data.flow_details.issuing_authorization.card.wallets.apple_pay.ineligible_reason(enum, nullable) Reason the card is ineligible for Apple Pay Possible enum values:missing_agreementApple Pay is not enabled for your account.missing_cardholder_contactCardholder phone number or email required.unsupported_regionApple Pay is not supported in the cardholder’s country.
entries.data.flow_details.issuing_authorization.card.wallets.google_pay(object) Google Pay Detailsentries.data.flow_details.issuing_authorization.card.wallets.google_pay.eligible(boolean) Google Pay Eligibilityentries.data.flow_details.issuing_authorization.card.wallets.google_pay.ineligible_reason(enum, nullable) Reason the card is ineligible for Google Pay Possible enum values:missing_agreementGoogle Pay is not enabled for your account.missing_cardholder_contactCardholder phone number or email required.unsupported_regionGoogle Pay is not supported in the cardholder’s country.
entries.data.flow_details.issuing_authorization.card.wallets.primary_account_identifier(string, nullable) Unique identifier for a card used with digital wallets
entries.data.flow_details.issuing_authorization.card_presence(enum, nullable) Whether the card was present at the point of sale for the authorization. Possible enum values:not_presentThe card was not present at the point of sale.presentThe card was present at the point of sale.
entries.data.flow_details.issuing_authorization.cardholder(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The cardholder to whom this authorization belongs.entries.data.flow_details.issuing_authorization.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.issuing_authorization.currency(enum) The currency of the cardholder. This currency can be different from the currency presented at authorization and themerchant_currencyfield on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.issuing_authorization.fleet(object, nullable) Fleet-specific information for authorizations using Fleet cards.entries.data.flow_details.issuing_authorization.fleet.cardholder_prompt_data(object, nullable) 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.entries.data.flow_details.issuing_authorization.fleet.cardholder_prompt_data.alphanumeric_id(string, nullable) [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.entries.data.flow_details.issuing_authorization.fleet.cardholder_prompt_data.driver_id(string, nullable) Driver ID.entries.data.flow_details.issuing_authorization.fleet.cardholder_prompt_data.odometer(integer, nullable) Odometer reading.entries.data.flow_details.issuing_authorization.fleet.cardholder_prompt_data.unspecified_id(string, nullable) 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.entries.data.flow_details.issuing_authorization.fleet.cardholder_prompt_data.user_id(string, nullable) User ID.entries.data.flow_details.issuing_authorization.fleet.cardholder_prompt_data.vehicle_number(string, nullable) Vehicle number.
entries.data.flow_details.issuing_authorization.fleet.purchase_type(enum, nullable) The type of purchase. Possible enum values:fuel_and_non_fuel_purchaseFuel and non-fuel purchase.fuel_purchaseFuel-only purchase.non_fuel_purchaseNon-fuel purchase.
entries.data.flow_details.issuing_authorization.fleet.reported_breakdown(object, nullable) 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.entries.data.flow_details.issuing_authorization.fleet.reported_breakdown.fuel(object, nullable) Breakdown of fuel portion of the purchase.entries.data.flow_details.issuing_authorization.fleet.reported_breakdown.fuel.gross_amount_decimal(decimal string, nullable) Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.
entries.data.flow_details.issuing_authorization.fleet.reported_breakdown.non_fuel(object, nullable) Breakdown of non-fuel portion of the purchase.entries.data.flow_details.issuing_authorization.fleet.reported_breakdown.non_fuel.gross_amount_decimal(decimal string, nullable) Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
entries.data.flow_details.issuing_authorization.fleet.reported_breakdown.tax(object, nullable) Information about tax included in this transaction.entries.data.flow_details.issuing_authorization.fleet.reported_breakdown.tax.local_amount_decimal(decimal string, nullable) Amount of state or provincial Sales Tax included in the transaction amount.nullif not reported by merchant or not subject to tax.entries.data.flow_details.issuing_authorization.fleet.reported_breakdown.tax.national_amount_decimal(decimal string, nullable) Amount of national Sales Tax or VAT included in the transaction amount.nullif not reported by merchant or not subject to tax.
entries.data.flow_details.issuing_authorization.fleet.service_type(enum, nullable) The type of fuel service. Possible enum values:full_serviceFull-service fuel station purchase.non_fuel_transactionNon-fuel transaction.self_serviceSelf-service fuel station purchase.
entries.data.flow_details.issuing_authorization.fraud_challenges(array of objects, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.entries.data.flow_details.issuing_authorization.fraud_challenges.channel(enum) The method by which the fraud challenge was delivered to the cardholder. Possible enum values:smsSMS sent to the cardholder’s phone number.
entries.data.flow_details.issuing_authorization.fraud_challenges.status(enum) The status of the fraud challenge. Possible enum values:expiredThe 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.pendingThe challenge has been sent to the cardholder or is about to be sent.rejectedThe cardholder responded to the challenge indicating that the authorization was fraudulent, and that similar authorizations should continue to be declined.undeliverableA challenge has been requested to be sent, but the cardholder is unable to receive it.verifiedThe cardholder responded to the challenge indicating that the authorization was not fraudulent, and that similar authorizations should be approved.
entries.data.flow_details.issuing_authorization.fraud_challenges.undeliverable_reason(enum, nullable) If the challenge is not deliverable, the reason why. Possible enum values:no_phone_numberSMS fraud challenges cannot be delivered to this cardholder because they have nophone_number.unsupported_phone_numberSMS fraud challenges cannot be delivered to this cardholder because theirphone_numberis not supported
entries.data.flow_details.issuing_authorization.fuel(object, nullable) 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.entries.data.flow_details.issuing_authorization.fuel.industry_product_code(string, nullable) Conexxus Payment System Product Code identifying the primary fuel product purchased.entries.data.flow_details.issuing_authorization.fuel.quantity_decimal(decimal string, nullable) The quantity ofunits of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.entries.data.flow_details.issuing_authorization.fuel.type(enum, nullable) The type of fuel that was purchased. Possible enum values:dieselDiesel.otherOther.unleaded_plusUnleaded plus.unleaded_regularUnleaded regular.unleaded_superUnleaded super.
entries.data.flow_details.issuing_authorization.fuel.unit(enum, nullable) The units forquantity_decimal. Possible enum values:charging_minuteCharging minute.imperial_gallonImperial gallon.kilogramKilogram.kilowatt_hourKilowatt-hour.literLiter.otherOther.poundPound.us_gallonUS gallon.
entries.data.flow_details.issuing_authorization.fuel.unit_cost_decimal(decimal string, nullable) The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
entries.data.flow_details.issuing_authorization.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.issuing_authorization.merchant_amount(integer) The total amount that was authorized or rejected. This amount is in themerchant_currencyand in the smallest currency unit.merchant_amountshould be the same asamount, unlessmerchant_currencyandcurrencyare different.entries.data.flow_details.issuing_authorization.merchant_currency(enum) The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and thecurrencyfield on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.issuing_authorization.merchant_data(object) Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.entries.data.flow_details.issuing_authorization.merchant_data.category(string) A categorization of the seller’s type of business. See our merchant categories guide for a list of possible values.entries.data.flow_details.issuing_authorization.merchant_data.category_code(string) The merchant category code for the seller’s businessentries.data.flow_details.issuing_authorization.merchant_data.city(string, nullable) City where the seller is locatedentries.data.flow_details.issuing_authorization.merchant_data.country(string, nullable) Country where the seller is locatedentries.data.flow_details.issuing_authorization.merchant_data.name(string, nullable) Name of the sellerentries.data.flow_details.issuing_authorization.merchant_data.network_id(string) Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.entries.data.flow_details.issuing_authorization.merchant_data.postal_code(string, nullable) Postal code where the seller is locatedentries.data.flow_details.issuing_authorization.merchant_data.state(string, nullable) State where the seller is locatedentries.data.flow_details.issuing_authorization.merchant_data.tax_id(string, nullable) The seller’s tax identification number. Currently populated for French merchants only.entries.data.flow_details.issuing_authorization.merchant_data.terminal_id(string, nullable) An ID assigned by the seller to the location of the sale.entries.data.flow_details.issuing_authorization.merchant_data.url(string, nullable) URL provided by the merchant on a 3DS request
entries.data.flow_details.issuing_authorization.metadata(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.entries.data.flow_details.issuing_authorization.network_data(object, nullable) Details about the authorization, such as identifiers, set by the card network.entries.data.flow_details.issuing_authorization.network_data.acquiring_institution_id(string, nullable) Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will benull.entries.data.flow_details.issuing_authorization.network_data.system_trace_audit_number(string, nullable) The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefernetwork_data.transaction_idif present, unless you have special requirements.entries.data.flow_details.issuing_authorization.network_data.transaction_id(string, nullable) Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
entries.data.flow_details.issuing_authorization.pending_request(object, nullable) The pending authorization request. This field will only be non-null during anissuing_authorization.requestwebhook.entries.data.flow_details.issuing_authorization.pending_request.amount(integer) The additional amount Stripe will hold if the authorization is approved, in the card’s currency and in the smallest currency unit.entries.data.flow_details.issuing_authorization.pending_request.amount_details(object, nullable) Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit.entries.data.flow_details.issuing_authorization.pending_request.amount_details.atm_fee(integer, nullable) The fee charged by the ATM for the cash withdrawal.entries.data.flow_details.issuing_authorization.pending_request.amount_details.cashback_amount(integer, nullable) The amount of cash requested by the cardholder.
entries.data.flow_details.issuing_authorization.pending_request.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.issuing_authorization.pending_request.is_amount_controllable(boolean) If settrue, you may provide amount to control how much to hold for the authorization.entries.data.flow_details.issuing_authorization.pending_request.merchant_amount(integer) The amount the merchant is requesting to be authorized in themerchant_currency. The amount is in the smallest currency unit.entries.data.flow_details.issuing_authorization.pending_request.merchant_currency(enum) The local currency the merchant is requesting to authorize.entries.data.flow_details.issuing_authorization.pending_request.network_risk_score(integer, nullable) The card network’s estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
entries.data.flow_details.issuing_authorization.request_history(array of objects) History of every time apending_requestauthorization 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.entries.data.flow_details.issuing_authorization.request_history.amount(integer) Thepending_request.amountat 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.entries.data.flow_details.issuing_authorization.request_history.amount_details(object, nullable) Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit.entries.data.flow_details.issuing_authorization.request_history.amount_details.atm_fee(integer, nullable) The fee charged by the ATM for the cash withdrawal.entries.data.flow_details.issuing_authorization.request_history.amount_details.cashback_amount(integer, nullable) The amount of cash requested by the cardholder.
entries.data.flow_details.issuing_authorization.request_history.approved(boolean) Whether this request was approved.entries.data.flow_details.issuing_authorization.request_history.authorization_code(string, nullable) 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.entries.data.flow_details.issuing_authorization.request_history.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.issuing_authorization.request_history.currency(string) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.issuing_authorization.request_history.merchant_amount(integer) Thepending_request.merchant_amountat the time of the request, presented in themerchant_currencyand in the smallest currency unit.entries.data.flow_details.issuing_authorization.request_history.merchant_currency(string) 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.entries.data.flow_details.issuing_authorization.request_history.network_risk_score(integer, nullable) The card network’s estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.entries.data.flow_details.issuing_authorization.request_history.reason(enum) 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_disabledThe 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_activeThe 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_canceledThe authorization request was declined because the card was canceled.card_expiredThe authorization request was declined because the card has expired. Documentation for replacing an expired card can be found here.card_inactiveThe authorization request was declined because the card was inactive. To activate the card, refer to our documentation.cardholder_blockedThe authorization request was declined because the cardholder is blocked.cardholder_inactiveThe 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_requiredThe 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_methodThe 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_fundsThe authorization request was declined because your account had insufficient funds. Documentation for topping up your Issuing Balance can be found here.network_fallback[Stripe Autopilot] Stripe timed out or encountered an error when responding to the card network. If you have a dedicated BIN and have configured Autopilot, the card network approved or declined the authorization based on your STIP configuration.not_allowedThe charge is not allowed on the Stripe network, possibly because it is an ATM withdrawal or cash advance.pin_blockedThe authorization request was declined because the card’s PIN is blocked. Documentation on managing PINs can be found here.spending_controlsThe authorization was declined because of your spending controls. Documentation for updating your spending controls can be found here. Replaces the deprecated authorization_controls enum.suspected_fraudThe authorization was suspected to be fraud based on Stripe’s risk controls.verification_failedThe authorization failed required verification checks. See authorization.verification_data for more information. Replaces the deprecated authentication_failed, incorrect_cvc, and incorrect_expiry enums.webhook_approvedThe authorization was approved via the real-time auth webhook. More details on this can be found here.webhook_declinedThe authorization was declined via the real-time auth webhook. More details on this can be found here.webhook_error[Autopilot] The response sent through the real-time auth webhook is invalid.webhook_timeout[Autopilot] If you are using the real-time auth webhook, the webhook timed out before we received your authorization decision. Stripe approved or declined the authorization based on what you’ve configured in your Issuing default or Autopilot settings.
entries.data.flow_details.issuing_authorization.request_history.reason_message(string, nullable) If therequest_history.reasoniswebhook_errorbecause the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.entries.data.flow_details.issuing_authorization.request_history.requested_at(timestamp, nullable) Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.
entries.data.flow_details.issuing_authorization.status(enum) The current status of the authorization in its lifecycle. Possible enum values:closedThe authorization was declined or captured through one or more transactions.expiredThe authorization was expired without capture.pendingThe authorization was created and is awaiting approval or was approved and is awaiting capture.reversedThe authorization was reversed by the merchant.
entries.data.flow_details.issuing_authorization.token(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) Token object used for this authorization. If a network token was not used for this authorization, this field will be null.entries.data.flow_details.issuing_authorization.transactions(array of objects) List of transactions associated with this authorization.entries.data.flow_details.issuing_authorization.transactions.id(string) Unique identifier for the object.entries.data.flow_details.issuing_authorization.transactions.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.issuing_authorization.transactions.amount(integer) The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit.entries.data.flow_details.issuing_authorization.transactions.amount_details(object, nullable) Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit.entries.data.flow_details.issuing_authorization.transactions.amount_details.atm_fee(integer, nullable) The fee charged by the ATM for the cash withdrawal.entries.data.flow_details.issuing_authorization.transactions.amount_details.cashback_amount(integer, nullable) The amount of cash requested by the cardholder.
entries.data.flow_details.issuing_authorization.transactions.authorization(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) TheAuthorizationobject that led to this transaction.entries.data.flow_details.issuing_authorization.transactions.balance_transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the balance transaction associated with this transaction.entries.data.flow_details.issuing_authorization.transactions.card(string, expandable (can be expanded into an object with theexpandrequest parameter)) The card used to make this transaction.entries.data.flow_details.issuing_authorization.transactions.cardholder(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The cardholder to whom this transaction belongs.entries.data.flow_details.issuing_authorization.transactions.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.issuing_authorization.transactions.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.issuing_authorization.transactions.dispute(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) If you’ve disputed the transaction, the ID of the dispute.entries.data.flow_details.issuing_authorization.transactions.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.issuing_authorization.transactions.merchant_amount(integer) The amount that the merchant will receive, denominated inmerchant_currencyand in the smallest currency unit. It will be different fromamountif the merchant is taking payment in a different currency.entries.data.flow_details.issuing_authorization.transactions.merchant_currency(enum) The currency with which the merchant is taking payment.entries.data.flow_details.issuing_authorization.transactions.merchant_data(object) Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction.entries.data.flow_details.issuing_authorization.transactions.merchant_data.category(string) A categorization of the seller’s type of business. See our merchant categories guide for a list of possible values.entries.data.flow_details.issuing_authorization.transactions.merchant_data.category_code(string) The merchant category code for the seller’s businessentries.data.flow_details.issuing_authorization.transactions.merchant_data.city(string, nullable) City where the seller is locatedentries.data.flow_details.issuing_authorization.transactions.merchant_data.country(string, nullable) Country where the seller is locatedentries.data.flow_details.issuing_authorization.transactions.merchant_data.name(string, nullable) Name of the sellerentries.data.flow_details.issuing_authorization.transactions.merchant_data.network_id(string) Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.entries.data.flow_details.issuing_authorization.transactions.merchant_data.postal_code(string, nullable) Postal code where the seller is locatedentries.data.flow_details.issuing_authorization.transactions.merchant_data.state(string, nullable) State where the seller is locatedentries.data.flow_details.issuing_authorization.transactions.merchant_data.tax_id(string, nullable) The seller’s tax identification number. Currently populated for French merchants only.entries.data.flow_details.issuing_authorization.transactions.merchant_data.terminal_id(string, nullable) An ID assigned by the seller to the location of the sale.entries.data.flow_details.issuing_authorization.transactions.merchant_data.url(string, nullable) URL provided by the merchant on a 3DS request
entries.data.flow_details.issuing_authorization.transactions.metadata(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.entries.data.flow_details.issuing_authorization.transactions.network_data(object, nullable) Details about the transaction, such as processing dates, set by the card network.entries.data.flow_details.issuing_authorization.transactions.network_data.authorization_code(string, nullable) 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.entries.data.flow_details.issuing_authorization.transactions.network_data.processing_date(string, nullable) 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.entries.data.flow_details.issuing_authorization.transactions.network_data.transaction_id(string, nullable) Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
entries.data.flow_details.issuing_authorization.transactions.purchase_details(object, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) Additional purchase information that is optionally provided by the merchant.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet(object, nullable) Fleet-specific information for transactions using Fleet cards.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data(object, nullable) Answers to prompts presented to cardholder at point of sale.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.driver_id(string, nullable) Driver ID.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.odometer(integer, nullable) Odometer reading.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.unspecified_id(string, nullable) 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.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.user_id(string, nullable) User ID.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.vehicle_number(string, nullable) Vehicle number.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.purchase_type(string, nullable) The type of purchase. One offuel_purchase,non_fuel_purchase, orfuel_and_non_fuel_purchase.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown(object, nullable) More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.fuel(object, nullable) Breakdown of fuel portion of the purchase.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal(decimal string, nullable) Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.non_fuel(object, nullable) Breakdown of non-fuel portion of the purchase.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal(decimal string, nullable) Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.tax(object, nullable) Information about tax included in this transaction.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.tax.local_amount_decimal(decimal string, nullable) Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.tax.national_amount_decimal(decimal string, nullable) Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.fleet.service_type(string, nullable) The type of fuel service. One ofnon_fuel_transaction,full_service, orself_service.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight(object, nullable) Information about the flight that was purchased with this transaction.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.departure_at(integer, nullable) The time that the flight departed.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.passenger_name(string, nullable) The name of the passenger.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.refundable(boolean, nullable) Whether the ticket is refundable.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.segments(array of objects, nullable) The legs of the trip.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.arrival_airport_code(string, nullable) The three-letter IATA airport code of the flight’s destination.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.carrier(string, nullable) The airline carrier code.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.departure_airport_code(string, nullable) The three-letter IATA airport code that the flight departed from.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.flight_number(string, nullable) The flight number.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.service_class(string, nullable) The flight’s service class.entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.stopover_allowed(boolean, nullable) Whether a stopover is allowed on this flight.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.flight.travel_agency(string, nullable) The travel agency that issued the ticket.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.fuel(object, nullable) Information about fuel that was purchased with this transaction.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fuel.industry_product_code(string, nullable) Conexxus Payment System Product Code identifying the primary fuel product purchased.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fuel.quantity_decimal(decimal string, nullable) The quantity ofunits of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fuel.type(string) The type of fuel that was purchased. One ofdiesel,unleaded_plus,unleaded_regular,unleaded_super, orother.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fuel.unit(string) The units forquantity_decimal. One ofcharging_minute,imperial_gallon,kilogram,kilowatt_hour,liter,pound,us_gallon, orother.entries.data.flow_details.issuing_authorization.transactions.purchase_details.fuel.unit_cost_decimal(decimal string) The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.lodging(object, nullable) Information about lodging that was purchased with this transaction.entries.data.flow_details.issuing_authorization.transactions.purchase_details.lodging.check_in_at(integer, nullable) The time of checking into the lodging.entries.data.flow_details.issuing_authorization.transactions.purchase_details.lodging.nights(integer, nullable) The number of nights stayed at the lodging.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.receipt(array of objects, nullable) The line items in the purchase.entries.data.flow_details.issuing_authorization.transactions.purchase_details.receipt.description(string, nullable) The description of the item. The maximum length of this field is 26 characters.entries.data.flow_details.issuing_authorization.transactions.purchase_details.receipt.quantity(float, nullable) The quantity of the item.entries.data.flow_details.issuing_authorization.transactions.purchase_details.receipt.total(integer, nullable) The total for this line item in cents.entries.data.flow_details.issuing_authorization.transactions.purchase_details.receipt.unit_cost(integer, nullable) The unit cost of the item in cents.
entries.data.flow_details.issuing_authorization.transactions.purchase_details.reference(string, nullable) A merchant-specific order number.
entries.data.flow_details.issuing_authorization.transactions.token(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) Token object used for this transaction. If a network token was not used for this transaction, this field will be null.entries.data.flow_details.issuing_authorization.transactions.type(enum) The nature of the transaction. Possible enum values:captureFunds were captured by the acquirer.amountwill 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.refundAn acquirer initiated a refund. This transaction might not be linked to an original capture, for example credits are original transactions.amountwill be positive for refunds and negative for refund reversals. Refund reversals occur when a previous refund needs to be reversed, typically due to duplicate refunds. Learn more about refund reversals.
entries.data.flow_details.issuing_authorization.transactions.wallet(enum, nullable) The digital wallet used for this transaction. One ofapple_pay,google_pay, orsamsung_pay.
entries.data.flow_details.issuing_authorization.verification_data(object) Verifications that Stripe performed on information that the cardholder provided to the merchant.entries.data.flow_details.issuing_authorization.verification_data.address_line1_check(enum) Whether the cardholder provided an address first line and if it matched the cardholder’sbilling.address.line1. Possible enum values:matchVerification succeeded, values matched.mismatchVerification failed, values didn’t match.not_providedVerification was not performed because no value was provided.
entries.data.flow_details.issuing_authorization.verification_data.address_postal_code_check(enum) Whether the cardholder provided a postal code and if it matched the cardholder’sbilling.address.postal_code. Possible enum values:matchVerification succeeded, values matched.mismatchVerification failed, values didn’t match.not_providedVerification was not performed because no value was provided.
entries.data.flow_details.issuing_authorization.verification_data.authentication_exemption(object, nullable) The exemption applied to this authorization.entries.data.flow_details.issuing_authorization.verification_data.authentication_exemption.claimed_by(enum) The entity that requested the exemption, either the acquiring merchant or the Issuing user. Possible enum values:acquirerAcquiring merchant.issuerIssuing user.
entries.data.flow_details.issuing_authorization.verification_data.authentication_exemption.type(enum) The specific exemption claimed for this authorization. Possible enum values:low_value_transactionSpecifies an exemption for some low-value authorizations.transaction_risk_analysisSpecifies an exemption for low-risk authorizations, determined using real-time risk analysis.unknownSpecifies an unknown exemption type.
entries.data.flow_details.issuing_authorization.verification_data.cvc_check(enum) Whether the cardholder provided a CVC and if it matched Stripe’s record. Possible enum values:matchVerification succeeded, values matched.mismatchVerification failed, values didn’t match.not_providedVerification was not performed because no value was provided.
entries.data.flow_details.issuing_authorization.verification_data.expiry_check(enum) Whether the cardholder provided an expiry date and if it matched Stripe’s record. Possible enum values:matchVerification succeeded, values matched.mismatchVerification failed, values didn’t match.not_providedVerification was not performed because no value was provided.
entries.data.flow_details.issuing_authorization.verification_data.postal_code(string, nullable) The postal code submitted as part of the authorization used for postal code verification.entries.data.flow_details.issuing_authorization.verification_data.three_d_secure(object, nullable) 3D Secure details.entries.data.flow_details.issuing_authorization.verification_data.three_d_secure.result(enum) The outcome of the 3D Secure authentication request. Possible enum values:attempt_acknowledgedThe merchant attempted to authenticate the authorization, but the cardholder is not enrolled or was unable to reach Stripe.authenticatedAuthentication successful.failedAuthentication failed.requiredThe 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.
entries.data.flow_details.issuing_authorization.verified_by_fraud_challenge(boolean, nullable) 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.entries.data.flow_details.issuing_authorization.wallet(string, nullable) The digital wallet used for this transaction. One ofapple_pay,google_pay, orsamsung_pay. Will populate asnullwhen no digital wallet was utilized.
entries.data.flow_details.outbound_payment(object, nullable) The OutboundPayment object associated with the Transaction. Set iftype=outbound_payment.entries.data.flow_details.outbound_payment.id(string) Unique identifier for the object.entries.data.flow_details.outbound_payment.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.outbound_payment.amount(integer) Amount (in cents) transferred.entries.data.flow_details.outbound_payment.cancelable(boolean) Returnstrueif the object can be canceled, andfalseotherwise.entries.data.flow_details.outbound_payment.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.outbound_payment.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.outbound_payment.customer(string, nullable) ID of the customer to whom an OutboundPayment is sent.entries.data.flow_details.outbound_payment.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.outbound_payment.destination_payment_method(string, nullable) The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created usingdestination_payment_method_data.entries.data.flow_details.outbound_payment.destination_payment_method_details(object, nullable) Details about the PaymentMethod for an OutboundPayment.entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details(object) Contact details for the person or business receiving the OutboundPayment.entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details.address(object) Billing address.entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details.email(string, nullable) Email address.entries.data.flow_details.outbound_payment.destination_payment_method_details.billing_details.name(string, nullable) Full name.
entries.data.flow_details.outbound_payment.destination_payment_method_details.financial_account(object, nullable) Details about thefinancial_account.entries.data.flow_details.outbound_payment.destination_payment_method_details.financial_account.id(string) Token of the FinancialAccount.entries.data.flow_details.outbound_payment.destination_payment_method_details.financial_account.network(enum) The rails used to send funds.
entries.data.flow_details.outbound_payment.destination_payment_method_details.type(enum) The type of the payment method used in the OutboundPayment. Possible enum values:financial_accountus_bank_account
entries.data.flow_details.outbound_payment.destination_payment_method_details.us_bank_account(object, nullable) Details about theus_bank_account.entries.data.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
entries.data.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
entries.data.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.bank_name(string, nullable) Name of the bank associated with the bank account.entries.data.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.entries.data.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.last4(string, nullable) Last four digits of the bank account number.entries.data.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the mandate used to make this payment.entries.data.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.network(enum) The network rails used. See the docs to learn more about money movement timelines for each network type. Possible enum values:achACH networkus_domestic_wireUS domestic wire network
entries.data.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.routing_number(string, nullable) Routing number of the bank account.
entries.data.flow_details.outbound_payment.end_user_details(object, nullable) Details about the end user.entries.data.flow_details.outbound_payment.end_user_details.ip_address(string, nullable) IP address of the user initiating the OutboundPayment. Set ifpresentis set totrue. 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.entries.data.flow_details.outbound_payment.end_user_details.present(boolean)trueif the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise,false.
entries.data.flow_details.outbound_payment.expected_arrival_date(timestamp) The date when funds are expected to arrive in the destination account.entries.data.flow_details.outbound_payment.financial_account(string) The FinancialAccount that funds were pulled from.entries.data.flow_details.outbound_payment.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.outbound_payment.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.outbound_payment.metadata(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.entries.data.flow_details.outbound_payment.purpose(enum, nullable) The purpose of the OutboundPayment, if applicable. Possible enum values:payrollThe purpose of the OutboundPayment is payroll.
entries.data.flow_details.outbound_payment.returned_details(object, nullable) Details about a returned OutboundPayment. Only set when the status isreturned.entries.data.flow_details.outbound_payment.returned_details.code(enum) Reason for the return. Possible enum values:account_closedThe destination has been closed.account_frozenThe destination has been frozen.bank_account_restrictedThe 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_changedThe destination bank account is no longer valid because its branch has changed ownership.declinedThe destination has declined this OutboundPayment.incorrect_account_holder_nameThe destination bank notified us that the bank account holder name on file is incorrect.invalid_account_numberThe destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe destination was unable to process this OutboundPayment because of its currency.no_accountThe destination bank account details on file are probably incorrect. No bank account exists with these details.otherThe destination could not process this OutboundPayment.
entries.data.flow_details.outbound_payment.returned_details.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.outbound_payment.statement_descriptor(string) The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).entries.data.flow_details.outbound_payment.status(enum) Current status of the OutboundPayment:processing,failed,posted,returned,canceled. An OutboundPayment isprocessingif it has been created and is pending. The status changes topostedonce the OutboundPayment has been “confirmed” and funds have left the account, or tofailedorcanceled. If an OutboundPayment fails to arrive at its destination, its status will change toreturned.entries.data.flow_details.outbound_payment.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.entries.data.flow_details.outbound_payment.status_transitions.canceled_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status tocanceled.entries.data.flow_details.outbound_payment.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status tofailed.entries.data.flow_details.outbound_payment.status_transitions.posted_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status toposted.entries.data.flow_details.outbound_payment.status_transitions.returned_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status toreturned.
entries.data.flow_details.outbound_payment.tracking_details(object, nullable) Details about network-specific tracking information if available.entries.data.flow_details.outbound_payment.tracking_details.ach(object, nullable) ACH network tracking details.entries.data.flow_details.outbound_payment.tracking_details.ach.trace_id(string) ACH trace ID of the OutboundPayment for payments sent over theachnetwork.
entries.data.flow_details.outbound_payment.tracking_details.type(enum) The US bank account network used to send funds. Possible enum values:achus_domestic_wire
entries.data.flow_details.outbound_payment.tracking_details.us_domestic_wire(object, nullable) US domestic wire network tracking details.entries.data.flow_details.outbound_payment.tracking_details.us_domestic_wire.chips(string, nullable) CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over theus_domestic_wirenetwork.entries.data.flow_details.outbound_payment.tracking_details.us_domestic_wire.imad(string, nullable) IMAD of the OutboundPayment for payments sent over theus_domestic_wirenetwork.entries.data.flow_details.outbound_payment.tracking_details.us_domestic_wire.omad(string, nullable) OMAD of the OutboundPayment for payments sent over theus_domestic_wirenetwork.
entries.data.flow_details.outbound_payment.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.outbound_transfer(object, nullable) The OutboundTransfer object associated with the Transaction. Set iftype=outbound_transfer.entries.data.flow_details.outbound_transfer.id(string) Unique identifier for the object.entries.data.flow_details.outbound_transfer.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.outbound_transfer.amount(integer) Amount (in cents) transferred.entries.data.flow_details.outbound_transfer.cancelable(boolean) Returnstrueif the object can be canceled, andfalseotherwise.entries.data.flow_details.outbound_transfer.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.outbound_transfer.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.outbound_transfer.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.outbound_transfer.destination_payment_method(string, nullable) The PaymentMethod used as the payment instrument for an OutboundTransfer.entries.data.flow_details.outbound_transfer.destination_payment_method_details(object) Details about the PaymentMethod for an OutboundTransferentries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details(object) Contact details for the person or business receiving the OutboundTransfer.entries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address(object) Billing address.entries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details.email(string, nullable) Email address.entries.data.flow_details.outbound_transfer.destination_payment_method_details.billing_details.name(string, nullable) Full name.
entries.data.flow_details.outbound_transfer.destination_payment_method_details.financial_account(object, nullable) Details about thefinancial_account.entries.data.flow_details.outbound_transfer.destination_payment_method_details.financial_account.id(string) Token of the FinancialAccount.entries.data.flow_details.outbound_transfer.destination_payment_method_details.financial_account.network(enum) The rails used to send funds.
entries.data.flow_details.outbound_transfer.destination_payment_method_details.type(enum) The type of the payment method used in the OutboundTransfer.entries.data.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account(object, nullable) Details about theus_bank_account.entries.data.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
entries.data.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
entries.data.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.bank_name(string, nullable) Name of the bank associated with the bank account.entries.data.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.entries.data.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.last4(string, nullable) Last four digits of the bank account number.entries.data.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the mandate used to make this payment.entries.data.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.network(enum) The network rails used. See the docs to learn more about money movement timelines for each network type. Possible enum values:achACH networkus_domestic_wireUS domestic wire network
entries.data.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.routing_number(string, nullable) Routing number of the bank account.
entries.data.flow_details.outbound_transfer.expected_arrival_date(timestamp) The date when funds are expected to arrive in the destination account.entries.data.flow_details.outbound_transfer.financial_account(string) The FinancialAccount that funds were pulled from.entries.data.flow_details.outbound_transfer.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.outbound_transfer.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.outbound_transfer.metadata(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.entries.data.flow_details.outbound_transfer.returned_details(object, nullable) Details about a returned OutboundTransfer. Only set when the status isreturned.entries.data.flow_details.outbound_transfer.returned_details.code(enum) Reason for the return. Possible enum values:account_closedThe destination has been closed.account_frozenThe destination has been frozen.bank_account_restrictedThe 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_changedThe destination bank account is no longer valid because its branch has changed ownership.declinedThe destination has declined this OutboundTransfer.incorrect_account_holder_nameThe destination bank notified us that the bank account holder name on file is incorrect.invalid_account_numberThe destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe destination was unable to process this OutboundTransfer because of its currency.no_accountThe destination bank account details on file are probably incorrect. No bank account exists with these details.otherThe destination could not process this OutboundTransfer.
entries.data.flow_details.outbound_transfer.returned_details.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.outbound_transfer.statement_descriptor(string) Information about the OutboundTransfer to be sent to the recipient account.entries.data.flow_details.outbound_transfer.status(enum) Current status of the OutboundTransfer:processing,failed,canceled,posted,returned. An OutboundTransfer isprocessingif it has been created and is pending. The status changes topostedonce the OutboundTransfer has been “confirmed” and funds have left the account, or tofailedorcanceled. If an OutboundTransfer fails to arrive at its destination, its status will change toreturned.entries.data.flow_details.outbound_transfer.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.entries.data.flow_details.outbound_transfer.status_transitions.canceled_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status tocanceledentries.data.flow_details.outbound_transfer.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status tofailedentries.data.flow_details.outbound_transfer.status_transitions.posted_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status topostedentries.data.flow_details.outbound_transfer.status_transitions.returned_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status toreturned
entries.data.flow_details.outbound_transfer.tracking_details(object, nullable) Details about network-specific tracking information if available.entries.data.flow_details.outbound_transfer.tracking_details.ach(object, nullable) ACH network tracking details.entries.data.flow_details.outbound_transfer.tracking_details.ach.trace_id(string) ACH trace ID of the OutboundTransfer for transfers sent over theachnetwork.
entries.data.flow_details.outbound_transfer.tracking_details.type(enum) The US bank account network used to send funds. Possible enum values:achus_domestic_wire
entries.data.flow_details.outbound_transfer.tracking_details.us_domestic_wire(object, nullable) US domestic wire network tracking details.entries.data.flow_details.outbound_transfer.tracking_details.us_domestic_wire.chips(string, nullable) CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.entries.data.flow_details.outbound_transfer.tracking_details.us_domestic_wire.imad(string, nullable) IMAD of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.entries.data.flow_details.outbound_transfer.tracking_details.us_domestic_wire.omad(string, nullable) OMAD of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.
entries.data.flow_details.outbound_transfer.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.received_credit(object, nullable) The ReceivedCredit object associated with the Transaction. Set iftype=received_credit.entries.data.flow_details.received_credit.id(string) Unique identifier for the object.entries.data.flow_details.received_credit.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.received_credit.amount(integer) Amount (in cents) transferred.entries.data.flow_details.received_credit.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.received_credit.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.received_credit.description(string) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.received_credit.failure_code(enum, nullable) Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. Possible enum values:account_closedFunds can’t be sent to a closed FinancialAccount.account_frozenFunds can’t be sent to a frozen FinancialAccount.international_transactionInternational transactions can’t be sent to FinancialAccount.otherFunds can’t be sent to FinancialAccount for other reasons.
entries.data.flow_details.received_credit.financial_account(string, nullable) The FinancialAccount that received the funds.entries.data.flow_details.received_credit.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.received_credit.initiating_payment_method_details(object) Details about the PaymentMethod used to send a ReceivedCredit.entries.data.flow_details.received_credit.initiating_payment_method_details.balance(enum, nullable) Set whentypeisbalance. Possible enum values:paymentsThe Stripe payments balance.
entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details(object) The contact details of the person or business referenced by the received payment method details.entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details.address(object) Billing address.entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details.email(string, nullable) Email address.entries.data.flow_details.received_credit.initiating_payment_method_details.billing_details.name(string, nullable) Full name.
entries.data.flow_details.received_credit.initiating_payment_method_details.financial_account(object, nullable) Set whentypeisfinancial_account. This is a FinancialAccount ID.entries.data.flow_details.received_credit.initiating_payment_method_details.financial_account.id(string) The FinancialAccount ID.entries.data.flow_details.received_credit.initiating_payment_method_details.financial_account.network(enum) The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds overstripe.
entries.data.flow_details.received_credit.initiating_payment_method_details.issuing_card(string, nullable) Set whentypeisissuing_card. This is an Issuing Card ID.entries.data.flow_details.received_credit.initiating_payment_method_details.type(enum) Polymorphic type matching the originating money movement’s source. This can be an external account, a Stripe balance, or a FinancialAccount.entries.data.flow_details.received_credit.initiating_payment_method_details.us_bank_account(object, nullable) Set whentypeisus_bank_account.entries.data.flow_details.received_credit.initiating_payment_method_details.us_bank_account.bank_name(string, nullable) Bank name.entries.data.flow_details.received_credit.initiating_payment_method_details.us_bank_account.last4(string, nullable) The last four digits of the bank account number.entries.data.flow_details.received_credit.initiating_payment_method_details.us_bank_account.routing_number(string, nullable) The routing number for the bank account.
entries.data.flow_details.received_credit.linked_flows(object) Other flows linked to a ReceivedCredit.entries.data.flow_details.received_credit.linked_flows.credit_reversal(string, nullable) The CreditReversal created as a result of this ReceivedCredit being reversed.entries.data.flow_details.received_credit.linked_flows.issuing_authorization(string, nullable) Set if the ReceivedCredit was created due to an Issuing Authorization object.entries.data.flow_details.received_credit.linked_flows.issuing_transaction(string, nullable) Set if the ReceivedCredit is also viewable as an Issuing transaction object.entries.data.flow_details.received_credit.linked_flows.source_flow(string, nullable) ID of the source flow. Set ifnetworkisstripeand the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.entries.data.flow_details.received_credit.linked_flows.source_flow_details(object, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The expandable object of the source flow.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal(object, nullable) Details about a CreditReversal.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.id(string) Unique identifier for the object.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.amount(integer) Amount (in cents) transferred.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.financial_account(string) The FinancialAccount to reverse funds from.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.metadata(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.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.network(enum) The rails used to reverse the funds.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.received_credit(string) The ReceivedCredit being reversed.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.status(enum) Status of the CreditReversal Possible enum values:canceledThe CreditReversal has been canceled before it has been sent to the network and no funds have left the account. (Currently not supported).postedThe CreditReversal has been sent to the network and funds have left the account (with the Transaction posting)processingThe CreditReversal starting state. Funds are “held” by a pending Transaction (but they are still part of the current balance).
entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.status_transitions.posted_at(timestamp, nullable) Timestamp describing when the CreditReversal changed status toposted
entries.data.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment(object, nullable) Details about an OutboundPayment.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.id(string) Unique identifier for the object.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.amount(integer) Amount (in cents) transferred.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.cancelable(boolean) Returnstrueif the object can be canceled, andfalseotherwise.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.customer(string, nullable) ID of the customer to whom an OutboundPayment is sent.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method(string, nullable) The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created usingdestination_payment_method_data.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details(object, nullable) Details about the PaymentMethod for an OutboundPayment.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details(object) Contact details for the person or business receiving the OutboundPayment.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address(object) Billing address.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.email(string, nullable) Email address.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.name(string, nullable) Full name.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_account(object, nullable) Details about thefinancial_account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_account.id(string) Token of the FinancialAccount.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_account.network(enum) The rails used to send funds.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.type(enum) The type of the payment method used in the OutboundPayment. Possible enum values:financial_accountus_bank_account
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account(object, nullable) Details about theus_bank_account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.bank_name(string, nullable) Name of the bank associated with the bank account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.last4(string, nullable) Last four digits of the bank account number.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the mandate used to make this payment.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.network(enum) The network rails used. See the docs to learn more about money movement timelines for each network type. Possible enum values:achACH networkus_domestic_wireUS domestic wire network
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.routing_number(string, nullable) Routing number of the bank account.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.end_user_details(object, nullable) Details about the end user.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.end_user_details.ip_address(string, nullable) IP address of the user initiating the OutboundPayment. Set ifpresentis set totrue. 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.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.end_user_details.present(boolean)trueif the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise,false.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.expected_arrival_date(timestamp) The date when funds are expected to arrive in the destination account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.financial_account(string) The FinancialAccount that funds were pulled from.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.metadata(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.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.purpose(enum, nullable) The purpose of the OutboundPayment, if applicable. Possible enum values:payrollThe purpose of the OutboundPayment is payroll.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.returned_details(object, nullable) Details about a returned OutboundPayment. Only set when the status isreturned.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.returned_details.code(enum) Reason for the return. Possible enum values:account_closedThe destination has been closed.account_frozenThe destination has been frozen.bank_account_restrictedThe 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_changedThe destination bank account is no longer valid because its branch has changed ownership.declinedThe destination has declined this OutboundPayment.incorrect_account_holder_nameThe destination bank notified us that the bank account holder name on file is incorrect.invalid_account_numberThe destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe destination was unable to process this OutboundPayment because of its currency.no_accountThe destination bank account details on file are probably incorrect. No bank account exists with these details.otherThe destination could not process this OutboundPayment.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.returned_details.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.statement_descriptor(string) The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status(enum) Current status of the OutboundPayment:processing,failed,posted,returned,canceled. An OutboundPayment isprocessingif it has been created and is pending. The status changes topostedonce the OutboundPayment has been “confirmed” and funds have left the account, or tofailedorcanceled. If an OutboundPayment fails to arrive at its destination, its status will change toreturned.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.canceled_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status tocanceled.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status tofailed.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.posted_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status toposted.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.returned_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status toreturned.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details(object, nullable) Details about network-specific tracking information if available.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.ach(object, nullable) ACH network tracking details.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.ach.trace_id(string) ACH trace ID of the OutboundPayment for payments sent over theachnetwork.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.type(enum) The US bank account network used to send funds. Possible enum values:achus_domestic_wire
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire(object, nullable) US domestic wire network tracking details.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire.chips(string, nullable) CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over theus_domestic_wirenetwork.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire.imad(string, nullable) IMAD of the OutboundPayment for payments sent over theus_domestic_wirenetwork.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire.omad(string, nullable) OMAD of the OutboundPayment for payments sent over theus_domestic_wirenetwork.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer(object, nullable) Details about an OutboundTransfer.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.id(string) Unique identifier for the object.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.amount(integer) Amount (in cents) transferred.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.cancelable(boolean) Returnstrueif the object can be canceled, andfalseotherwise.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method(string, nullable) The PaymentMethod used as the payment instrument for an OutboundTransfer.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details(object) Details about the PaymentMethod for an OutboundTransferentries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details(object) Contact details for the person or business receiving the OutboundTransfer.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address(object) Billing address.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.email(string, nullable) Email address.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.name(string, nullable) Full name.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.financial_account(object, nullable) Details about thefinancial_account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.financial_account.id(string) Token of the FinancialAccount.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.financial_account.network(enum) The rails used to send funds.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.type(enum) The type of the payment method used in the OutboundTransfer.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account(object, nullable) Details about theus_bank_account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.bank_name(string, nullable) Name of the bank associated with the bank account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.last4(string, nullable) Last four digits of the bank account number.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the mandate used to make this payment.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.network(enum) The network rails used. See the docs to learn more about money movement timelines for each network type. Possible enum values:achACH networkus_domestic_wireUS domestic wire network
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.routing_number(string, nullable) Routing number of the bank account.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.expected_arrival_date(timestamp) The date when funds are expected to arrive in the destination account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.financial_account(string) The FinancialAccount that funds were pulled from.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.metadata(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.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.returned_details(object, nullable) Details about a returned OutboundTransfer. Only set when the status isreturned.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.returned_details.code(enum) Reason for the return. Possible enum values:account_closedThe destination has been closed.account_frozenThe destination has been frozen.bank_account_restrictedThe 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_changedThe destination bank account is no longer valid because its branch has changed ownership.declinedThe destination has declined this OutboundTransfer.incorrect_account_holder_nameThe destination bank notified us that the bank account holder name on file is incorrect.invalid_account_numberThe destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe destination was unable to process this OutboundTransfer because of its currency.no_accountThe destination bank account details on file are probably incorrect. No bank account exists with these details.otherThe destination could not process this OutboundTransfer.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.returned_details.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.statement_descriptor(string) Information about the OutboundTransfer to be sent to the recipient account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status(enum) Current status of the OutboundTransfer:processing,failed,canceled,posted,returned. An OutboundTransfer isprocessingif it has been created and is pending. The status changes topostedonce the OutboundTransfer has been “confirmed” and funds have left the account, or tofailedorcanceled. If an OutboundTransfer fails to arrive at its destination, its status will change toreturned.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.canceled_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status tocanceledentries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status tofailedentries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.posted_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status topostedentries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.returned_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status toreturned
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details(object, nullable) Details about network-specific tracking information if available.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.ach(object, nullable) ACH network tracking details.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.ach.trace_id(string) ACH trace ID of the OutboundTransfer for transfers sent over theachnetwork.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.type(enum) The US bank account network used to send funds. Possible enum values:achus_domestic_wire
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire(object, nullable) US domestic wire network tracking details.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire.chips(string, nullable) CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire.imad(string, nullable) IMAD of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire.omad(string, nullable) OMAD of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout(object, nullable) Details about a Payout.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.id(string) Unique identifier for the object.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.amount(integer) The amount (in the smallest currency unit) that transfers to your bank account or debit card.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.application_fee(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The application fee (if any) for the payout. See the Connect documentation for details.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.application_fee_amount(integer, nullable) The amount of the application fee (if any) requested for the payout. See the Connect documentation for details.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.arrival_date(timestamp) Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.automatic(boolean) Returnstrueif the payout is created by an automated payout schedule andfalseif it’s requested manually.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.balance_transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the balance transaction that describes the impact of this payout on your account balance.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.destination(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the bank account or card the payout is sent to.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.failure_balance_transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.failure_code(string, nullable) Error code that provides a reason for a payout failure, if available. View our list of failure codes.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.failure_message(string, nullable) Message that provides the reason for a payout failure, if available.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.metadata(object, nullable) 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.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.method(string) The method used to send this payout, which can bestandardorinstant.instantis supported for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.original_payout(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) If the payout reverses another, this is the ID of the original payout.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.payout_method(string, nullable) ID of the v2 FinancialAccount the funds are sent to.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.reconciliation_status(enum) Ifcompleted, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout. Possible enum values:completedThe Balance Transactions paid out in this payout. You can query it with the Balance Transactions API.in_progressYou can query the Balance Transactions paid out in this payout soon.not_applicableWe don’t support listing Balance Transactions for this payout. We only support this for standard automatic payouts.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.reversed_by(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) If the payout reverses, this is the ID of the payout that reverses this payout.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.source_type(string) The source balance this payout came from, which can be one of the following:card,fpx, orbank_account.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.statement_descriptor(string, nullable) Extra information about a payout that displays on the user’s bank statement.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.status(string) Current status of the payout:paid,pending,in_transit,canceledorfailed. A payout ispendinguntil it’s submitted to the bank, when it becomesin_transit. The status changes topaidif the transaction succeeds, or tofailedorcanceled(within 5 business days). Some payouts that fail might initially show aspaid, then change tofailed.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.trace_id(object, nullable) 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.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.trace_id.status(string) Possible values arepending,supported, andunsupported. Whenpayout.statusispendingorin_transit, this will bepending. When the payout transitions topaid,failed, orcanceled, this status will becomesupportedorunsupportedshortly after in most cases. In some cases, this may appear aspendingfor up to 10 days afterarrival_dateuntil transitioning tosupportedorunsupported.entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.trace_id.value(string, nullable) The trace ID value iftrace_id.statusissupported, otherwisenil.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.payout.type(enum) Can bebank_accountorcard.
entries.data.flow_details.received_credit.linked_flows.source_flow_details.type(enum) The type of the source flow that originated the ReceivedCredit. Possible enum values:credit_reversalReceivedCredits that were reversed and have associated CreditReversals.otherReceivedCredits created from other source flow.outbound_paymentReceivedCredits created from OutboundPayments.outbound_transferReceivedCredits created from OutboundPayments.payoutReceivedCredits created from Payouts.
entries.data.flow_details.received_credit.linked_flows.source_flow_type(string, nullable) The type of flow that originated the ReceivedCredit (for example,outbound_payment).
entries.data.flow_details.received_credit.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.received_credit.network(enum) The rails used to send the funds. Possible enum values:achcardstripeus_domestic_wire
entries.data.flow_details.received_credit.reversal_details(object, nullable) Details describing when a ReceivedCredit may be reversed.entries.data.flow_details.received_credit.reversal_details.deadline(timestamp, nullable) Time before which a ReceivedCredit can be reversed.entries.data.flow_details.received_credit.reversal_details.restricted_reason(enum, nullable) Set if a ReceivedCredit cannot be reversed. Possible enum values:already_reversedA ReceivedCredit that’s already reversed has thisrestricted_reason. It may have a deadline populated in some cases.deadline_passedA ReceivedCredit which used to be reversible until the timestamp indeadline, but is no longer reversible. ACH ReceivedCredits are only reversible for some time after they’re created.network_restrictedNetwork constraints prevent Stripe from allowing reversal on some ReceivedCredits, such as a ReceivedCredit from a wire transfer.otherA ReceivedCredit that was reversed because of another reason.source_flow_restrictedStripe restricts users from reversing a Stripe network ReceivedCredit.
entries.data.flow_details.received_credit.status(enum) Status of the ReceivedCredit. ReceivedCredits are created eithersucceeded(approved) orfailed(declined). If a ReceivedCredit is declined, the failure reason can be found in thefailure_codefield. Possible enum values:failedThe ReceivedCredit was declined, and no Transaction was created.succeededThe ReceivedCredit was approved.
entries.data.flow_details.received_credit.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.received_debit(object, nullable) The ReceivedDebit object associated with the Transaction. Set iftype=received_debit.entries.data.flow_details.received_debit.id(string) Unique identifier for the object.entries.data.flow_details.received_debit.object(string) String representing the object’s type. Objects of the same type share the same value.entries.data.flow_details.received_debit.amount(integer) Amount (in cents) transferred.entries.data.flow_details.received_debit.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.entries.data.flow_details.received_debit.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.entries.data.flow_details.received_debit.description(string) An arbitrary string attached to the object. Often useful for displaying to users.entries.data.flow_details.received_debit.failure_code(enum, nullable) 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_closedFunds can’t be pulled from a closed FinancialAccount.account_frozenFunds can’t be pulled from a frozen FinancialAccount.insufficient_fundsThe FinancialAccount doesn’t have a sufficient balance.international_transactionInternational transactions can’t pull funds from the FinancialAccount.otherFunds can’t be pulled from the FinancialAccount for other reasons.
entries.data.flow_details.received_debit.financial_account(string, nullable) The FinancialAccount that funds were pulled from.entries.data.flow_details.received_debit.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.entries.data.flow_details.received_debit.initiating_payment_method_details(object) Details about how a ReceivedDebit was created.entries.data.flow_details.received_debit.initiating_payment_method_details.balance(enum, nullable) Set whentypeisbalance. Possible enum values:paymentsThe Stripe payments balance.
entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details(object) The contact details of the person or business referenced by the received payment method details.entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details.address(object) Billing address.entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details.email(string, nullable) Email address.entries.data.flow_details.received_debit.initiating_payment_method_details.billing_details.name(string, nullable) Full name.
entries.data.flow_details.received_debit.initiating_payment_method_details.financial_account(object, nullable) Set whentypeisfinancial_account. This is a FinancialAccount ID.entries.data.flow_details.received_debit.initiating_payment_method_details.financial_account.id(string) The FinancialAccount ID.entries.data.flow_details.received_debit.initiating_payment_method_details.financial_account.network(enum) The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds overstripe.
entries.data.flow_details.received_debit.initiating_payment_method_details.issuing_card(string, nullable) Set whentypeisissuing_card. This is an Issuing Card ID.entries.data.flow_details.received_debit.initiating_payment_method_details.type(enum) Polymorphic type matching the originating money movement’s source. This can be an external account, a Stripe balance, or a FinancialAccount.entries.data.flow_details.received_debit.initiating_payment_method_details.us_bank_account(object, nullable) Set whentypeisus_bank_account.entries.data.flow_details.received_debit.initiating_payment_method_details.us_bank_account.bank_name(string, nullable) Bank name.entries.data.flow_details.received_debit.initiating_payment_method_details.us_bank_account.last4(string, nullable) The last four digits of the bank account number.entries.data.flow_details.received_debit.initiating_payment_method_details.us_bank_account.routing_number(string, nullable) The routing number for the bank account.
entries.data.flow_details.received_debit.linked_flows(object) Other flows linked to a ReceivedDebit.entries.data.flow_details.received_debit.linked_flows.debit_reversal(string, nullable) The DebitReversal created as a result of this ReceivedDebit being reversed.entries.data.flow_details.received_debit.linked_flows.inbound_transfer(string, nullable) Set if the ReceivedDebit is associated with an InboundTransfer’s return of funds.entries.data.flow_details.received_debit.linked_flows.issuing_authorization(string, nullable) Set if the ReceivedDebit was created due to an Issuing Authorization object.entries.data.flow_details.received_debit.linked_flows.issuing_transaction(string, nullable) Set if the ReceivedDebit is also viewable as an Issuing Dispute object.entries.data.flow_details.received_debit.linked_flows.payout(string, nullable) Set if the ReceivedDebit was created due to a Payout object.entries.data.flow_details.received_debit.linked_flows.topup(string, nullable) Set if the ReceivedDebit was created due to a Topup object.
entries.data.flow_details.received_debit.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.flow_details.received_debit.network(enum) The network used for the ReceivedDebit.entries.data.flow_details.received_debit.reversal_details(object, nullable) Details describing when a ReceivedDebit might be reversed.entries.data.flow_details.received_debit.reversal_details.deadline(timestamp, nullable) Time before which a ReceivedDebit can be reversed.entries.data.flow_details.received_debit.reversal_details.restricted_reason(enum, nullable) Set if a ReceivedDebit can’t be reversed. Possible enum values:already_reversedA ReceivedDebit that’s already reversed has thisrestricted_reason. It may have adeadlinepopulated.deadline_passedA ReceivedDebit that used to be reversible until the timestamp indeadline, but is no longer reversible. ACH ReceivedDebits are only reversible for some time after they’re created.network_restrictedNetwork constraints prevent Stripe from allowing reversal on some ReceivedDebits.otherA ReceivedDebit that was reversed because of another reason.source_flow_restrictedA ReceivedDebit that can’t be reversed because itssource_flowis not reversible.
entries.data.flow_details.received_debit.status(enum) Status of the ReceivedDebit. ReceivedDebits are created with a status of eithersucceeded(approved) orfailed(declined). The failure reason can be found under thefailure_code. Possible enum values:failedThe ReceivedDebit was declined, and no Transaction was created.succeededThe ReceivedDebit was approved.
entries.data.flow_details.received_debit.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
entries.data.flow_details.type(enum) Type of the flow that created the Transaction. Set to the same value asflow_type. Possible enum values:credit_reversalThe Transaction is associated with a CreditReversal.debit_reversalThe Transaction is associated with a DebitReversal.inbound_transferThe Transaction is associated with an InboundTransfer.issuing_authorizationThe Transaction is associated with an Issuing authorization.otherThe Transaction is associated with some other money movement not listed above.outbound_paymentThe Transaction is associated with an OutboundPayment.outbound_transferThe Transaction is associated with an OutboundTransfer.received_creditThe Transaction is associated with a ReceivedCredit.received_debitThe Transaction is associated with a ReceivedDebit.
entries.data.flow_type(enum) Type of the flow associated with the TransactionEntry. Possible enum values:credit_reversalThe Transaction is associated with a CreditReversal.debit_reversalThe Transaction is associated with a DebitReversal.inbound_transferThe Transaction is associated with an InboundTransfer.issuing_authorizationThe Transaction is associated with an Issuing authorization.otherThe Transaction is associated with some other money movement not listed above.outbound_paymentThe Transaction is associated with an OutboundPayment.outbound_transferThe Transaction is associated with an OutboundTransfer.received_creditThe Transaction is associated with a ReceivedCredit.received_debitThe Transaction is associated with a ReceivedDebit.
entries.data.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.entries.data.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.entries.data.type(enum) The specific money movement that generated the TransactionEntry. Possible enum values:credit_reversalThe TransactionEntry was generated by a CreditReversal.credit_reversal_postingThe TransactionEntry was generated by a posted CreditReversal.debit_reversalThe TransactionEntry was generated by a DebitReversal.inbound_transferThe TransactionEntry was generated by an InboundTransfer.inbound_transfer_returnThe TransactionEntry was generated by an InboundTransferReturn.issuing_authorization_holdThe TransactionEntry was generated by an Issuing authorization hold.issuing_authorization_releaseThe TransactionEntry was generated by an Issuing authorization release.otherThe TransactionEntry was generated by some other money movement.outbound_paymentThe TransactionEntry was generated by an OutboundPayment.outbound_payment_cancellationThe TransactionEntry was generated by a cancelled OutboundPayment.outbound_payment_failureThe TransactionEntry was generated by a failed OutboundPayment.outbound_payment_postingThe TransactionEntry was generated by a posted OutboundPayment.outbound_payment_returnThe TransactionEntry was generated by a returned OutboundPayment.outbound_transferThe TransactionEntry was generated by an OutboundTransfer.outbound_transfer_cancellationThe TransactionEntry was generated by a canceled OutboundTransfer.outbound_transfer_failureThe TransactionEntry was generated by a failed OutboundTransfer.outbound_transfer_postingThe TransactionEntry was generated by a posted OutboundTransfer.outbound_transfer_returnThe TransactionEntry was generated by a returned OutboundTransfer.received_creditThe TransactionEntry was generated by a ReceivedCredit.received_debitThe TransactionEntry was generated by a ReceivedDebit.
entries.has_more(boolean) True if this list has another page of items after this one that can be fetched.entries.url(string) The URL where this list can be accessed.
financial_account(string) The FinancialAccount associated with this object.flow(string, nullable) ID of the flow that created the Transaction.flow_details(object, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) Details of the flow that created the Transaction.flow_details.credit_reversal(object, nullable) The CreditReversal object associated with the Transaction. Set iftype=credit_reversal.flow_details.credit_reversal.id(string) Unique identifier for the object.flow_details.credit_reversal.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.credit_reversal.amount(integer) Amount (in cents) transferred.flow_details.credit_reversal.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.credit_reversal.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.credit_reversal.financial_account(string) The FinancialAccount to reverse funds from.flow_details.credit_reversal.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.flow_details.credit_reversal.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.credit_reversal.metadata(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.credit_reversal.network(enum) The rails used to reverse the funds.flow_details.credit_reversal.received_credit(string) The ReceivedCredit being reversed.flow_details.credit_reversal.status(enum) Status of the CreditReversal Possible enum values:canceledThe CreditReversal has been canceled before it has been sent to the network and no funds have left the account. (Currently not supported).postedThe CreditReversal has been sent to the network and funds have left the account (with the Transaction posting)processingThe CreditReversal starting state. Funds are “held” by a pending Transaction (but they are still part of the current balance).
flow_details.credit_reversal.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.flow_details.credit_reversal.status_transitions.posted_at(timestamp, nullable) Timestamp describing when the CreditReversal changed status toposted
flow_details.credit_reversal.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.debit_reversal(object, nullable) The DebitReversal object associated with the Transaction. Set iftype=debit_reversal.flow_details.debit_reversal.id(string) Unique identifier for the object.flow_details.debit_reversal.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.debit_reversal.amount(integer) Amount (in cents) transferred.flow_details.debit_reversal.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.debit_reversal.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.debit_reversal.financial_account(string, nullable) The FinancialAccount to reverse funds from.flow_details.debit_reversal.hosted_regulatory_receipt_url(string, nullable) 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_flows(object, nullable) Other flows linked to a DebitReversal.flow_details.debit_reversal.linked_flows.issuing_dispute(string, nullable) Set if there is an Issuing dispute associated with the DebitReversal.
flow_details.debit_reversal.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.debit_reversal.metadata(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.debit_reversal.network(enum) The rails used to reverse the funds.flow_details.debit_reversal.received_debit(string) The ReceivedDebit being reversed.flow_details.debit_reversal.status(enum) Status of the DebitReversal Possible enum values:failedThe network has resolved the DebitReversal against the user.processingThe DebitReversal starting state.succeededThe network has resolved the DebitReversal in the users favour. A crediting Transaction is created.
flow_details.debit_reversal.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.flow_details.debit_reversal.status_transitions.completed_at(timestamp, nullable) Timestamp describing when the DebitReversal changed status tocompleted.
flow_details.debit_reversal.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.inbound_transfer(object, nullable) The InboundTransfer object associated with the Transaction. Set iftype=inbound_transfer.flow_details.inbound_transfer.id(string) Unique identifier for the object.flow_details.inbound_transfer.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.inbound_transfer.amount(integer) Amount (in cents) transferred.flow_details.inbound_transfer.cancelable(boolean) Returnstrueif the InboundTransfer is able to be canceled.flow_details.inbound_transfer.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.inbound_transfer.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.inbound_transfer.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.flow_details.inbound_transfer.failure_details(object, nullable) Details about this InboundTransfer’s failure. Only set when status isfailed.flow_details.inbound_transfer.failure_details.code(enum) Reason for the failure. Possible enum values:account_closedThe bank account has been closed.account_frozenThe bank account has been frozen.bank_account_restrictedThe 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_changedThe bank account is no longer valid because its branch has changed ownership.debit_not_authorizedDebit transactions are not approved on the bank account.incorrect_account_holder_addressThe bank notified us that the bank account holder address on file is incorrect.incorrect_account_holder_nameThe bank notified us that the bank account holder name on file is incorrect.incorrect_account_holder_tax_idThe bank notified us that the bank account holder tax ID on file is incorrect.insufficient_fundsThe bank account has insufficient funds to cover the debit transaction.invalid_account_numberThe bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe bank was unable to process this transfer because of its currency. This is probably because the bank account can’t accept payments in that currency.no_accountThe bank account details on file are probably incorrect. No bank account exists with these details.otherThe bank could not process this transfer.
flow_details.inbound_transfer.financial_account(string) The FinancialAccount that received the funds.flow_details.inbound_transfer.hosted_regulatory_receipt_url(string, nullable) 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_flows(object) Other flows linked to a InboundTransfer.flow_details.inbound_transfer.linked_flows.received_debit(string, nullable) If funds for this flow were returned after the flow went to thesucceededstate, this field contains a reference to the ReceivedDebit return.
flow_details.inbound_transfer.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.inbound_transfer.metadata(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.inbound_transfer.origin_payment_method(string, nullable) The origin payment method to be debited for an InboundTransfer.flow_details.inbound_transfer.origin_payment_method_details(object, nullable) Details about the PaymentMethod for an InboundTransfer.flow_details.inbound_transfer.origin_payment_method_details.billing_details(object) Contact details for the person or business referenced by the PaymentMethod.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address(object) Billing address.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.flow_details.inbound_transfer.origin_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.inbound_transfer.origin_payment_method_details.billing_details.email(string, nullable) Email address.flow_details.inbound_transfer.origin_payment_method_details.billing_details.name(string, nullable) Full name.
flow_details.inbound_transfer.origin_payment_method_details.type(enum) The type of the payment method used in the InboundTransfer. Possible enum values:us_bank_accountUS Bank Account
flow_details.inbound_transfer.origin_payment_method_details.us_bank_account(object, nullable) Optional fields forus_bank_account.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.bank_name(string, nullable) Name of the bank associated with the bank account.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.fingerprint(string, nullable) 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.last4(string, nullable) Last four digits of the bank account number.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the mandate used to make this payment.flow_details.inbound_transfer.origin_payment_method_details.us_bank_account.network(enum) 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_number(string, nullable) Routing number of the bank account.
flow_details.inbound_transfer.returned(boolean, nullable) Returnstrueif the funds for an InboundTransfer were returned after the InboundTransfer went to thesucceededstate.flow_details.inbound_transfer.statement_descriptor(string) Statement descriptor shown when funds are debited from the source. Not all payment networks supportstatement_descriptor.flow_details.inbound_transfer.status(enum) Status of the InboundTransfer:processing,succeeded,failed, andcanceled. An InboundTransfer isprocessingif it is created and pending. The status changes tosucceededonce the funds have been “confirmed” and atransactionis created and posted. The status changes tofailedif the transfer fails.flow_details.inbound_transfer.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.flow_details.inbound_transfer.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an InboundTransfer changed status tofailed.flow_details.inbound_transfer.status_transitions.succeeded_at(timestamp, nullable) Timestamp describing when an InboundTransfer changed status tosucceeded.
flow_details.inbound_transfer.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.issuing_authorization(object, nullable) The Issuing authorization object associated with the Transaction. Set iftype=issuing_authorization.flow_details.issuing_authorization.id(string) Unique identifier for the object.flow_details.issuing_authorization.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.issuing_authorization.amount(integer) The total amount that was authorized or rejected. This amount is incurrencyand in the smallest currency unit.amountshould be the same asmerchant_amount, unlesscurrencyandmerchant_currencyare different.flow_details.issuing_authorization.amount_details(object, nullable) Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit.flow_details.issuing_authorization.amount_details.atm_fee(integer, nullable) The fee charged by the ATM for the cash withdrawal.flow_details.issuing_authorization.amount_details.cashback_amount(integer, nullable) The amount of cash requested by the cardholder.
flow_details.issuing_authorization.approved(boolean) Whether the authorization has been approved.flow_details.issuing_authorization.authorization_method(enum) How the card details were provided. Possible enum values:chipThe card was physically present and inserted into a chip-enabled terminal. The transaction is cryptographically secured.contactlessThe card was present and tapped on a contactless-enabled terminal. If a digital wallet copy of the card was used, the wallet field will be present.keyed_inThe card number was manually entered into a terminal. Card presence is unknown and will be set to nil in testmode, but livemode values will depend on the actual card presence at the time of the transactiononlineThe card was used in a card-not-present scenario, such as a transaction initiated at an online e-commerce checkout.swipeThe card was physically present and swiped in a terminal.
flow_details.issuing_authorization.balance_transactions(array of objects) List of balance transactions associated with this authorization.flow_details.issuing_authorization.balance_transactions.id(string) Unique identifier for the object.flow_details.issuing_authorization.balance_transactions.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.issuing_authorization.balance_transactions.amount(integer) Gross amount of this transaction (in the smallest currency unit). 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_on(timestamp) The date that the transaction’s net funds become available in the Stripe balance.flow_details.issuing_authorization.balance_transactions.balance_type(enum) The balance that this transaction impacts. Possible enum values:issuingBalance Transactions that affect your Issuing balancepaymentsBalance Transactions that affect your Payments balancerefund_and_dispute_prefundingBalance Transactions that affect your Refund and Dispute Prefunding balancerisk_reservedBalance Transactions that affect your Risk Reserved balance
flow_details.issuing_authorization.balance_transactions.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.issuing_authorization.balance_transactions.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.issuing_authorization.balance_transactions.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.flow_details.issuing_authorization.balance_transactions.exchange_rate(float, nullable) If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then theamountin currency A, multipled by theexchange_rate, equals theamountin currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent’samountis1000andcurrencyiseur. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction’samountis1234, itscurrencyisusd, and theexchange_rateis1.234.flow_details.issuing_authorization.balance_transactions.fee(integer) Fees (in the smallest currency unit) paid for this transaction. Represented as a positive integer when assessed.flow_details.issuing_authorization.balance_transactions.fee_details(array of objects) Detailed breakdown of fees (in the smallest currency unit) paid for this transaction.flow_details.issuing_authorization.balance_transactions.fee_details.amount(integer) Amount of the fee, in cents.flow_details.issuing_authorization.balance_transactions.fee_details.application(string, nullable) ID of the Connect application that earned the fee.flow_details.issuing_authorization.balance_transactions.fee_details.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.issuing_authorization.balance_transactions.fee_details.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.flow_details.issuing_authorization.balance_transactions.fee_details.type(string) Type of the fee, one of:application_fee,payment_method_passthrough_fee,stripe_fee,tax, orwithheld_tax.
flow_details.issuing_authorization.balance_transactions.net(integer) Net impact to a Stripe balance (in the smallest currency unit). 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 byamount-feeflow_details.issuing_authorization.balance_transactions.reporting_category(string) Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.flow_details.issuing_authorization.balance_transactions.source(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) This transaction relates to the Stripe object.flow_details.issuing_authorization.balance_transactions.status(string) The transaction’s net funds status in the Stripe balance, which are eitheravailableorpending.flow_details.issuing_authorization.balance_transactions.type(enum) Transaction type:adjustment,advance,advance_funding,anticipation_repayment,application_fee,application_fee_refund,charge,climate_order_purchase,climate_order_refund,connect_collection_transfer,contribution,inbound_transfer,inbound_transfer_reversal,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,reserve_hold,reserve_release,stripe_fee,stripe_fx_fee,stripe_balance_payment_debit,stripe_balance_payment_debit_reversal,tax_fee,topup,topup_reversal,transfer,transfer_cancel,transfer_failure,transfer_refund, orfee_credit_funding. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, considerreporting_categoryinstead. Possible enum values:adjustmentadvanceadvance_fundinganticipation_repaymentapplication_feeapplication_fee_refundchargeclimate_order_purchaseclimate_order_refundconnect_collection_transfercontributionfee_credit_fundinginbound_transferinbound_transfer_reversalissuing_authorization_holdissuing_authorization_releaseissuing_disputeissuing_transactionobligation_outboundobligation_reversal_inboundpaymentpayment_failure_refundpayment_network_reserve_holdpayment_network_reserve_releasepayment_refundpayment_reversalpayment_unreconciledpayoutpayout_cancelpayout_failurepayout_minimum_balance_holdpayout_minimum_balance_releaserefundrefund_failurereserve_holdreserve_releasereserve_transactionreserved_fundsstripe_balance_payment_debitstripe_balance_payment_debit_reversalstripe_feestripe_fx_feetax_feetopuptopup_reversaltransfertransfer_canceltransfer_failuretransfer_refund
flow_details.issuing_authorization.card(object) Card associated with this authorization.flow_details.issuing_authorization.card.id(string) Unique identifier for the object.flow_details.issuing_authorization.card.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.issuing_authorization.card.brand(string) The brand of the card.flow_details.issuing_authorization.card.cancellation_reason(enum, nullable) The reason why the card was canceled. Possible enum values:design_rejectedThe design of this card was rejected by Stripe for violating our partner guidelines.fulfillment_errorThere was an error in fulfilling the card. This reason is only valid for cards of typephysical.lostThe card was lost.stolenThe card was stolen.
flow_details.issuing_authorization.card.cardholder(object) The Cardholder object to which the card belongs.flow_details.issuing_authorization.card.cardholder.id(string) Unique identifier for the object.flow_details.issuing_authorization.card.cardholder.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.issuing_authorization.card.cardholder.billing(object) The cardholder’s billing information.flow_details.issuing_authorization.card.cardholder.billing.address(object) The cardholder’s billing address.flow_details.issuing_authorization.card.cardholder.billing.address.city(string, nullable) City, district, suburb, town, or village.flow_details.issuing_authorization.card.cardholder.billing.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).flow_details.issuing_authorization.card.cardholder.billing.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.issuing_authorization.card.cardholder.billing.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.issuing_authorization.card.cardholder.billing.address.postal_code(string, nullable) ZIP or postal code.flow_details.issuing_authorization.card.cardholder.billing.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.issuing_authorization.card.cardholder.company(object, nullable) Additional information about acompanycardholder.flow_details.issuing_authorization.card.cardholder.company.tax_id_provided(boolean) Whether the company’s business ID number was provided.
flow_details.issuing_authorization.card.cardholder.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.issuing_authorization.card.cardholder.email(string, nullable) The cardholder’s email address.flow_details.issuing_authorization.card.cardholder.individual(object, nullable) Additional information about anindividualcardholder.flow_details.issuing_authorization.card.cardholder.individual.card_issuing(object, nullable) Information related to the card_issuing program for this cardholder.flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance(object, nullable) Information about cardholder acceptance of Celtic Authorized User Terms. Required for cards backed by a Celtic program.flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance.date(timestamp, nullable) The Unix timestamp marking when the cardholder accepted the Authorized User Terms.flow_details.issuing_authorization.card.cardholder.individual.card_issuing.user_terms_acceptance.ip(string, nullable) 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_agent(string, nullable) The user agent of the browser from which the cardholder accepted the Authorized User Terms.
flow_details.issuing_authorization.card.cardholder.individual.dob(object, nullable) The date of birth of this cardholder.flow_details.issuing_authorization.card.cardholder.individual.dob.day(integer, nullable) The day of birth, between 1 and 31.flow_details.issuing_authorization.card.cardholder.individual.dob.month(integer, nullable) The month of birth, between 1 and 12.flow_details.issuing_authorization.card.cardholder.individual.dob.year(integer, nullable) The four-digit year of birth.
flow_details.issuing_authorization.card.cardholder.individual.first_name(string, nullable) 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_name(string, nullable) 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.verification(object, nullable) Government-issued ID document for this cardholder.flow_details.issuing_authorization.card.cardholder.individual.verification.document(object, nullable) An identifying document, either a passport or local ID card.flow_details.issuing_authorization.card.cardholder.individual.verification.document.back(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The back of a document returned by a file upload with apurposevalue ofidentity_document.flow_details.issuing_authorization.card.cardholder.individual.verification.document.front(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The front of a document returned by a file upload with apurposevalue ofidentity_document.
flow_details.issuing_authorization.card.cardholder.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.issuing_authorization.card.cardholder.metadata(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.issuing_authorization.card.cardholder.name(string) The cardholder’s name. This will be printed on cards issued to them.flow_details.issuing_authorization.card.cardholder.phone_number(string, nullable) 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_locales(array of enums, nullable) The cardholder’s preferred locales (languages), ordered by preference. Locales can beda,de,en,es,fr,it,pl, orsv. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.flow_details.issuing_authorization.card.cardholder.requirements(object) Information about verification requirements for the cardholder.flow_details.issuing_authorization.card.cardholder.requirements.disabled_reason(enum, nullable) Ifdisabled_reasonis present, all cards will decline authorizations withcardholder_verification_requiredreason. Possible enum values:listedAccount might be on a prohibited persons or companies list. Thepast_duefield contains information that you need to provide before the cardholder can approve authorizations.rejected.listedCardholder is rejected because they are on a third-party prohibited persons or companies list (such as financial services provider or government). Their status will beblocked.requirements.past_dueCardholder has outstanding requirements. Thepast_duefield contains information that you need to provide before the cardholder can activate cards.under_reviewThis cardholder has raised additional review. Stripe will make a decision and update thedisabled_reasonfield.
flow_details.issuing_authorization.card.cardholder.requirements.past_due(array of enums, nullable) Array of fields that need to be collected in order to verify and re-enable the cardholder. Possible enum values:company.tax_idThe cardholder’s business number (Tax ID).individual.card_issuing.user_terms_acceptance.dateThe Unix timestamp marking when the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users.individual.card_issuing.user_terms_acceptance.ipThe IP address from which the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users.individual.dob.dayThe cardholder’s date of birth’s day.individual.dob.monthThe cardholder’s date of birth’s month.individual.dob.yearThe cardholder’s date of birth’s year.individual.first_nameThe cardholder’s legal first name.individual.last_nameThe cardholder’s legal last name.individual.verification.documentThe front and back of a government-issued form of identification.
flow_details.issuing_authorization.card.cardholder.spending_controls(object, nullable) Rules that control spending across this cardholder’s cards. Refer to our documentation for more details.flow_details.issuing_authorization.card.cardholder.spending_controls.allowed_card_presences(array of enums, nullable) Array of card presence statuses from which authorizations will be allowed. Possible options arepresent,not_present. All other statuses will be blocked. Cannot be set withblocked_card_presences. Provide an empty value to unset this control. Possible enum values:not_presentpresent
flow_details.issuing_authorization.card.cardholder.spending_controls.allowed_categories(array of enums, nullable) Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set withblocked_categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
flow_details.issuing_authorization.card.cardholder.spending_controls.allowed_merchant_countries(array of strings, nullable) 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 withblocked_merchant_countries. Provide an empty value to unset this control.flow_details.issuing_authorization.card.cardholder.spending_controls.blocked_card_presences(array of enums, nullable) Array of card presence statuses from which authorizations will be declined. Possible options arepresent,not_present. Cannot be set withallowed_card_presences. Provide an empty value to unset this control. Possible enum values:not_presentpresent
flow_details.issuing_authorization.card.cardholder.spending_controls.blocked_categories(array of enums, nullable) Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set withallowed_categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
flow_details.issuing_authorization.card.cardholder.spending_controls.blocked_merchant_countries(array of strings, nullable) 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 withallowed_merchant_countries. Provide an empty value to unset this control.flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits(array of objects, nullable) Limit spending with amount-based rules that apply across this cardholder’s cards.flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits.amount(integer) 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.categories(array of enums, nullable) Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits.interval(enum) Interval (or event) to which the amount applies. Possible enum values:all_timeLimit applies to all transactions.dailyLimit applies to a day, starting at midnight UTC.monthlyLimit applies to a month, starting on the 1st at midnight UTC.per_authorizationLimit applies to each authorization.weeklyLimit applies to a week, starting on Sunday at midnight UTC.yearlyLimit applies to a year, starting on January 1st at midnight UTC.
flow_details.issuing_authorization.card.cardholder.spending_controls.spending_limits_currency(enum, nullable) Currency of the amounts withinspending_limits.
flow_details.issuing_authorization.card.cardholder.status(enum) Specifies whether to permit authorizations on this cardholder’s cards. Possible enum values:activeA platform has enabled the cardholder to approve authorizations made with their attached cards. However, if Stripe hasn’t yet verified the cardholder’s identity information, authorizations might still be blocked.blockedCards attached to this cardholder will decline all authorizations with thecardholder_blockedreason. This status is non-reversible.inactiveCards attached to this cardholder will decline all authorizations with thecardholder_inactivereason.
flow_details.issuing_authorization.card.cardholder.type(enum) One ofindividualorcompany. See Choose a cardholder type for more details. Possible enum values:companyThe 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.individualThe 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.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.issuing_authorization.card.currency(enum) Three-letter ISO currency code, in lowercase. Supported currencies areusdin the US,eurin the EU, andgbpin the UK.flow_details.issuing_authorization.card.cvc(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The card’s CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with theexpandparameter. 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_month(integer) The expiration month of the card.flow_details.issuing_authorization.card.exp_year(integer) The expiration year of the card.flow_details.issuing_authorization.card.last4(string) The last 4 digits of the card number.flow_details.issuing_authorization.card.latest_fraud_warning(object, nullable) Stripe’s assessment of whether this card’s details have been compromised. If this property isn’t null, cancel and reissue the card to prevent fraudulent activity risk.flow_details.issuing_authorization.card.latest_fraud_warning.started_at(timestamp, nullable) Timestamp of the most recent fraud warning.flow_details.issuing_authorization.card.latest_fraud_warning.type(enum, nullable) The type of fraud warning that most recently took place on this card. This field updates with every new fraud warning, so the value changes over time. If populated, cancel and reissue the card. Possible enum values:card_testing_exposureThe card’s credentials were used successfully in a card testing attempt. Requires Advanced Fraud Tools.fraud_dispute_filedThe cardholder filed a fraud dispute for a transactionthird_party_reportedThe card was reported compromised by a third partyuser_indicated_fraudThe cardholder indicated that a fraudulent transaction occurred. Requires Advanced Fraud Tools.
flow_details.issuing_authorization.card.lifecycle_controls(object, nullable) Rules that control the lifecycle of this card, such as automatic cancellation. Refer to our documentation for more details.flow_details.issuing_authorization.card.lifecycle_controls.cancel_after(object) Cancels the card after the specified conditions are met.flow_details.issuing_authorization.card.lifecycle_controls.cancel_after.payment_count(integer) The card is automatically cancelled when it makes this number of non-zero payment authorizations and transactions. The count includes penny authorizations, but doesn’t include non-payment actions, such as authorization advice.
flow_details.issuing_authorization.card.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.issuing_authorization.card.metadata(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.issuing_authorization.card.number(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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 theexpandparameter. 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_design(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The personalization design object belonging to this card.flow_details.issuing_authorization.card.replaced_by(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The latest card that replaces this card, if any.flow_details.issuing_authorization.card.replacement_for(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The card this card replaces, if any.flow_details.issuing_authorization.card.replacement_reason(enum, nullable) The reason why the previous card needed to be replaced. Possible enum values:damagedThe physical card has been damaged and cannot be used at terminals. This reason is only valid for cards of typephysical.expiredThe expiration date has passed or is imminent.fulfillment_errorThere was an error in fulfilling the card. This reason is only valid for cards of typephysical.lostThe card was lost. This status is only valid if the card it replaces is marked as lost.stolenThe card was stolen. This status is only valid if the card it replaces is marked as stolen.
flow_details.issuing_authorization.card.second_line(string, nullable) Text separate from cardholder name, printed on the card.flow_details.issuing_authorization.card.shipping(object, nullable) Where and how the card will be shipped.flow_details.issuing_authorization.card.shipping.address(object) Shipping address.flow_details.issuing_authorization.card.shipping.address.city(string, nullable) City, district, suburb, town, or village.flow_details.issuing_authorization.card.shipping.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).flow_details.issuing_authorization.card.shipping.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.issuing_authorization.card.shipping.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.issuing_authorization.card.shipping.address.postal_code(string, nullable) ZIP or postal code.flow_details.issuing_authorization.card.shipping.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.issuing_authorization.card.shipping.address_validation(object, nullable) Address validation details for the shipment.flow_details.issuing_authorization.card.shipping.address_validation.mode(enum) The address validation capabilities to use. Possible enum values:disabledThe card will be shipped without validating or normalizing the shipping address.normalization_onlyThe card will be shipped with the normalized address without validation. Undeliverable addresses won’t be blocked.validation_and_normalizationThe card will be shipped with the normalized, validated address. Undeliverable addresses will be blocked.
flow_details.issuing_authorization.card.shipping.address_validation.normalized_address(object, nullable) The normalized shipping address.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.city(string, nullable) City, district, suburb, town, or village.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.postal_code(string, nullable) ZIP or postal code.flow_details.issuing_authorization.card.shipping.address_validation.normalized_address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.issuing_authorization.card.shipping.address_validation.result(enum, nullable) The validation result for the shipping address. Possible enum values:indeterminateThe deliverability of the card’s shipping address could not be determined.likely_deliverableThe card’s shipping address is likely deliverable.likely_undeliverableThe card’s shipping address is likely undeliverable as submitted.
flow_details.issuing_authorization.card.shipping.carrier(enum, nullable) The delivery company that shipped a card. Possible enum values:dhlDHLfedexFedExroyal_mailRoyal MailuspsUSPS
flow_details.issuing_authorization.card.shipping.customs(object, nullable) Additional information that may be required for clearing customs.flow_details.issuing_authorization.card.shipping.customs.eori_number(string, nullable) 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.eta(timestamp, nullable) A unix timestamp representing a best estimate of when the card will be delivered.flow_details.issuing_authorization.card.shipping.name(string) Recipient name.flow_details.issuing_authorization.card.shipping.phone_number(string, nullable) 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_signature(boolean, nullable) 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.service(enum) Shipment service, such asstandardorexpress. Possible enum values:expressCards arrive in 4 business days.priorityCards arrive in 2-3 business days.standardCards arrive in 5-8 business days.
flow_details.issuing_authorization.card.shipping.status(enum, nullable) The delivery status of the card. Possible enum values:canceledThe card was canceled before being shipped.deliveredThe card has been delivered to its destination.failureThe card failed to be delivered but was not returned.pendingThe card is being prepared and has not yet shipped.returnedThe card failed to be delivered and was returned to the sender.shippedThe card has been shipped. If the card’s shipping carrier does not support tracking, this will be the card’s final status.submittedThe card has been submitted to the printer for shipment.
flow_details.issuing_authorization.card.shipping.tracking_number(string, nullable) A tracking number for a card shipment.flow_details.issuing_authorization.card.shipping.tracking_url(string, nullable) A link to the shipping carrier’s site where you can view detailed information about a card shipment.flow_details.issuing_authorization.card.shipping.type(enum) Packaging options. Possible enum values:bulkCards are grouped and mailed together.individualCards are sent individually in an envelope.
flow_details.issuing_authorization.card.spending_controls(object) Rules that control spending for this card. Refer to our documentation for more details.flow_details.issuing_authorization.card.spending_controls.allowed_card_presences(array of enums, nullable) Array of card presence statuses from which authorizations will be allowed. Possible options arepresent,not_present. All other statuses will be blocked. Cannot be set withblocked_card_presences. Provide an empty value to unset this control. Possible enum values:not_presentpresent
flow_details.issuing_authorization.card.spending_controls.allowed_categories(array of enums, nullable) Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set withblocked_categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
flow_details.issuing_authorization.card.spending_controls.allowed_merchant_countries(array of strings, nullable) 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 withblocked_merchant_countries. Provide an empty value to unset this control.flow_details.issuing_authorization.card.spending_controls.blocked_card_presences(array of enums, nullable) Array of card presence statuses from which authorizations will be declined. Possible options arepresent,not_present. Cannot be set withallowed_card_presences. Provide an empty value to unset this control. Possible enum values:not_presentpresent
flow_details.issuing_authorization.card.spending_controls.blocked_categories(array of enums, nullable) Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set withallowed_categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
flow_details.issuing_authorization.card.spending_controls.blocked_merchant_countries(array of strings, nullable) 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 withallowed_merchant_countries. Provide an empty value to unset this control.flow_details.issuing_authorization.card.spending_controls.spending_limits(array of objects, nullable) Limit spending with amount-based rules that apply across any cards this card replaced (i.e., itsreplacement_forcard and that card’sreplacement_forcard, up the chain).flow_details.issuing_authorization.card.spending_controls.spending_limits.amount(integer) 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.categories(array of enums, nullable) Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories. Possible enum values:ac_refrigeration_repairaccounting_bookkeeping_servicesadvertising_servicesagricultural_cooperativeairlines_air_carriersairports_flying_fieldsambulance_servicesamusement_parks_carnivalsantique_reproductionsantique_shopsaquariumsarchitectural_surveying_servicesart_dealers_and_galleriesartists_supply_and_craft_shopsauto_and_home_supply_storesauto_body_repair_shopsauto_paint_shopsauto_service_shopsautomated_cash_disburseautomated_fuel_dispensersautomobile_associationsautomotive_parts_and_accessories_storesautomotive_tire_storesbail_and_bond_paymentsbakeriesbands_orchestrasbarber_and_beauty_shopsbetting_casino_gamblingbicycle_shopsbilliard_pool_establishmentsboat_dealersboat_rentals_and_leasesbook_storesbooks_periodicals_and_newspapersbowling_alleysbus_linesbusiness_secretarial_schoolsbuying_shopping_servicescable_satellite_and_other_pay_television_and_radiocamera_and_photographic_supply_storescandy_nut_and_confectionery_storescar_and_truck_dealers_new_usedcar_and_truck_dealers_used_onlycar_rental_agenciescar_washescarpentry_servicescarpet_upholstery_cleaningcatererscharitable_and_social_service_organizations_fundraisingchemicals_and_allied_productschild_care_serviceschildrens_and_infants_wear_storeschiropodists_podiatristschiropractorscigar_stores_and_standscivic_social_fraternal_associationscleaning_and_maintenanceclothing_rentalcolleges_universitiescommercial_equipmentcommercial_footwearcommercial_photography_art_and_graphicscommuter_transport_and_ferriescomputer_network_servicescomputer_programmingcomputer_repaircomputer_software_storescomputers_peripherals_and_softwareconcrete_work_servicesconstruction_materialsconsulting_public_relationscorrespondence_schoolscosmetic_storescounseling_servicescountry_clubscourier_servicescourt_costscredit_reporting_agenciescruise_linesdairy_products_storesdance_hall_studios_schoolsdating_escort_servicesdentists_orthodontistsdepartment_storesdetective_agenciesdigital_goods_applicationsdigital_goods_gamesdigital_goods_large_volumedigital_goods_mediadirect_marketing_catalog_merchantdirect_marketing_combination_catalog_and_retail_merchantdirect_marketing_inbound_telemarketingdirect_marketing_insurance_servicesdirect_marketing_otherdirect_marketing_outbound_telemarketingdirect_marketing_subscriptiondirect_marketing_traveldiscount_storesdoctorsdoor_to_door_salesdrapery_window_covering_and_upholstery_storesdrinking_placesdrug_stores_and_pharmaciesdrugs_drug_proprietaries_and_druggist_sundriesdry_cleanersdurable_goodsduty_free_storeseating_places_restaurantseducational_serviceselectric_razor_storeselectric_vehicle_chargingelectrical_parts_and_equipmentelectrical_serviceselectronics_repair_shopselectronics_storeselementary_secondary_schoolsemergency_services_gcas_visa_use_onlyemployment_temp_agenciesequipment_rentalexterminating_servicesfamily_clothing_storesfast_food_restaurantsfinancial_institutionsfines_government_administrative_entitiesfireplace_fireplace_screens_and_accessories_storesfloor_covering_storesfloristsflorists_supplies_nursery_stock_and_flowersfreezer_and_locker_meat_provisionersfuel_dealers_non_automotivefuneral_services_crematoriesfurniture_home_furnishings_and_equipment_stores_except_appliancesfurniture_repair_refinishingfurriers_and_fur_shopsgeneral_servicesgift_card_novelty_and_souvenir_shopsglass_paint_and_wallpaper_storesglassware_crystal_storesgolf_courses_publicgovernment_licensed_horse_dog_racing_us_region_onlygovernment_licensed_online_casions_online_gambling_us_region_onlygovernment_owned_lotteries_non_us_regiongovernment_owned_lotteries_us_region_onlygovernment_servicesgrocery_stores_supermarketshardware_equipment_and_supplieshardware_storeshealth_and_beauty_spashearing_aids_sales_and_suppliesheating_plumbing_a_chobby_toy_and_game_shopshome_supply_warehouse_storeshospitalshotels_motels_and_resortshousehold_appliance_storesindustrial_suppliesinformation_retrieval_servicesinsurance_defaultinsurance_underwriting_premiumsintra_company_purchasesjewelry_stores_watches_clocks_and_silverware_storeslandscaping_serviceslaundrieslaundry_cleaning_serviceslegal_services_attorneysluggage_and_leather_goods_storeslumber_building_materials_storesmanual_cash_disbursemarinas_service_and_suppliesmarketplacesmasonry_stonework_and_plastermassage_parlorsmedical_and_dental_labsmedical_dental_ophthalmic_and_hospital_equipment_and_suppliesmedical_servicesmembership_organizationsmens_and_boys_clothing_and_accessories_storesmens_womens_clothing_storesmetal_service_centersmiscellaneousmiscellaneous_apparel_and_accessory_shopsmiscellaneous_auto_dealersmiscellaneous_business_servicesmiscellaneous_food_storesmiscellaneous_general_merchandisemiscellaneous_general_servicesmiscellaneous_home_furnishing_specialty_storesmiscellaneous_publishing_and_printingmiscellaneous_recreation_servicesmiscellaneous_repair_shopsmiscellaneous_specialty_retailmobile_home_dealersmotion_picture_theatersmotor_freight_carriers_and_truckingmotor_homes_dealersmotor_vehicle_supplies_and_new_partsmotorcycle_shops_and_dealersmotorcycle_shops_dealersmusic_stores_musical_instruments_pianos_and_sheet_musicnews_dealers_and_newsstandsnon_fi_money_ordersnon_fi_stored_value_card_purchase_loadnondurable_goodsnurseries_lawn_and_garden_supply_storesnursing_personal_careoffice_and_commercial_furnitureopticians_eyeglassesoptometrists_ophthalmologistorthopedic_goods_prosthetic_devicesosteopathspackage_stores_beer_wine_and_liquorpaints_varnishes_and_suppliesparking_lots_garagespassenger_railwayspawn_shopspet_shops_pet_food_and_suppliespetroleum_and_petroleum_productsphoto_developingphotographic_photocopy_microfilm_equipment_and_suppliesphotographic_studiospicture_video_productionpiece_goods_notions_and_other_dry_goodsplumbing_heating_equipment_and_suppliespolitical_organizationspostal_services_government_onlyprecious_stones_and_metals_watches_and_jewelryprofessional_servicespublic_warehousing_and_storagequick_copy_repro_and_blueprintrailroadsreal_estate_agents_and_managers_rentalsrecord_storesrecreational_vehicle_rentalsreligious_goods_storesreligious_organizationsroofing_siding_sheet_metalsecretarial_support_servicessecurity_brokers_dealersservice_stationssewing_needlework_fabric_and_piece_goods_storesshoe_repair_hat_cleaningshoe_storessmall_appliance_repairsnowmobile_dealersspecial_trade_servicesspecialty_cleaningsporting_goods_storessporting_recreation_campssports_and_riding_apparel_storessports_clubs_fieldsstamp_and_coin_storesstationary_office_supplies_printing_and_writing_paperstationery_stores_office_and_school_supply_storesswimming_pools_salest_ui_travel_germanytailors_alterationstax_payments_government_agenciestax_preparation_servicestaxicabs_limousinestelecommunication_equipment_and_telephone_salestelecommunication_servicestelegraph_servicestent_and_awning_shopstesting_laboratoriestheatrical_ticket_agenciestimesharestire_retreading_and_repairtolls_bridge_feestourist_attractions_and_exhibitstowing_servicestrailer_parks_campgroundstransportation_servicestravel_agencies_tour_operatorstruck_stop_iterationtruck_utility_trailer_rentalstypesetting_plate_making_and_related_servicestypewriter_storesu_s_federal_government_agencies_or_departmentsuniforms_commercial_clothingused_merchandise_and_secondhand_storesutilitiesvariety_storesveterinary_servicesvideo_amusement_game_suppliesvideo_game_arcadesvideo_tape_rental_storesvocational_trade_schoolswatch_jewelry_repairwelding_repairwholesale_clubswig_and_toupee_storeswires_money_orderswomens_accessory_and_specialty_shopswomens_ready_to_wear_storeswrecking_and_salvage_yards
flow_details.issuing_authorization.card.spending_controls.spending_limits.interval(enum) Interval (or event) to which the amount applies. Possible enum values:all_timeLimit applies to all transactions.dailyLimit applies to a day, starting at midnight UTC.monthlyLimit applies to a month, starting on the 1st at midnight UTC.per_authorizationLimit applies to each authorization.weeklyLimit applies to a week, starting on Sunday at midnight UTC.yearlyLimit applies to a year, starting on January 1st at midnight UTC.
flow_details.issuing_authorization.card.spending_controls.spending_limits_currency(enum, nullable) Currency of the amounts withinspending_limits. Always the same as the currency of the card.
flow_details.issuing_authorization.card.status(enum) Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults toinactive. Possible enum values:activeThe 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’.canceledThe card will decline authorizations with thecard_canceledreason. This status is permanent.inactiveThe card will decline authorizations with thecard_inactivereason.
flow_details.issuing_authorization.card.type(enum) The type of the card. Possible enum values:physicalA physical card will be printed and shipped. It can be used at physical terminals.virtualNo physical card will be printed. The card can be used online and can be added to digital wallets.
flow_details.issuing_authorization.card.wallets(object, nullable) Information relating to digital wallets (like Apple Pay and Google Pay).flow_details.issuing_authorization.card.wallets.apple_pay(object) Apple Pay Detailsflow_details.issuing_authorization.card.wallets.apple_pay.eligible(boolean) Apple Pay Eligibilityflow_details.issuing_authorization.card.wallets.apple_pay.ineligible_reason(enum, nullable) Reason the card is ineligible for Apple Pay Possible enum values:missing_agreementApple Pay is not enabled for your account.missing_cardholder_contactCardholder phone number or email required.unsupported_regionApple Pay is not supported in the cardholder’s country.
flow_details.issuing_authorization.card.wallets.google_pay(object) Google Pay Detailsflow_details.issuing_authorization.card.wallets.google_pay.eligible(boolean) Google Pay Eligibilityflow_details.issuing_authorization.card.wallets.google_pay.ineligible_reason(enum, nullable) Reason the card is ineligible for Google Pay Possible enum values:missing_agreementGoogle Pay is not enabled for your account.missing_cardholder_contactCardholder phone number or email required.unsupported_regionGoogle Pay is not supported in the cardholder’s country.
flow_details.issuing_authorization.card.wallets.primary_account_identifier(string, nullable) Unique identifier for a card used with digital wallets
flow_details.issuing_authorization.card_presence(enum, nullable) Whether the card was present at the point of sale for the authorization. Possible enum values:not_presentThe card was not present at the point of sale.presentThe card was present at the point of sale.
flow_details.issuing_authorization.cardholder(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The cardholder to whom this authorization belongs.flow_details.issuing_authorization.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.issuing_authorization.currency(enum) The currency of the cardholder. This currency can be different from the currency presented at authorization and themerchant_currencyfield on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.issuing_authorization.fleet(object, nullable) Fleet-specific information for authorizations using Fleet cards.flow_details.issuing_authorization.fleet.cardholder_prompt_data(object, nullable) 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.flow_details.issuing_authorization.fleet.cardholder_prompt_data.alphanumeric_id(string, nullable) [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_id(string, nullable) Driver ID.flow_details.issuing_authorization.fleet.cardholder_prompt_data.odometer(integer, nullable) Odometer reading.flow_details.issuing_authorization.fleet.cardholder_prompt_data.unspecified_id(string, nullable) 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_id(string, nullable) User ID.flow_details.issuing_authorization.fleet.cardholder_prompt_data.vehicle_number(string, nullable) Vehicle number.
flow_details.issuing_authorization.fleet.purchase_type(enum, nullable) The type of purchase. Possible enum values:fuel_and_non_fuel_purchaseFuel and non-fuel purchase.fuel_purchaseFuel-only purchase.non_fuel_purchaseNon-fuel purchase.
flow_details.issuing_authorization.fleet.reported_breakdown(object, nullable) 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.flow_details.issuing_authorization.fleet.reported_breakdown.fuel(object, nullable) Breakdown of fuel portion of the purchase.flow_details.issuing_authorization.fleet.reported_breakdown.fuel.gross_amount_decimal(decimal string, nullable) Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.
flow_details.issuing_authorization.fleet.reported_breakdown.non_fuel(object, nullable) Breakdown of non-fuel portion of the purchase.flow_details.issuing_authorization.fleet.reported_breakdown.non_fuel.gross_amount_decimal(decimal string, nullable) Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
flow_details.issuing_authorization.fleet.reported_breakdown.tax(object, nullable) Information about tax included in this transaction.flow_details.issuing_authorization.fleet.reported_breakdown.tax.local_amount_decimal(decimal string, nullable) Amount of state or provincial Sales Tax included in the transaction amount.nullif not reported by merchant or not subject to tax.flow_details.issuing_authorization.fleet.reported_breakdown.tax.national_amount_decimal(decimal string, nullable) Amount of national Sales Tax or VAT included in the transaction amount.nullif not reported by merchant or not subject to tax.
flow_details.issuing_authorization.fleet.service_type(enum, nullable) The type of fuel service. Possible enum values:full_serviceFull-service fuel station purchase.non_fuel_transactionNon-fuel transaction.self_serviceSelf-service fuel station purchase.
flow_details.issuing_authorization.fraud_challenges(array of objects, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.flow_details.issuing_authorization.fraud_challenges.channel(enum) The method by which the fraud challenge was delivered to the cardholder. Possible enum values:smsSMS sent to the cardholder’s phone number.
flow_details.issuing_authorization.fraud_challenges.status(enum) The status of the fraud challenge. Possible enum values:expiredThe 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.pendingThe challenge has been sent to the cardholder or is about to be sent.rejectedThe cardholder responded to the challenge indicating that the authorization was fraudulent, and that similar authorizations should continue to be declined.undeliverableA challenge has been requested to be sent, but the cardholder is unable to receive it.verifiedThe 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_reason(enum, nullable) If the challenge is not deliverable, the reason why. Possible enum values:no_phone_numberSMS fraud challenges cannot be delivered to this cardholder because they have nophone_number.unsupported_phone_numberSMS fraud challenges cannot be delivered to this cardholder because theirphone_numberis not supported
flow_details.issuing_authorization.fuel(object, nullable) 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.flow_details.issuing_authorization.fuel.industry_product_code(string, nullable) Conexxus Payment System Product Code identifying the primary fuel product purchased.flow_details.issuing_authorization.fuel.quantity_decimal(decimal string, nullable) The quantity ofunits of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.flow_details.issuing_authorization.fuel.type(enum, nullable) The type of fuel that was purchased. Possible enum values:dieselDiesel.otherOther.unleaded_plusUnleaded plus.unleaded_regularUnleaded regular.unleaded_superUnleaded super.
flow_details.issuing_authorization.fuel.unit(enum, nullable) The units forquantity_decimal. Possible enum values:charging_minuteCharging minute.imperial_gallonImperial gallon.kilogramKilogram.kilowatt_hourKilowatt-hour.literLiter.otherOther.poundPound.us_gallonUS gallon.
flow_details.issuing_authorization.fuel.unit_cost_decimal(decimal string, nullable) The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
flow_details.issuing_authorization.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.issuing_authorization.merchant_amount(integer) The total amount that was authorized or rejected. This amount is in themerchant_currencyand in the smallest currency unit.merchant_amountshould be the same asamount, unlessmerchant_currencyandcurrencyare different.flow_details.issuing_authorization.merchant_currency(enum) The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and thecurrencyfield on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.issuing_authorization.merchant_data(object) Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.flow_details.issuing_authorization.merchant_data.category(string) 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_code(string) The merchant category code for the seller’s businessflow_details.issuing_authorization.merchant_data.city(string, nullable) City where the seller is locatedflow_details.issuing_authorization.merchant_data.country(string, nullable) Country where the seller is locatedflow_details.issuing_authorization.merchant_data.name(string, nullable) Name of the sellerflow_details.issuing_authorization.merchant_data.network_id(string) 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_code(string, nullable) Postal code where the seller is locatedflow_details.issuing_authorization.merchant_data.state(string, nullable) State where the seller is locatedflow_details.issuing_authorization.merchant_data.tax_id(string, nullable) The seller’s tax identification number. Currently populated for French merchants only.flow_details.issuing_authorization.merchant_data.terminal_id(string, nullable) An ID assigned by the seller to the location of the sale.flow_details.issuing_authorization.merchant_data.url(string, nullable) URL provided by the merchant on a 3DS request
flow_details.issuing_authorization.metadata(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.issuing_authorization.network_data(object, nullable) Details about the authorization, such as identifiers, set by the card network.flow_details.issuing_authorization.network_data.acquiring_institution_id(string, nullable) Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will benull.flow_details.issuing_authorization.network_data.system_trace_audit_number(string, nullable) The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefernetwork_data.transaction_idif present, unless you have special requirements.flow_details.issuing_authorization.network_data.transaction_id(string, nullable) Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
flow_details.issuing_authorization.pending_request(object, nullable) The pending authorization request. This field will only be non-null during anissuing_authorization.requestwebhook.flow_details.issuing_authorization.pending_request.amount(integer) 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_details(object, nullable) Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit.flow_details.issuing_authorization.pending_request.amount_details.atm_fee(integer, nullable) The fee charged by the ATM for the cash withdrawal.flow_details.issuing_authorization.pending_request.amount_details.cashback_amount(integer, nullable) The amount of cash requested by the cardholder.
flow_details.issuing_authorization.pending_request.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.issuing_authorization.pending_request.is_amount_controllable(boolean) If settrue, you may provide amount to control how much to hold for the authorization.flow_details.issuing_authorization.pending_request.merchant_amount(integer) The amount the merchant is requesting to be authorized in themerchant_currency. The amount is in the smallest currency unit.flow_details.issuing_authorization.pending_request.merchant_currency(enum) The local currency the merchant is requesting to authorize.flow_details.issuing_authorization.pending_request.network_risk_score(integer, nullable) 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(array of objects) History of every time apending_requestauthorization 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.flow_details.issuing_authorization.request_history.amount(integer) Thepending_request.amountat 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_details(object, nullable) Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit.flow_details.issuing_authorization.request_history.amount_details.atm_fee(integer, nullable) The fee charged by the ATM for the cash withdrawal.flow_details.issuing_authorization.request_history.amount_details.cashback_amount(integer, nullable) The amount of cash requested by the cardholder.
flow_details.issuing_authorization.request_history.approved(boolean) Whether this request was approved.flow_details.issuing_authorization.request_history.authorization_code(string, nullable) 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.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.issuing_authorization.request_history.currency(string) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.issuing_authorization.request_history.merchant_amount(integer) Thepending_request.merchant_amountat the time of the request, presented in themerchant_currencyand in the smallest currency unit.flow_details.issuing_authorization.request_history.merchant_currency(string) 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_score(integer, nullable) 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.reason(enum) 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_disabledThe 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_activeThe 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_canceledThe authorization request was declined because the card was canceled.card_expiredThe authorization request was declined because the card has expired. Documentation for replacing an expired card can be found here.card_inactiveThe authorization request was declined because the card was inactive. To activate the card, refer to our documentation.cardholder_blockedThe authorization request was declined because the cardholder is blocked.cardholder_inactiveThe 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_requiredThe 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_methodThe 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_fundsThe authorization request was declined because your account had insufficient funds. Documentation for topping up your Issuing Balance can be found here.network_fallback[Stripe Autopilot] Stripe timed out or encountered an error when responding to the card network. If you have a dedicated BIN and have configured Autopilot, the card network approved or declined the authorization based on your STIP configuration.not_allowedThe charge is not allowed on the Stripe network, possibly because it is an ATM withdrawal or cash advance.pin_blockedThe authorization request was declined because the card’s PIN is blocked. Documentation on managing PINs can be found here.spending_controlsThe authorization was declined because of your spending controls. Documentation for updating your spending controls can be found here. Replaces the deprecated authorization_controls enum.suspected_fraudThe authorization was suspected to be fraud based on Stripe’s risk controls.verification_failedThe authorization failed required verification checks. See authorization.verification_data for more information. Replaces the deprecated authentication_failed, incorrect_cvc, and incorrect_expiry enums.webhook_approvedThe authorization was approved via the real-time auth webhook. More details on this can be found here.webhook_declinedThe authorization was declined via the real-time auth webhook. More details on this can be found here.webhook_error[Autopilot] The response sent through the real-time auth webhook is invalid.webhook_timeout[Autopilot] If you are using the real-time auth webhook, the webhook timed out before we received your authorization decision. Stripe approved or declined the authorization based on what you’ve configured in your Issuing default or Autopilot settings.
flow_details.issuing_authorization.request_history.reason_message(string, nullable) If therequest_history.reasoniswebhook_errorbecause 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_at(timestamp, nullable) 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.status(enum) The current status of the authorization in its lifecycle. Possible enum values:closedThe authorization was declined or captured through one or more transactions.expiredThe authorization was expired without capture.pendingThe authorization was created and is awaiting approval or was approved and is awaiting capture.reversedThe authorization was reversed by the merchant.
flow_details.issuing_authorization.token(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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.transactions(array of objects) List of transactions associated with this authorization.flow_details.issuing_authorization.transactions.id(string) Unique identifier for the object.flow_details.issuing_authorization.transactions.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.issuing_authorization.transactions.amount(integer) 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_details(object, nullable) Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit.flow_details.issuing_authorization.transactions.amount_details.atm_fee(integer, nullable) The fee charged by the ATM for the cash withdrawal.flow_details.issuing_authorization.transactions.amount_details.cashback_amount(integer, nullable) The amount of cash requested by the cardholder.
flow_details.issuing_authorization.transactions.authorization(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) TheAuthorizationobject that led to this transaction.flow_details.issuing_authorization.transactions.balance_transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the balance transaction associated with this transaction.flow_details.issuing_authorization.transactions.card(string, expandable (can be expanded into an object with theexpandrequest parameter)) The card used to make this transaction.flow_details.issuing_authorization.transactions.cardholder(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The cardholder to whom this transaction belongs.flow_details.issuing_authorization.transactions.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.issuing_authorization.transactions.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.issuing_authorization.transactions.dispute(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) If you’ve disputed the transaction, the ID of the dispute.flow_details.issuing_authorization.transactions.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.issuing_authorization.transactions.merchant_amount(integer) The amount that the merchant will receive, denominated inmerchant_currencyand in the smallest currency unit. It will be different fromamountif the merchant is taking payment in a different currency.flow_details.issuing_authorization.transactions.merchant_currency(enum) The currency with which the merchant is taking payment.flow_details.issuing_authorization.transactions.merchant_data(object) Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction.flow_details.issuing_authorization.transactions.merchant_data.category(string) 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_code(string) The merchant category code for the seller’s businessflow_details.issuing_authorization.transactions.merchant_data.city(string, nullable) City where the seller is locatedflow_details.issuing_authorization.transactions.merchant_data.country(string, nullable) Country where the seller is locatedflow_details.issuing_authorization.transactions.merchant_data.name(string, nullable) Name of the sellerflow_details.issuing_authorization.transactions.merchant_data.network_id(string) 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_code(string, nullable) Postal code where the seller is locatedflow_details.issuing_authorization.transactions.merchant_data.state(string, nullable) State where the seller is locatedflow_details.issuing_authorization.transactions.merchant_data.tax_id(string, nullable) The seller’s tax identification number. Currently populated for French merchants only.flow_details.issuing_authorization.transactions.merchant_data.terminal_id(string, nullable) An ID assigned by the seller to the location of the sale.flow_details.issuing_authorization.transactions.merchant_data.url(string, nullable) URL provided by the merchant on a 3DS request
flow_details.issuing_authorization.transactions.metadata(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.issuing_authorization.transactions.network_data(object, nullable) Details about the transaction, such as processing dates, set by the card network.flow_details.issuing_authorization.transactions.network_data.authorization_code(string, nullable) 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_date(string, nullable) 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_id(string, nullable) Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
flow_details.issuing_authorization.transactions.purchase_details(object, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) Additional purchase information that is optionally provided by the merchant.flow_details.issuing_authorization.transactions.purchase_details.fleet(object, nullable) Fleet-specific information for transactions using Fleet cards.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data(object, nullable) Answers to prompts presented to cardholder at point of sale.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.driver_id(string, nullable) Driver ID.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.odometer(integer, nullable) Odometer reading.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.unspecified_id(string, nullable) 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_id(string, nullable) User ID.flow_details.issuing_authorization.transactions.purchase_details.fleet.cardholder_prompt_data.vehicle_number(string, nullable) Vehicle number.
flow_details.issuing_authorization.transactions.purchase_details.fleet.purchase_type(string, nullable) The type of purchase. One offuel_purchase,non_fuel_purchase, orfuel_and_non_fuel_purchase.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown(object, nullable) More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.fuel(object, nullable) Breakdown of fuel portion of the purchase.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal(decimal string, nullable) 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_fuel(object, nullable) Breakdown of non-fuel portion of the purchase.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal(decimal string, nullable) 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.tax(object, nullable) Information about tax included in this transaction.flow_details.issuing_authorization.transactions.purchase_details.fleet.reported_breakdown.tax.local_amount_decimal(decimal string, nullable) 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_decimal(decimal string, nullable) 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_type(string, nullable) The type of fuel service. One ofnon_fuel_transaction,full_service, orself_service.
flow_details.issuing_authorization.transactions.purchase_details.flight(object, nullable) Information about the flight that was purchased with this transaction.flow_details.issuing_authorization.transactions.purchase_details.flight.departure_at(integer, nullable) The time that the flight departed.flow_details.issuing_authorization.transactions.purchase_details.flight.passenger_name(string, nullable) The name of the passenger.flow_details.issuing_authorization.transactions.purchase_details.flight.refundable(boolean, nullable) Whether the ticket is refundable.flow_details.issuing_authorization.transactions.purchase_details.flight.segments(array of objects, nullable) The legs of the trip.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.arrival_airport_code(string, nullable) The three-letter IATA airport code of the flight’s destination.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.carrier(string, nullable) The airline carrier code.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.departure_airport_code(string, nullable) The three-letter IATA airport code that the flight departed from.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.flight_number(string, nullable) The flight number.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.service_class(string, nullable) The flight’s service class.flow_details.issuing_authorization.transactions.purchase_details.flight.segments.stopover_allowed(boolean, nullable) Whether a stopover is allowed on this flight.
flow_details.issuing_authorization.transactions.purchase_details.flight.travel_agency(string, nullable) The travel agency that issued the ticket.
flow_details.issuing_authorization.transactions.purchase_details.fuel(object, nullable) Information about fuel that was purchased with this transaction.flow_details.issuing_authorization.transactions.purchase_details.fuel.industry_product_code(string, nullable) Conexxus Payment System Product Code identifying the primary fuel product purchased.flow_details.issuing_authorization.transactions.purchase_details.fuel.quantity_decimal(decimal string, nullable) The quantity ofunits of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.flow_details.issuing_authorization.transactions.purchase_details.fuel.type(string) The type of fuel that was purchased. One ofdiesel,unleaded_plus,unleaded_regular,unleaded_super, orother.flow_details.issuing_authorization.transactions.purchase_details.fuel.unit(string) The units forquantity_decimal. One ofcharging_minute,imperial_gallon,kilogram,kilowatt_hour,liter,pound,us_gallon, orother.flow_details.issuing_authorization.transactions.purchase_details.fuel.unit_cost_decimal(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.transactions.purchase_details.lodging(object, nullable) Information about lodging that was purchased with this transaction.flow_details.issuing_authorization.transactions.purchase_details.lodging.check_in_at(integer, nullable) The time of checking into the lodging.flow_details.issuing_authorization.transactions.purchase_details.lodging.nights(integer, nullable) The number of nights stayed at the lodging.
flow_details.issuing_authorization.transactions.purchase_details.receipt(array of objects, nullable) The line items in the purchase.flow_details.issuing_authorization.transactions.purchase_details.receipt.description(string, nullable) The description of the item. The maximum length of this field is 26 characters.flow_details.issuing_authorization.transactions.purchase_details.receipt.quantity(float, nullable) The quantity of the item.flow_details.issuing_authorization.transactions.purchase_details.receipt.total(integer, nullable) The total for this line item in cents.flow_details.issuing_authorization.transactions.purchase_details.receipt.unit_cost(integer, nullable) The unit cost of the item in cents.
flow_details.issuing_authorization.transactions.purchase_details.reference(string, nullable) A merchant-specific order number.
flow_details.issuing_authorization.transactions.token(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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.type(enum) The nature of the transaction. Possible enum values:captureFunds were captured by the acquirer.amountwill 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.refundAn acquirer initiated a refund. This transaction might not be linked to an original capture, for example credits are original transactions.amountwill be positive for refunds and negative for refund reversals. Refund reversals occur when a previous refund needs to be reversed, typically due to duplicate refunds. Learn more about refund reversals.
flow_details.issuing_authorization.transactions.wallet(enum, nullable) The digital wallet used for this transaction. One ofapple_pay,google_pay, orsamsung_pay.
flow_details.issuing_authorization.verification_data(object) Verifications that Stripe performed on information that the cardholder provided to the merchant.flow_details.issuing_authorization.verification_data.address_line1_check(enum) Whether the cardholder provided an address first line and if it matched the cardholder’sbilling.address.line1. Possible enum values:matchVerification succeeded, values matched.mismatchVerification failed, values didn’t match.not_providedVerification was not performed because no value was provided.
flow_details.issuing_authorization.verification_data.address_postal_code_check(enum) Whether the cardholder provided a postal code and if it matched the cardholder’sbilling.address.postal_code. Possible enum values:matchVerification succeeded, values matched.mismatchVerification failed, values didn’t match.not_providedVerification was not performed because no value was provided.
flow_details.issuing_authorization.verification_data.authentication_exemption(object, nullable) The exemption applied to this authorization.flow_details.issuing_authorization.verification_data.authentication_exemption.claimed_by(enum) The entity that requested the exemption, either the acquiring merchant or the Issuing user. Possible enum values:acquirerAcquiring merchant.issuerIssuing user.
flow_details.issuing_authorization.verification_data.authentication_exemption.type(enum) The specific exemption claimed for this authorization. Possible enum values:low_value_transactionSpecifies an exemption for some low-value authorizations.transaction_risk_analysisSpecifies an exemption for low-risk authorizations, determined using real-time risk analysis.unknownSpecifies an unknown exemption type.
flow_details.issuing_authorization.verification_data.cvc_check(enum) Whether the cardholder provided a CVC and if it matched Stripe’s record. Possible enum values:matchVerification succeeded, values matched.mismatchVerification failed, values didn’t match.not_providedVerification was not performed because no value was provided.
flow_details.issuing_authorization.verification_data.expiry_check(enum) Whether the cardholder provided an expiry date and if it matched Stripe’s record. Possible enum values:matchVerification succeeded, values matched.mismatchVerification failed, values didn’t match.not_providedVerification was not performed because no value was provided.
flow_details.issuing_authorization.verification_data.postal_code(string, nullable) The postal code submitted as part of the authorization used for postal code verification.flow_details.issuing_authorization.verification_data.three_d_secure(object, nullable) 3D Secure details.flow_details.issuing_authorization.verification_data.three_d_secure.result(enum) The outcome of the 3D Secure authentication request. Possible enum values:attempt_acknowledgedThe merchant attempted to authenticate the authorization, but the cardholder is not enrolled or was unable to reach Stripe.authenticatedAuthentication successful.failedAuthentication failed.requiredThe 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_challenge(boolean, nullable) 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.wallet(string, nullable) The digital wallet used for this transaction. One ofapple_pay,google_pay, orsamsung_pay. Will populate asnullwhen no digital wallet was utilized.
flow_details.outbound_payment(object, nullable) The OutboundPayment object associated with the Transaction. Set iftype=outbound_payment.flow_details.outbound_payment.id(string) Unique identifier for the object.flow_details.outbound_payment.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.outbound_payment.amount(integer) Amount (in cents) transferred.flow_details.outbound_payment.cancelable(boolean) Returnstrueif the object can be canceled, andfalseotherwise.flow_details.outbound_payment.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.outbound_payment.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.outbound_payment.customer(string, nullable) ID of the customer to whom an OutboundPayment is sent.flow_details.outbound_payment.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.flow_details.outbound_payment.destination_payment_method(string, nullable) The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created usingdestination_payment_method_data.flow_details.outbound_payment.destination_payment_method_details(object, nullable) Details about the PaymentMethod for an OutboundPayment.flow_details.outbound_payment.destination_payment_method_details.billing_details(object) Contact details for the person or business receiving the OutboundPayment.flow_details.outbound_payment.destination_payment_method_details.billing_details.address(object) Billing address.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.flow_details.outbound_payment.destination_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.outbound_payment.destination_payment_method_details.billing_details.email(string, nullable) Email address.flow_details.outbound_payment.destination_payment_method_details.billing_details.name(string, nullable) Full name.
flow_details.outbound_payment.destination_payment_method_details.financial_account(object, nullable) Details about thefinancial_account.flow_details.outbound_payment.destination_payment_method_details.financial_account.id(string) Token of the FinancialAccount.flow_details.outbound_payment.destination_payment_method_details.financial_account.network(enum) The rails used to send funds.
flow_details.outbound_payment.destination_payment_method_details.type(enum) The type of the payment method used in the OutboundPayment. Possible enum values:financial_accountus_bank_account
flow_details.outbound_payment.destination_payment_method_details.us_bank_account(object, nullable) Details about theus_bank_account.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
flow_details.outbound_payment.destination_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
flow_details.outbound_payment.destination_payment_method_details.us_bank_account.bank_name(string, nullable) Name of the bank associated with the bank account.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.fingerprint(string, nullable) 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.last4(string, nullable) Last four digits of the bank account number.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the mandate used to make this payment.flow_details.outbound_payment.destination_payment_method_details.us_bank_account.network(enum) The network rails used. See the docs to learn more about money movement timelines for each network type. Possible enum values:achACH networkus_domestic_wireUS domestic wire network
flow_details.outbound_payment.destination_payment_method_details.us_bank_account.routing_number(string, nullable) Routing number of the bank account.
flow_details.outbound_payment.end_user_details(object, nullable) Details about the end user.flow_details.outbound_payment.end_user_details.ip_address(string, nullable) IP address of the user initiating the OutboundPayment. Set ifpresentis set totrue. 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.present(boolean)trueif the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise,false.
flow_details.outbound_payment.expected_arrival_date(timestamp) The date when funds are expected to arrive in the destination account.flow_details.outbound_payment.financial_account(string) The FinancialAccount that funds were pulled from.flow_details.outbound_payment.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.flow_details.outbound_payment.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.outbound_payment.metadata(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.outbound_payment.purpose(enum, nullable) The purpose of the OutboundPayment, if applicable. Possible enum values:payrollThe purpose of the OutboundPayment is payroll.
flow_details.outbound_payment.returned_details(object, nullable) Details about a returned OutboundPayment. Only set when the status isreturned.flow_details.outbound_payment.returned_details.code(enum) Reason for the return. Possible enum values:account_closedThe destination has been closed.account_frozenThe destination has been frozen.bank_account_restrictedThe 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_changedThe destination bank account is no longer valid because its branch has changed ownership.declinedThe destination has declined this OutboundPayment.incorrect_account_holder_nameThe destination bank notified us that the bank account holder name on file is incorrect.invalid_account_numberThe destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe destination was unable to process this OutboundPayment because of its currency.no_accountThe destination bank account details on file are probably incorrect. No bank account exists with these details.otherThe destination could not process this OutboundPayment.
flow_details.outbound_payment.returned_details.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.outbound_payment.statement_descriptor(string) The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).flow_details.outbound_payment.status(enum) Current status of the OutboundPayment:processing,failed,posted,returned,canceled. An OutboundPayment isprocessingif it has been created and is pending. The status changes topostedonce the OutboundPayment has been “confirmed” and funds have left the account, or tofailedorcanceled. If an OutboundPayment fails to arrive at its destination, its status will change toreturned.flow_details.outbound_payment.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.flow_details.outbound_payment.status_transitions.canceled_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status tocanceled.flow_details.outbound_payment.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status tofailed.flow_details.outbound_payment.status_transitions.posted_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status toposted.flow_details.outbound_payment.status_transitions.returned_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status toreturned.
flow_details.outbound_payment.tracking_details(object, nullable) Details about network-specific tracking information if available.flow_details.outbound_payment.tracking_details.ach(object, nullable) ACH network tracking details.flow_details.outbound_payment.tracking_details.ach.trace_id(string) ACH trace ID of the OutboundPayment for payments sent over theachnetwork.
flow_details.outbound_payment.tracking_details.type(enum) The US bank account network used to send funds. Possible enum values:achus_domestic_wire
flow_details.outbound_payment.tracking_details.us_domestic_wire(object, nullable) US domestic wire network tracking details.flow_details.outbound_payment.tracking_details.us_domestic_wire.chips(string, nullable) CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over theus_domestic_wirenetwork.flow_details.outbound_payment.tracking_details.us_domestic_wire.imad(string, nullable) IMAD of the OutboundPayment for payments sent over theus_domestic_wirenetwork.flow_details.outbound_payment.tracking_details.us_domestic_wire.omad(string, nullable) OMAD of the OutboundPayment for payments sent over theus_domestic_wirenetwork.
flow_details.outbound_payment.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.outbound_transfer(object, nullable) The OutboundTransfer object associated with the Transaction. Set iftype=outbound_transfer.flow_details.outbound_transfer.id(string) Unique identifier for the object.flow_details.outbound_transfer.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.outbound_transfer.amount(integer) Amount (in cents) transferred.flow_details.outbound_transfer.cancelable(boolean) Returnstrueif the object can be canceled, andfalseotherwise.flow_details.outbound_transfer.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.outbound_transfer.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.outbound_transfer.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.flow_details.outbound_transfer.destination_payment_method(string, nullable) The PaymentMethod used as the payment instrument for an OutboundTransfer.flow_details.outbound_transfer.destination_payment_method_details(object) Details about the PaymentMethod for an OutboundTransferflow_details.outbound_transfer.destination_payment_method_details.billing_details(object) Contact details for the person or business receiving the OutboundTransfer.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address(object) Billing address.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.outbound_transfer.destination_payment_method_details.billing_details.email(string, nullable) Email address.flow_details.outbound_transfer.destination_payment_method_details.billing_details.name(string, nullable) Full name.
flow_details.outbound_transfer.destination_payment_method_details.financial_account(object, nullable) Details about thefinancial_account.flow_details.outbound_transfer.destination_payment_method_details.financial_account.id(string) Token of the FinancialAccount.flow_details.outbound_transfer.destination_payment_method_details.financial_account.network(enum) The rails used to send funds.
flow_details.outbound_transfer.destination_payment_method_details.type(enum) The type of the payment method used in the OutboundTransfer.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account(object, nullable) Details about theus_bank_account.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.bank_name(string, nullable) Name of the bank associated with the bank account.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.fingerprint(string, nullable) 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.last4(string, nullable) Last four digits of the bank account number.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the mandate used to make this payment.flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.network(enum) The network rails used. See the docs to learn more about money movement timelines for each network type. Possible enum values:achACH networkus_domestic_wireUS domestic wire network
flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.routing_number(string, nullable) Routing number of the bank account.
flow_details.outbound_transfer.expected_arrival_date(timestamp) The date when funds are expected to arrive in the destination account.flow_details.outbound_transfer.financial_account(string) The FinancialAccount that funds were pulled from.flow_details.outbound_transfer.hosted_regulatory_receipt_url(string, nullable) A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.flow_details.outbound_transfer.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.outbound_transfer.metadata(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.outbound_transfer.returned_details(object, nullable) Details about a returned OutboundTransfer. Only set when the status isreturned.flow_details.outbound_transfer.returned_details.code(enum) Reason for the return. Possible enum values:account_closedThe destination has been closed.account_frozenThe destination has been frozen.bank_account_restrictedThe 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_changedThe destination bank account is no longer valid because its branch has changed ownership.declinedThe destination has declined this OutboundTransfer.incorrect_account_holder_nameThe destination bank notified us that the bank account holder name on file is incorrect.invalid_account_numberThe destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe destination was unable to process this OutboundTransfer because of its currency.no_accountThe destination bank account details on file are probably incorrect. No bank account exists with these details.otherThe destination could not process this OutboundTransfer.
flow_details.outbound_transfer.returned_details.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.outbound_transfer.statement_descriptor(string) Information about the OutboundTransfer to be sent to the recipient account.flow_details.outbound_transfer.status(enum) Current status of the OutboundTransfer:processing,failed,canceled,posted,returned. An OutboundTransfer isprocessingif it has been created and is pending. The status changes topostedonce the OutboundTransfer has been “confirmed” and funds have left the account, or tofailedorcanceled. If an OutboundTransfer fails to arrive at its destination, its status will change toreturned.flow_details.outbound_transfer.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.flow_details.outbound_transfer.status_transitions.canceled_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status tocanceledflow_details.outbound_transfer.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status tofailedflow_details.outbound_transfer.status_transitions.posted_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status topostedflow_details.outbound_transfer.status_transitions.returned_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status toreturned
flow_details.outbound_transfer.tracking_details(object, nullable) Details about network-specific tracking information if available.flow_details.outbound_transfer.tracking_details.ach(object, nullable) ACH network tracking details.flow_details.outbound_transfer.tracking_details.ach.trace_id(string) ACH trace ID of the OutboundTransfer for transfers sent over theachnetwork.
flow_details.outbound_transfer.tracking_details.type(enum) The US bank account network used to send funds. Possible enum values:achus_domestic_wire
flow_details.outbound_transfer.tracking_details.us_domestic_wire(object, nullable) US domestic wire network tracking details.flow_details.outbound_transfer.tracking_details.us_domestic_wire.chips(string, nullable) CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.flow_details.outbound_transfer.tracking_details.us_domestic_wire.imad(string, nullable) IMAD of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.flow_details.outbound_transfer.tracking_details.us_domestic_wire.omad(string, nullable) OMAD of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.
flow_details.outbound_transfer.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.received_credit(object, nullable) The ReceivedCredit object associated with the Transaction. Set iftype=received_credit.flow_details.received_credit.id(string) Unique identifier for the object.flow_details.received_credit.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.received_credit.amount(integer) Amount (in cents) transferred.flow_details.received_credit.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.received_credit.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.received_credit.description(string) An arbitrary string attached to the object. Often useful for displaying to users.flow_details.received_credit.failure_code(enum, nullable) Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. Possible enum values:account_closedFunds can’t be sent to a closed FinancialAccount.account_frozenFunds can’t be sent to a frozen FinancialAccount.international_transactionInternational transactions can’t be sent to FinancialAccount.otherFunds can’t be sent to FinancialAccount for other reasons.
flow_details.received_credit.financial_account(string, nullable) The FinancialAccount that received the funds.flow_details.received_credit.hosted_regulatory_receipt_url(string, nullable) 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_details(object) Details about the PaymentMethod used to send a ReceivedCredit.flow_details.received_credit.initiating_payment_method_details.balance(enum, nullable) Set whentypeisbalance. Possible enum values:paymentsThe Stripe payments balance.
flow_details.received_credit.initiating_payment_method_details.billing_details(object) The contact details of the person or business referenced by the received payment method details.flow_details.received_credit.initiating_payment_method_details.billing_details.address(object) Billing address.flow_details.received_credit.initiating_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.flow_details.received_credit.initiating_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).flow_details.received_credit.initiating_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.received_credit.initiating_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.received_credit.initiating_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.flow_details.received_credit.initiating_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.received_credit.initiating_payment_method_details.billing_details.email(string, nullable) Email address.flow_details.received_credit.initiating_payment_method_details.billing_details.name(string, nullable) Full name.
flow_details.received_credit.initiating_payment_method_details.financial_account(object, nullable) Set whentypeisfinancial_account. This is a FinancialAccount ID.flow_details.received_credit.initiating_payment_method_details.financial_account.id(string) The FinancialAccount ID.flow_details.received_credit.initiating_payment_method_details.financial_account.network(enum) The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds overstripe.
flow_details.received_credit.initiating_payment_method_details.issuing_card(string, nullable) Set whentypeisissuing_card. This is an Issuing Card ID.flow_details.received_credit.initiating_payment_method_details.type(enum) 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_account(object, nullable) Set whentypeisus_bank_account.flow_details.received_credit.initiating_payment_method_details.us_bank_account.bank_name(string, nullable) Bank name.flow_details.received_credit.initiating_payment_method_details.us_bank_account.last4(string, nullable) The last four digits of the bank account number.flow_details.received_credit.initiating_payment_method_details.us_bank_account.routing_number(string, nullable) The routing number for the bank account.
flow_details.received_credit.linked_flows(object) Other flows linked to a ReceivedCredit.flow_details.received_credit.linked_flows.credit_reversal(string, nullable) The CreditReversal created as a result of this ReceivedCredit being reversed.flow_details.received_credit.linked_flows.issuing_authorization(string, nullable) Set if the ReceivedCredit was created due to an Issuing Authorization object.flow_details.received_credit.linked_flows.issuing_transaction(string, nullable) Set if the ReceivedCredit is also viewable as an Issuing transaction object.flow_details.received_credit.linked_flows.source_flow(string, nullable) ID of the source flow. Set ifnetworkisstripeand 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_details(object, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The expandable object of the source flow.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal(object, nullable) Details about a CreditReversal.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.id(string) Unique identifier for the object.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.object(string) 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.amount(integer) Amount (in cents) transferred.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.created(timestamp) 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.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.financial_account(string) The FinancialAccount to reverse funds from.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.hosted_regulatory_receipt_url(string, nullable) 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.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.metadata(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.credit_reversal.network(enum) The rails used to reverse the funds.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.received_credit(string) The ReceivedCredit being reversed.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.status(enum) Status of the CreditReversal Possible enum values:canceledThe CreditReversal has been canceled before it has been sent to the network and no funds have left the account. (Currently not supported).postedThe CreditReversal has been sent to the network and funds have left the account (with the Transaction posting)processingThe 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_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.status_transitions.posted_at(timestamp, nullable) Timestamp describing when the CreditReversal changed status toposted
flow_details.received_credit.linked_flows.source_flow_details.credit_reversal.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment(object, nullable) Details about an OutboundPayment.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.id(string) Unique identifier for the object.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.object(string) 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.amount(integer) Amount (in cents) transferred.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.cancelable(boolean) Returnstrueif the object can be canceled, andfalseotherwise.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.created(timestamp) 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.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.customer(string, nullable) ID of the customer to whom an OutboundPayment is sent.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.description(string, nullable) 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_method(string, nullable) The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created usingdestination_payment_method_data.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details(object, nullable) Details about the PaymentMethod for an OutboundPayment.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details(object) Contact details for the person or business receiving the OutboundPayment.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address(object) Billing address.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.country(string, nullable) 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.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.email(string, nullable) Email address.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.billing_details.name(string, nullable) Full name.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_account(object, nullable) Details about thefinancial_account.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_account.id(string) Token of the FinancialAccount.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.financial_account.network(enum) The rails used to send funds.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.type(enum) The type of the payment method used in the OutboundPayment. Possible enum values:financial_accountus_bank_account
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account(object, nullable) Details about theus_bank_account.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.bank_name(string, nullable) 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.fingerprint(string, nullable) 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.last4(string, nullable) 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.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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.network(enum) The network rails used. See the docs to learn more about money movement timelines for each network type. Possible enum values:achACH networkus_domestic_wireUS domestic wire network
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.destination_payment_method_details.us_bank_account.routing_number(string, nullable) Routing number of the bank account.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.end_user_details(object, nullable) Details about the end user.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.end_user_details.ip_address(string, nullable) IP address of the user initiating the OutboundPayment. Set ifpresentis set totrue. 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.present(boolean)trueif 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_date(timestamp) The date when funds are expected to arrive in the destination account.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.financial_account(string) The FinancialAccount that funds were pulled from.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.hosted_regulatory_receipt_url(string, nullable) 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.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.metadata(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.outbound_payment.purpose(enum, nullable) The purpose of the OutboundPayment, if applicable. Possible enum values:payrollThe purpose of the OutboundPayment is payroll.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.returned_details(object, nullable) Details about a returned OutboundPayment. Only set when the status isreturned.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.returned_details.code(enum) Reason for the return. Possible enum values:account_closedThe destination has been closed.account_frozenThe destination has been frozen.bank_account_restrictedThe 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_changedThe destination bank account is no longer valid because its branch has changed ownership.declinedThe destination has declined this OutboundPayment.incorrect_account_holder_nameThe destination bank notified us that the bank account holder name on file is incorrect.invalid_account_numberThe destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe destination was unable to process this OutboundPayment because of its currency.no_accountThe destination bank account details on file are probably incorrect. No bank account exists with these details.otherThe destination could not process this OutboundPayment.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.returned_details.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.statement_descriptor(string) 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.status(enum) Current status of the OutboundPayment:processing,failed,posted,returned,canceled. An OutboundPayment isprocessingif it has been created and is pending. The status changes topostedonce the OutboundPayment has been “confirmed” and funds have left the account, or tofailedorcanceled. If an OutboundPayment fails to arrive at its destination, its status will change toreturned.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.canceled_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status tocanceled.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status tofailed.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.posted_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status toposted.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.status_transitions.returned_at(timestamp, nullable) Timestamp describing when an OutboundPayment changed status toreturned.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details(object, nullable) Details about network-specific tracking information if available.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.ach(object, nullable) ACH network tracking details.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.ach.trace_id(string) ACH trace ID of the OutboundPayment for payments sent over theachnetwork.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.type(enum) The US bank account network used to send funds. Possible enum values:achus_domestic_wire
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire(object, nullable) US domestic wire network tracking details.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire.chips(string, nullable) CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over theus_domestic_wirenetwork.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire.imad(string, nullable) IMAD of the OutboundPayment for payments sent over theus_domestic_wirenetwork.flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.tracking_details.us_domestic_wire.omad(string, nullable) OMAD of the OutboundPayment for payments sent over theus_domestic_wirenetwork.
flow_details.received_credit.linked_flows.source_flow_details.outbound_payment.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer(object, nullable) Details about an OutboundTransfer.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.id(string) Unique identifier for the object.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.object(string) 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.amount(integer) Amount (in cents) transferred.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.cancelable(boolean) Returnstrueif the object can be canceled, andfalseotherwise.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.created(timestamp) 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.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.description(string, nullable) 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_method(string, nullable) The PaymentMethod used as the payment instrument for an OutboundTransfer.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details(object) Details about the PaymentMethod for an OutboundTransferflow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details(object) Contact details for the person or business receiving the OutboundTransfer.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address(object) Billing address.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.country(string, nullable) 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.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.email(string, nullable) Email address.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.billing_details.name(string, nullable) Full name.
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.financial_account(object, nullable) Details about thefinancial_account.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.financial_account.id(string) Token of the FinancialAccount.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.financial_account.network(enum) The rails used to send funds.
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.type(enum) 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_account(object, nullable) Details about theus_bank_account.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.bank_name(string, nullable) 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.fingerprint(string, nullable) 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.last4(string, nullable) 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.mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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.network(enum) The network rails used. See the docs to learn more about money movement timelines for each network type. Possible enum values:achACH networkus_domestic_wireUS domestic wire network
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.destination_payment_method_details.us_bank_account.routing_number(string, nullable) Routing number of the bank account.
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.expected_arrival_date(timestamp) The date when funds are expected to arrive in the destination account.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.financial_account(string) The FinancialAccount that funds were pulled from.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.hosted_regulatory_receipt_url(string, nullable) 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.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.metadata(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.outbound_transfer.returned_details(object, nullable) Details about a returned OutboundTransfer. Only set when the status isreturned.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.returned_details.code(enum) Reason for the return. Possible enum values:account_closedThe destination has been closed.account_frozenThe destination has been frozen.bank_account_restrictedThe 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_changedThe destination bank account is no longer valid because its branch has changed ownership.declinedThe destination has declined this OutboundTransfer.incorrect_account_holder_nameThe destination bank notified us that the bank account holder name on file is incorrect.invalid_account_numberThe destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.invalid_currencyThe destination was unable to process this OutboundTransfer because of its currency.no_accountThe destination bank account details on file are probably incorrect. No bank account exists with these details.otherThe destination could not process this OutboundTransfer.
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.returned_details.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.statement_descriptor(string) Information about the OutboundTransfer to be sent to the recipient account.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status(enum) Current status of the OutboundTransfer:processing,failed,canceled,posted,returned. An OutboundTransfer isprocessingif it has been created and is pending. The status changes topostedonce the OutboundTransfer has been “confirmed” and funds have left the account, or tofailedorcanceled. If an OutboundTransfer fails to arrive at its destination, its status will change toreturned.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.canceled_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status tocanceledflow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.failed_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status tofailedflow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.posted_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status topostedflow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.status_transitions.returned_at(timestamp, nullable) Timestamp describing when an OutboundTransfer changed status toreturned
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details(object, nullable) Details about network-specific tracking information if available.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.ach(object, nullable) ACH network tracking details.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.ach.trace_id(string) ACH trace ID of the OutboundTransfer for transfers sent over theachnetwork.
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.type(enum) The US bank account network used to send funds. Possible enum values:achus_domestic_wire
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire(object, nullable) US domestic wire network tracking details.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire.chips(string, nullable) CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire.imad(string, nullable) IMAD of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.tracking_details.us_domestic_wire.omad(string, nullable) OMAD of the OutboundTransfer for transfers sent over theus_domestic_wirenetwork.
flow_details.received_credit.linked_flows.source_flow_details.outbound_transfer.transaction(string, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.received_credit.linked_flows.source_flow_details.payout(object, nullable) Details about a Payout.flow_details.received_credit.linked_flows.source_flow_details.payout.id(string) Unique identifier for the object.flow_details.received_credit.linked_flows.source_flow_details.payout.object(string) 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.amount(integer) The amount (in the smallest currency unit) that transfers to your bank account or debit card.flow_details.received_credit.linked_flows.source_flow_details.payout.application_fee(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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_amount(integer, nullable) 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_date(timestamp) 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.automatic(boolean) Returnstrueif the payout is created by an automated payout schedule andfalseif it’s requested manually.flow_details.received_credit.linked_flows.source_flow_details.payout.balance_transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.received_credit.linked_flows.source_flow_details.payout.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.received_credit.linked_flows.source_flow_details.payout.description(string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.flow_details.received_credit.linked_flows.source_flow_details.payout.destination(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the bank account or card the payout is sent to.flow_details.received_credit.linked_flows.source_flow_details.payout.failure_balance_transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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_code(string, nullable) 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_message(string, nullable) Message that provides the reason for a payout failure, if available.flow_details.received_credit.linked_flows.source_flow_details.payout.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.received_credit.linked_flows.source_flow_details.payout.metadata(object, nullable) 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.method(string) The method used to send this payout, which can bestandardorinstant.instantis 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_payout(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) If the payout reverses another, this is the ID of the original payout.flow_details.received_credit.linked_flows.source_flow_details.payout.payout_method(string, nullable) ID of the v2 FinancialAccount the funds are sent to.flow_details.received_credit.linked_flows.source_flow_details.payout.reconciliation_status(enum) Ifcompleted, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout. Possible enum values:completedThe Balance Transactions paid out in this payout. You can query it with the Balance Transactions API.in_progressYou can query the Balance Transactions paid out in this payout soon.not_applicableWe 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_by(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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_type(string) The source balance this payout came from, which can be one of the following:card,fpx, orbank_account.flow_details.received_credit.linked_flows.source_flow_details.payout.statement_descriptor(string, nullable) Extra information about a payout that displays on the user’s bank statement.flow_details.received_credit.linked_flows.source_flow_details.payout.status(string) Current status of the payout:paid,pending,in_transit,canceledorfailed. A payout ispendinguntil it’s submitted to the bank, when it becomesin_transit. The status changes topaidif the transaction succeeds, or tofailedorcanceled(within 5 business days). Some payouts that fail might initially show aspaid, then change tofailed.flow_details.received_credit.linked_flows.source_flow_details.payout.trace_id(object, nullable) 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.flow_details.received_credit.linked_flows.source_flow_details.payout.trace_id.status(string) Possible values arepending,supported, andunsupported. Whenpayout.statusispendingorin_transit, this will bepending. When the payout transitions topaid,failed, orcanceled, this status will becomesupportedorunsupportedshortly after in most cases. In some cases, this may appear aspendingfor up to 10 days afterarrival_dateuntil transitioning tosupportedorunsupported.flow_details.received_credit.linked_flows.source_flow_details.payout.trace_id.value(string, nullable) The trace ID value iftrace_id.statusissupported, otherwisenil.
flow_details.received_credit.linked_flows.source_flow_details.payout.type(enum) Can bebank_accountorcard.
flow_details.received_credit.linked_flows.source_flow_details.type(enum) The type of the source flow that originated the ReceivedCredit. Possible enum values:credit_reversalReceivedCredits that were reversed and have associated CreditReversals.otherReceivedCredits created from other source flow.outbound_paymentReceivedCredits created from OutboundPayments.outbound_transferReceivedCredits created from OutboundPayments.payoutReceivedCredits created from Payouts.
flow_details.received_credit.linked_flows.source_flow_type(string, nullable) The type of flow that originated the ReceivedCredit (for example,outbound_payment).
flow_details.received_credit.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.received_credit.network(enum) The rails used to send the funds. Possible enum values:achcardstripeus_domestic_wire
flow_details.received_credit.reversal_details(object, nullable) Details describing when a ReceivedCredit may be reversed.flow_details.received_credit.reversal_details.deadline(timestamp, nullable) Time before which a ReceivedCredit can be reversed.flow_details.received_credit.reversal_details.restricted_reason(enum, nullable) Set if a ReceivedCredit cannot be reversed. Possible enum values:already_reversedA ReceivedCredit that’s already reversed has thisrestricted_reason. It may have a deadline populated in some cases.deadline_passedA ReceivedCredit which used to be reversible until the timestamp indeadline, but is no longer reversible. ACH ReceivedCredits are only reversible for some time after they’re created.network_restrictedNetwork constraints prevent Stripe from allowing reversal on some ReceivedCredits, such as a ReceivedCredit from a wire transfer.otherA ReceivedCredit that was reversed because of another reason.source_flow_restrictedStripe restricts users from reversing a Stripe network ReceivedCredit.
flow_details.received_credit.status(enum) Status of the ReceivedCredit. ReceivedCredits are created eithersucceeded(approved) orfailed(declined). If a ReceivedCredit is declined, the failure reason can be found in thefailure_codefield. Possible enum values:failedThe ReceivedCredit was declined, and no Transaction was created.succeededThe ReceivedCredit was approved.
flow_details.received_credit.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.received_debit(object, nullable) The ReceivedDebit object associated with the Transaction. Set iftype=received_debit.flow_details.received_debit.id(string) Unique identifier for the object.flow_details.received_debit.object(string) String representing the object’s type. Objects of the same type share the same value.flow_details.received_debit.amount(integer) Amount (in cents) transferred.flow_details.received_debit.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.flow_details.received_debit.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.flow_details.received_debit.description(string) An arbitrary string attached to the object. Often useful for displaying to users.flow_details.received_debit.failure_code(enum, nullable) 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_closedFunds can’t be pulled from a closed FinancialAccount.account_frozenFunds can’t be pulled from a frozen FinancialAccount.insufficient_fundsThe FinancialAccount doesn’t have a sufficient balance.international_transactionInternational transactions can’t pull funds from the FinancialAccount.otherFunds can’t be pulled from the FinancialAccount for other reasons.
flow_details.received_debit.financial_account(string, nullable) The FinancialAccount that funds were pulled from.flow_details.received_debit.hosted_regulatory_receipt_url(string, nullable) 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_details(object) Details about how a ReceivedDebit was created.flow_details.received_debit.initiating_payment_method_details.balance(enum, nullable) Set whentypeisbalance. Possible enum values:paymentsThe Stripe payments balance.
flow_details.received_debit.initiating_payment_method_details.billing_details(object) The contact details of the person or business referenced by the received payment method details.flow_details.received_debit.initiating_payment_method_details.billing_details.address(object) Billing address.flow_details.received_debit.initiating_payment_method_details.billing_details.address.city(string, nullable) City, district, suburb, town, or village.flow_details.received_debit.initiating_payment_method_details.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).flow_details.received_debit.initiating_payment_method_details.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.flow_details.received_debit.initiating_payment_method_details.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.flow_details.received_debit.initiating_payment_method_details.billing_details.address.postal_code(string, nullable) ZIP or postal code.flow_details.received_debit.initiating_payment_method_details.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
flow_details.received_debit.initiating_payment_method_details.billing_details.email(string, nullable) Email address.flow_details.received_debit.initiating_payment_method_details.billing_details.name(string, nullable) Full name.
flow_details.received_debit.initiating_payment_method_details.financial_account(object, nullable) Set whentypeisfinancial_account. This is a FinancialAccount ID.flow_details.received_debit.initiating_payment_method_details.financial_account.id(string) The FinancialAccount ID.flow_details.received_debit.initiating_payment_method_details.financial_account.network(enum) The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds overstripe.
flow_details.received_debit.initiating_payment_method_details.issuing_card(string, nullable) Set whentypeisissuing_card. This is an Issuing Card ID.flow_details.received_debit.initiating_payment_method_details.type(enum) 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_account(object, nullable) Set whentypeisus_bank_account.flow_details.received_debit.initiating_payment_method_details.us_bank_account.bank_name(string, nullable) Bank name.flow_details.received_debit.initiating_payment_method_details.us_bank_account.last4(string, nullable) The last four digits of the bank account number.flow_details.received_debit.initiating_payment_method_details.us_bank_account.routing_number(string, nullable) The routing number for the bank account.
flow_details.received_debit.linked_flows(object) Other flows linked to a ReceivedDebit.flow_details.received_debit.linked_flows.debit_reversal(string, nullable) The DebitReversal created as a result of this ReceivedDebit being reversed.flow_details.received_debit.linked_flows.inbound_transfer(string, nullable) Set if the ReceivedDebit is associated with an InboundTransfer’s return of funds.flow_details.received_debit.linked_flows.issuing_authorization(string, nullable) Set if the ReceivedDebit was created due to an Issuing Authorization object.flow_details.received_debit.linked_flows.issuing_transaction(string, nullable) Set if the ReceivedDebit is also viewable as an Issuing Dispute object.flow_details.received_debit.linked_flows.payout(string, nullable) Set if the ReceivedDebit was created due to a Payout object.flow_details.received_debit.linked_flows.topup(string, nullable) Set if the ReceivedDebit was created due to a Topup object.
flow_details.received_debit.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.flow_details.received_debit.network(enum) The network used for the ReceivedDebit.flow_details.received_debit.reversal_details(object, nullable) Details describing when a ReceivedDebit might be reversed.flow_details.received_debit.reversal_details.deadline(timestamp, nullable) Time before which a ReceivedDebit can be reversed.flow_details.received_debit.reversal_details.restricted_reason(enum, nullable) Set if a ReceivedDebit can’t be reversed. Possible enum values:already_reversedA ReceivedDebit that’s already reversed has thisrestricted_reason. It may have adeadlinepopulated.deadline_passedA ReceivedDebit that used to be reversible until the timestamp indeadline, but is no longer reversible. ACH ReceivedDebits are only reversible for some time after they’re created.network_restrictedNetwork constraints prevent Stripe from allowing reversal on some ReceivedDebits.otherA ReceivedDebit that was reversed because of another reason.source_flow_restrictedA ReceivedDebit that can’t be reversed because itssource_flowis not reversible.
flow_details.received_debit.status(enum) Status of the ReceivedDebit. ReceivedDebits are created with a status of eithersucceeded(approved) orfailed(declined). The failure reason can be found under thefailure_code. Possible enum values:failedThe ReceivedDebit was declined, and no Transaction was created.succeededThe ReceivedDebit was approved.
flow_details.received_debit.transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The Transaction associated with this object.
flow_details.type(enum) Type of the flow that created the Transaction. Set to the same value asflow_type. Possible enum values:credit_reversalThe Transaction is associated with a CreditReversal.debit_reversalThe Transaction is associated with a DebitReversal.inbound_transferThe Transaction is associated with an InboundTransfer.issuing_authorizationThe Transaction is associated with an Issuing authorization.otherThe Transaction is associated with some other money movement not listed above.outbound_paymentThe Transaction is associated with an OutboundPayment.outbound_transferThe Transaction is associated with an OutboundTransfer.received_creditThe Transaction is associated with a ReceivedCredit.received_debitThe Transaction is associated with a ReceivedDebit.
flow_type(enum) Type of the flow that created the Transaction. Possible enum values:credit_reversalThe Transaction is associated with a CreditReversal.debit_reversalThe Transaction is associated with a DebitReversal.inbound_transferThe Transaction is associated with an InboundTransfer.issuing_authorizationThe Transaction is associated with an Issuing authorization.otherThe Transaction is associated with some other money movement not listed above.outbound_paymentThe Transaction is associated with an OutboundPayment.outbound_transferThe Transaction is associated with an OutboundTransfer.received_creditThe Transaction is associated with a ReceivedCredit.received_debitThe Transaction is associated with a ReceivedDebit.
livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.status(enum) Status of the Transaction. Possible enum values:openThe initial state for all Transactions. The Transaction results in updates to the sub-balance amounts, but the current balance is not affected until the Transaction posts.postedFunds have successfully entered or left the account. The current balance was affected.voidThe Transaction never impacted the balance. For example, a Transaction would enter this state if an OutboundPayment was initiated but then canceled before the funds left the account.
status_transitions(object) Hash containing timestamps of when the object transitioned to a particularstatus.status_transitions.posted_at(timestamp, nullable) Timestamp describing when the Transaction changed status toposted.status_transitions.void_at(timestamp, nullable) Timestamp describing when the Transaction changed status tovoid.
The Transaction object
json
{
"id": "trxn_1MtkYw2eZvKYlo2ClMGIO54z",
"object": "treasury.transaction",
"amount": -100,
"balance_impact": {
"cash": -100,
"inbound_pending": 0,
"outbound_pending": 100
},
"created": 1680755802,
"currency": "usd",
"description": "Jane Austen (6789) | Outbound transfer | transfer",
"financial_account": "fa_1MtkYw2eZvKYlo2CrqmzUo3O",
"flow": "obt_1MtkYw2eZvKYlo2CqsyBpQts",
"flow_type": "outbound_transfer",
"livemode": false,
"status": "open",
"status_transitions": {
"posted_at": null,
"void_at": null
}
}