The Authorization object 

Attributes

• idstring

  Unique identifier for the object.

• amountinteger

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

• approvedboolean

  Whether the authorization has been approved.

• cardobject

  Card associated with this authorization.

  Hide child attributes

  • card.idstring

    Unique identifier for the object.

  • card.objectstring

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

  • card.brandstring

    The brand of the card.

  • card.cancellation_reasonnullable enum

    The reason why the card was canceled.

    Possible enum values

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

    lost The card was lost.

    stolen The card was stolen.

  • card.cardholderobject

    The Cardholder object to which the card belongs.

    Hide child attributes

    • card.cardholder.idstring

      Unique identifier for the object.

    • card.cardholder.objectstring

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

    • card.cardholder.billingobject

      The cardholder’s billing information.

      Hide child attributes

      • card.cardholder.billing.addressobject

        The cardholder’s billing address.

        Hide child attributes

        • card.cardholder.billing.address.citynullable string

          City, district, suburb, town, or village.

        • card.cardholder.billing.address.countrynullable string

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

        • card.cardholder.billing.address.line1nullable string

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

        • card.cardholder.billing.address.line2nullable string

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

        • card.cardholder.billing.address.postal_codenullable string

          ZIP or postal code.

        • card.cardholder.billing.address.statenullable string

          State, county, province, or region.

    • card.cardholder.companynullable object

      Additional information about a company cardholder.

      Hide child attributes

      • card.cardholder.company.tax_id_providedboolean

        Whether the company’s business ID number was provided.

    • card.cardholder.createdtimestamp

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

    • card.cardholder.emailnullable string

      The cardholder’s email address.

    • card.cardholder.individualnullable object

      Additional information about an individual cardholder.

      Hide child attributes

      • card.cardholder.individual.card_issuingnullable object

        Information related to the card_issuing program for this cardholder.

        Hide child attributes

        • card.cardholder.individual.card_issuing.user_terms_acceptancenullable object

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

          Hide child attributes

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

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

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

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

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

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

      • card.cardholder.individual.dobnullable object

        The date of birth of this cardholder.

        Hide child attributes

        • card.cardholder.individual.dob.daynullable integer

          The day of birth, between 1 and 31.

        • card.cardholder.individual.dob.monthnullable integer

          The month of birth, between 1 and 12.

        • card.cardholder.individual.dob.yearnullable integer

          The four-digit year of birth.

      • card.cardholder.individual.first_namenullable string

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

      • card.cardholder.individual.last_namenullable string

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

      • card.cardholder.individual.verificationnullable object

        Government-issued ID document for this cardholder.

        Hide child attributes

        • card.cardholder.individual.verification.documentnullable object

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

          Hide child attributes

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

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

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

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

    • card.cardholder.livemodeboolean

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

    • card.cardholder.metadataobject

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • card.cardholder.namestring

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

    • card.cardholder.phone_numbernullable string

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

    • card.cardholder.preferred_localesnullable array of enums

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

    • card.cardholder.requirementsobject

      Information about verification requirements for the cardholder.

      Hide child attributes

      • card.cardholder.requirements.disabled_reasonnullable enum

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

        Possible enum values

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

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

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

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

      • card.cardholder.requirements.past_duenullable array of enums

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

        Possible enum values

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

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

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

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

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

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

        individual.first_name The cardholder’s legal first name.

        individual.last_name The cardholder’s legal last name.

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

    • card.cardholder.spending_controlsnullable object

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

      Hide child attributes

      • card.cardholder.spending_controls.allowed_categoriesnullable array of enums

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

        Possible enum values

        ac_refrigeration_repair

        accounting_bookkeeping_services

        advertising_services

        agricultural_cooperative

        airlines_air_carriers

        airports_flying_fields

        ambulance_services

        amusement_parks_carnivals

        antique_reproductions

        antique_shops

        Show 285 more

      • card.cardholder.spending_controls.allowed_merchant_countriesnullable array of strings

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

      • card.cardholder.spending_controls.blocked_categoriesnullable array of enums

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

        Possible enum values

        ac_refrigeration_repair

        accounting_bookkeeping_services

        advertising_services

        agricultural_cooperative

        airlines_air_carriers

        airports_flying_fields

        ambulance_services

        amusement_parks_carnivals

        antique_reproductions

        antique_shops

        Show 285 more

      • card.cardholder.spending_controls.blocked_merchant_countriesnullable array of strings

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

      • card.cardholder.spending_controls.spending_limitsnullable array of objects

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

        Hide child attributes

        • card.cardholder.spending_controls.spending_limits.amountinteger

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

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

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

          Possible enum values

          ac_refrigeration_repair

          accounting_bookkeeping_services

          advertising_services

          agricultural_cooperative

          airlines_air_carriers

          airports_flying_fields

          ambulance_services

          amusement_parks_carnivals

          antique_reproductions

          antique_shops

          Show 285 more

        • card.cardholder.spending_controls.spending_limits.intervalenum

          Interval (or event) to which the amount applies.

          Possible enum values

          all_time Limit applies to all transactions.

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

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

          per_authorization Limit applies to each authorization.

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

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

      • card.cardholder.spending_controls.spending_limits_currencynullable enum

        Currency of the amounts within spending_limits.

    • card.cardholder.statusenum

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

      Possible enum values

      active Cards attached to this cardholder can approve authorizations.

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

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

    • card.cardholder.typeenum

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

      Possible enum values

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

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

  • card.createdtimestamp

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

  • card.currencyenum

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

  • card.cvcnullable stringExpandable

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

  • card.exp_monthinteger

    The expiration month of the card.

  • card.exp_yearinteger

    The expiration year of the card.

  • card.last4string

    The last 4 digits of the card number.

  • card.livemodeboolean

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

  • card.metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • card.numbernullable stringExpandable

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

  • card.personalization_designnullable stringExpandable

    The personalization design object belonging to this card.

  • card.replaced_bynullable stringExpandable

    The latest card that replaces this card, if any.

  • card.replacement_fornullable stringExpandable

    The card this card replaces, if any.

  • card.replacement_reasonnullable enum

    The reason why the previous card needed to be replaced.

    Possible enum values

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

    expired The expiration date has passed or is imminent.

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

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

  • card.shippingnullable object

    Where and how the card will be shipped.

    Hide child attributes

    • card.shipping.addressobject

      Shipping address.

      Hide child attributes

      • card.shipping.address.citynullable string

        City, district, suburb, town, or village.

      • card.shipping.address.countrynullable string

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

      • card.shipping.address.line1nullable string

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

      • card.shipping.address.line2nullable string

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

      • card.shipping.address.postal_codenullable string

        ZIP or postal code.

      • card.shipping.address.statenullable string

        State, county, province, or region.

    • card.shipping.address_validationnullable object

      Address validation details for the shipment.

      Hide child attributes

      • card.shipping.address_validation.modeenum

        The address validation capabilities to use.

        Possible enum values

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

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

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

      • card.shipping.address_validation.normalized_addressnullable object

        The normalized shipping address.

        Hide child attributes

        • card.shipping.address_validation.normalized_address.citynullable string

          City, district, suburb, town, or village.

        • card.shipping.address_validation.normalized_address.countrynullable string

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

        • card.shipping.address_validation.normalized_address.line1nullable string

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

        • card.shipping.address_validation.normalized_address.line2nullable string

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

        • card.shipping.address_validation.normalized_address.postal_codenullable string

          ZIP or postal code.

        • card.shipping.address_validation.normalized_address.statenullable string

          State, county, province, or region.

      • card.shipping.address_validation.resultnullable enum

        The validation result for the shipping address.

        Possible enum values

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

        likely_deliverable The card’s shipping address is likely deliverable.

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

    • card.shipping.carriernullable enum

      The delivery company that shipped a card.

      Possible enum values

      dhl DHL

      fedex FedEx

      royal_mail Royal Mail

      usps USPS

    • card.shipping.customsnullable object

      Additional information that may be required for clearing customs.

      Hide child attributes

      • card.shipping.customs.eori_numbernullable string

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

    • card.shipping.etanullable timestamp

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

    • card.shipping.namestring

      Recipient name.

    • card.shipping.phone_numbernullable string

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

    • card.shipping.require_signaturenullable boolean

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

    • card.shipping.serviceenum

      Shipment service, such as standard or express.

      Possible enum values

      express Cards arrive in 4 business days.

      priority Cards arrive in 2-3 business days.

      standard Cards arrive in 5-8 business days.

    • card.shipping.statusnullable enum

      The delivery status of the card.

      Possible enum values

      canceled The card was canceled before being shipped.

      delivered The card has been delivered to its destination.

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

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

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

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

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

    • card.shipping.tracking_numbernullable string

      A tracking number for a card shipment.

    • card.shipping.tracking_urlnullable string

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

    • card.shipping.typeenum

      Packaging options.

      Possible enum values

      bulk Cards are grouped and mailed together.

      individual Cards are sent individually in an envelope.

  • card.spending_controlsobject

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

    Hide child attributes

    • card.spending_controls.allowed_categoriesnullable array of enums

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

      Possible enum values

      ac_refrigeration_repair

      accounting_bookkeeping_services

      advertising_services

      agricultural_cooperative

      airlines_air_carriers

      airports_flying_fields

      ambulance_services

      amusement_parks_carnivals

      antique_reproductions

      antique_shops

      Show 285 more

    • card.spending_controls.allowed_merchant_countriesnullable array of strings

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

    • card.spending_controls.blocked_categoriesnullable array of enums

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

      Possible enum values

      ac_refrigeration_repair

      accounting_bookkeeping_services

      advertising_services

      agricultural_cooperative

      airlines_air_carriers

      airports_flying_fields

      ambulance_services

      amusement_parks_carnivals

      antique_reproductions

      antique_shops

      Show 285 more

    • card.spending_controls.blocked_merchant_countriesnullable array of strings

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

    • card.spending_controls.spending_limitsnullable array of objects

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

      Hide child attributes

      • card.spending_controls.spending_limits.amountinteger

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

      • card.spending_controls.spending_limits.categoriesnullable array of enums

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

        Possible enum values

        ac_refrigeration_repair

        accounting_bookkeeping_services

        advertising_services

        agricultural_cooperative

        airlines_air_carriers

        airports_flying_fields

        ambulance_services

        amusement_parks_carnivals

        antique_reproductions

        antique_shops

        Show 285 more

      • card.spending_controls.spending_limits.intervalenum

        Interval (or event) to which the amount applies.

        Possible enum values

        all_time Limit applies to all transactions.

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

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

        per_authorization Limit applies to each authorization.

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

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

    • card.spending_controls.spending_limits_currencynullable enum

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

  • card.statusenum

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

    Possible enum values

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

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

    inactive The card will decline authorizations with the card_inactive reason.

  • card.typeenum

    The type of the card.

    Possible enum values

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

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

  • card.walletsnullable object

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

    Hide child attributes

    • card.wallets.apple_payobject

      Apple Pay Details

      Hide child attributes

      • card.wallets.apple_pay.eligibleboolean

        Apple Pay Eligibility

      • card.wallets.apple_pay.ineligible_reasonnullable enum

        Reason the card is ineligible for Apple Pay

        Possible enum values

        missing_agreement Apple Pay is not enabled for your account.

        missing_cardholder_contact Cardholder phone number or email required.

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

    • card.wallets.google_payobject

      Google Pay Details

      Hide child attributes

      • card.wallets.google_pay.eligibleboolean

        Google Pay Eligibility

      • card.wallets.google_pay.ineligible_reasonnullable enum

        Reason the card is ineligible for Google Pay

        Possible enum values

        missing_agreement Google Pay is not enabled for your account.

        missing_cardholder_contact Cardholder phone number or email required.

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

    • card.wallets.primary_account_identifiernullable string

      Unique identifier for a card used with digital wallets

• cardholdernullable stringExpandable

  The cardholder to whom this authorization belongs.

• currencyenum

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

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• statusenum

  The current status of the authorization in its lifecycle.

  Possible enum values

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

  expired The authorization was expired without capture.

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

  reversed The authorization was reversed by the merchant.

More attributes

Collapse all

• objectstring

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

• amount_detailsnullable object

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

  Hide child attributes

  • amount_details.atm_feenullable integer

    The fee charged by the ATM for the cash withdrawal.

  • amount_details.cashback_amountnullable integer

    The amount of cash requested by the cardholder.

• authorization_methodenum

  How the card details were provided.

  Possible enum values

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

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

  keyed_in The card number was manually entered into a terminal.

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

  swipe The card was physically swiped in a terminal.

• balance_transactionsarray of objects

  List of balance transactions associated with this authorization.

  Hide child attributes

  • balance_transactions.idstring

    Unique identifier for the object.

  • balance_transactions.objectstring

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

  • balance_transactions.amountinteger

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

  • balance_transactions.available_ontimestamp

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

  • balance_transactions.balance_typeenumPreview feature

    The balance that this transaction impacts.

    Possible enum values

    issuing Balance Transactions that affect your Issuing balance

    payments Balance Transactions that affect your Payments balance

    refund_and_dispute_prefunding Balance Transactions that affect your Refund and Dispute Prefunding balance

  • balance_transactions.createdtimestamp

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

  • balance_transactions.currencyenum

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

  • balance_transactions.descriptionnullable string

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

  • balance_transactions.exchange_ratenullable float

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

  • balance_transactions.feeinteger

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

  • balance_transactions.fee_detailsarray of objects

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

    Hide child attributes

    • balance_transactions.fee_details.amountinteger

      Amount of the fee, in cents.

    • balance_transactions.fee_details.applicationnullable string

      ID of the Connect application that earned the fee.

    • balance_transactions.fee_details.currencyenum

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

    • balance_transactions.fee_details.descriptionnullable string

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

    • balance_transactions.fee_details.typestring

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

  • balance_transactions.netinteger

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

  • balance_transactions.reporting_categorystring

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

  • balance_transactions.sourcenullable stringExpandable

    This transaction relates to the Stripe object.

  • balance_transactions.statusstring

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

  • balance_transactions.typeenum

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

    Possible enum values

    adjustment

    advance

    advance_funding

    anticipation_repayment

    application_fee

    application_fee_refund

    charge

    climate_order_purchase

    climate_order_refund

    connect_collection_transfer

    Show 34 more

• createdtimestamp

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

• fleetnullable object

  Fleet-specific information for authorizations using Fleet cards.

  Hide child attributes

  • fleet.cardholder_prompt_datanullable object

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

    Hide child attributes

    • fleet.cardholder_prompt_data.alphanumeric_idnullable string

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

    • fleet.cardholder_prompt_data.driver_idnullable string

      Driver ID.

    • fleet.cardholder_prompt_data.odometernullable integer

      Odometer reading.

    • fleet.cardholder_prompt_data.unspecified_idnullable string

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

    • fleet.cardholder_prompt_data.user_idnullable string

      User ID.

    • fleet.cardholder_prompt_data.vehicle_numbernullable string

      Vehicle number.

  • fleet.purchase_typenullable enum

    The type of purchase.

    Possible enum values

    fuel_and_non_fuel_purchase Fuel and non-fuel purchase.

    fuel_purchase Fuel-only purchase.

    non_fuel_purchase Non-fuel purchase.

  • fleet.reported_breakdownnullable object

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

    Hide child attributes

    • fleet.reported_breakdown.fuelnullable object

      Breakdown of fuel portion of the purchase.

      Hide child attributes

      • fleet.reported_breakdown.fuel.gross_amount_decimalnullable decimal string

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

    • fleet.reported_breakdown.non_fuelnullable object

      Breakdown of non-fuel portion of the purchase.

      Hide child attributes

      • fleet.reported_breakdown.non_fuel.gross_amount_decimalnullable decimal string

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

    • fleet.reported_breakdown.taxnullable object

      Information about tax included in this transaction.

      Hide child attributes

      • fleet.reported_breakdown.tax.local_amount_decimalnullable decimal string

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

      • fleet.reported_breakdown.tax.national_amount_decimalnullable decimal string

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

  • fleet.service_typenullable enum

    The type of fuel service.

    Possible enum values

    full_service Full-service fuel station purchase.

    non_fuel_transaction Non-fuel transaction.

    self_service Self-service fuel station purchase.

• fraud_challengesnullable array of objectsExpandable

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

  Hide child attributes

  • fraud_challenges.channelenum

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

    Possible enum values

    sms SMS sent to the cardholder’s phone number.

  • fraud_challenges.statusenum

    The status of the fraud challenge.

    Possible enum values

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

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

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

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

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

  • fraud_challenges.undeliverable_reasonnullable enum

    If the challenge is not deliverable, the reason why.

    Possible enum values

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

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

• fuelnullable object

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

  Hide child attributes

  • fuel.industry_product_codenullable string

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

  • fuel.quantity_decimalnullable decimal string

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

  • fuel.typenullable enum

    The type of fuel that was purchased.

    Possible enum values

    diesel Diesel.

    other Other.

    unleaded_plus Unleaded plus.

    unleaded_regular Unleaded regular.

    unleaded_super Unleaded super.

  • fuel.unitnullable enum

    The units for quantity_decimal.

    Possible enum values

    charging_minute Charging minute.

    imperial_gallon Imperial gallon.

    kilogram Kilogram.

    kilowatt_hour Kilowatt-hour.

    liter Liter.

    other Other.

    pound Pound.

    us_gallon US gallon.

  • fuel.unit_cost_decimalnullable decimal string

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

• livemodeboolean

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

• merchant_amountinteger

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

• merchant_currencyenum

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

• merchant_dataobject

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

  Hide child attributes

  • merchant_data.categorystring

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

  • merchant_data.category_codestring

    The merchant category code for the seller’s business

  • merchant_data.citynullable string

    City where the seller is located

  • merchant_data.countrynullable string

    Country where the seller is located

  • merchant_data.namenullable string

    Name of the seller

  • merchant_data.network_idstring

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

  • merchant_data.postal_codenullable string

    Postal code where the seller is located

  • merchant_data.statenullable string

    State where the seller is located

  • merchant_data.tax_idnullable string

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

  • merchant_data.terminal_idnullable string

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

  • merchant_data.urlnullable string

    URL provided by the merchant on a 3DS request

• network_datanullable object

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

  Hide child attributes

  • network_data.acquiring_institution_idnullable string

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

  • network_data.system_trace_audit_numbernullable string

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

  • network_data.transaction_idnullable string

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

• pending_requestnullable object

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

  Hide child attributes

  • pending_request.amountinteger

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

  • pending_request.amount_detailsnullable object

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

    Hide child attributes

    • pending_request.amount_details.atm_feenullable integer

      The fee charged by the ATM for the cash withdrawal.

    • pending_request.amount_details.cashback_amountnullable integer

      The amount of cash requested by the cardholder.

  • pending_request.currencyenum

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

  • pending_request.is_amount_controllableboolean

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

  • pending_request.merchant_amountinteger

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

  • pending_request.merchant_currencyenum

    The local currency the merchant is requesting to authorize.

  • pending_request.network_risk_scorenullable integer

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

• request_historyarray of objects

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

  Hide child attributes

  • request_history.amountinteger

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

  • request_history.amount_detailsnullable object

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

    Hide child attributes

    • request_history.amount_details.atm_feenullable integer

      The fee charged by the ATM for the cash withdrawal.

    • request_history.amount_details.cashback_amountnullable integer

      The amount of cash requested by the cardholder.

  • request_history.approvedboolean

    Whether this request was approved.

  • request_history.authorization_codenullable string

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

  • request_history.createdtimestamp

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

  • request_history.currencystring

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

  • request_history.merchant_amountinteger

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

  • request_history.merchant_currencystring

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

  • request_history.network_risk_scorenullable integer

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

  • request_history.reasonenum

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

    Possible enum values

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

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

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

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

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

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

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

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

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

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

    Show 10 more

  • request_history.reason_messagenullable string

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

  • request_history.requested_atnullable timestamp

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

• tokennullable stringPreview featureExpandable

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

• transactionsarray of objects

  List of transactions associated with this authorization.

  Hide child attributes

  • transactions.idstring

    Unique identifier for the object.

  • transactions.objectstring

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

  • transactions.amountinteger

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

  • transactions.amount_detailsnullable object

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

    Hide child attributes

    • transactions.amount_details.atm_feenullable integer

      The fee charged by the ATM for the cash withdrawal.

    • transactions.amount_details.cashback_amountnullable integer

      The amount of cash requested by the cardholder.

  • transactions.authorizationnullable stringExpandable

    The Authorization object that led to this transaction.

  • transactions.balance_transactionnullable stringExpandable

    ID of the balance transaction associated with this transaction.

  • transactions.cardstringExpandable

    The card used to make this transaction.

  • transactions.cardholdernullable stringExpandable

    The cardholder to whom this transaction belongs.

  • transactions.createdtimestamp

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

  • transactions.currencyenum

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

  • transactions.disputenullable stringExpandable

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

  • transactions.livemodeboolean

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

  • transactions.merchant_amountinteger

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

  • transactions.merchant_currencyenum

    The currency with which the merchant is taking payment.

  • transactions.merchant_dataobject

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

    Hide child attributes

    • transactions.merchant_data.categorystring

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

    • transactions.merchant_data.category_codestring

      The merchant category code for the seller’s business

    • transactions.merchant_data.citynullable string

      City where the seller is located

    • transactions.merchant_data.countrynullable string

      Country where the seller is located

    • transactions.merchant_data.namenullable string

      Name of the seller

    • transactions.merchant_data.network_idstring

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

    • transactions.merchant_data.postal_codenullable string

      Postal code where the seller is located

    • transactions.merchant_data.statenullable string

      State where the seller is located

    • transactions.merchant_data.tax_idnullable string

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

    • transactions.merchant_data.terminal_idnullable string

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

    • transactions.merchant_data.urlnullable string

      URL provided by the merchant on a 3DS request

  • transactions.metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • transactions.network_datanullable object

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

    Hide child attributes

    • transactions.network_data.authorization_codenullable string

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

    • transactions.network_data.processing_datenullable string

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

    • transactions.network_data.transaction_idnullable string

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

  • transactions.purchase_detailsnullable objectExpandable

    Additional purchase information that is optionally provided by the merchant.

    Hide child attributes

    • transactions.purchase_details.fleetnullable object

      Fleet-specific information for transactions using Fleet cards.

      Hide child attributes

      • transactions.purchase_details.fleet.cardholder_prompt_datanullable object

        Answers to prompts presented to cardholder at point of sale.

        Hide child attributes

        • transactions.purchase_details.fleet.cardholder_prompt_data.driver_idnullable string

          Driver ID.

        • transactions.purchase_details.fleet.cardholder_prompt_data.odometernullable integer

          Odometer reading.

        • transactions.purchase_details.fleet.cardholder_prompt_data.unspecified_idnullable string

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

        • transactions.purchase_details.fleet.cardholder_prompt_data.user_idnullable string

          User ID.

        • transactions.purchase_details.fleet.cardholder_prompt_data.vehicle_numbernullable string

          Vehicle number.

      • transactions.purchase_details.fleet.purchase_typenullable string

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

      • transactions.purchase_details.fleet.reported_breakdownnullable object

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

        Hide child attributes

        • transactions.purchase_details.fleet.reported_breakdown.fuelnullable object

          Breakdown of fuel portion of the purchase.

          Hide child attributes

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

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

        • transactions.purchase_details.fleet.reported_breakdown.non_fuelnullable object

          Breakdown of non-fuel portion of the purchase.

          Hide child attributes

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

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

        • transactions.purchase_details.fleet.reported_breakdown.taxnullable object

          Information about tax included in this transaction.

          Hide child attributes

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

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

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

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

      • transactions.purchase_details.fleet.service_typenullable string

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

    • transactions.purchase_details.flightnullable object

      Information about the flight that was purchased with this transaction.

      Hide child attributes

      • transactions.purchase_details.flight.departure_atnullable integer

        The time that the flight departed.

      • transactions.purchase_details.flight.passenger_namenullable string

        The name of the passenger.

      • transactions.purchase_details.flight.refundablenullable boolean

        Whether the ticket is refundable.

      • transactions.purchase_details.flight.segmentsnullable array of objects

        The legs of the trip.

        Hide child attributes

        • transactions.purchase_details.flight.segments.arrival_airport_codenullable string

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

        • transactions.purchase_details.flight.segments.carriernullable string

          The airline carrier code.

        • transactions.purchase_details.flight.segments.departure_airport_codenullable string

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

        • transactions.purchase_details.flight.segments.flight_numbernullable string

          The flight number.

        • transactions.purchase_details.flight.segments.service_classnullable string

          The flight’s service class.

        • transactions.purchase_details.flight.segments.stopover_allowednullable boolean

          Whether a stopover is allowed on this flight.

      • transactions.purchase_details.flight.travel_agencynullable string

        The travel agency that issued the ticket.

    • transactions.purchase_details.fuelnullable object

      Information about fuel that was purchased with this transaction.

      Hide child attributes

      • transactions.purchase_details.fuel.industry_product_codenullable string

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

      • transactions.purchase_details.fuel.quantity_decimalnullable decimal string

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

      • transactions.purchase_details.fuel.typestring

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

      • transactions.purchase_details.fuel.unitstring

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

      • transactions.purchase_details.fuel.unit_cost_decimaldecimal string

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

    • transactions.purchase_details.lodgingnullable object

      Information about lodging that was purchased with this transaction.

      Hide child attributes

      • transactions.purchase_details.lodging.check_in_atnullable integer

        The time of checking into the lodging.

      • transactions.purchase_details.lodging.nightsnullable integer

        The number of nights stayed at the lodging.

    • transactions.purchase_details.receiptnullable array of objects

      The line items in the purchase.

      Hide child attributes

      • transactions.purchase_details.receipt.descriptionnullable string

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

      • transactions.purchase_details.receipt.quantitynullable float

        The quantity of the item.

      • transactions.purchase_details.receipt.totalnullable integer

        The total for this line item in cents.

      • transactions.purchase_details.receipt.unit_costnullable integer

        The unit cost of the item in cents.

    • transactions.purchase_details.referencenullable string

      A merchant-specific order number.

  • transactions.tokennullable stringPreview featureExpandable

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

  • transactions.typeenum

    The nature of the transaction.

    Possible enum values

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

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

  • transactions.walletnullable enum

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

• verification_dataobject

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

  Hide child attributes

  • verification_data.address_line1_checkenum

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

    Possible enum values

    match Verification succeeded, values matched.

    mismatch Verification failed, values didn’t match.

    not_provided Verification was not performed because no value was provided.

  • verification_data.address_postal_code_checkenum

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

    Possible enum values

    match Verification succeeded, values matched.

    mismatch Verification failed, values didn’t match.

    not_provided Verification was not performed because no value was provided.

  • verification_data.authentication_exemptionnullable object

    The exemption applied to this authorization.

    Hide child attributes

    • verification_data.authentication_exemption.claimed_byenum

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

      Possible enum values

      acquirer Acquiring merchant.

      issuer Issuing user.

    • verification_data.authentication_exemption.typeenum

      The specific exemption claimed for this authorization.

      Possible enum values

      low_value_transaction Specifies an exemption for some low-value authorizations.

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

      unknown Specifies an unknown exemption type.

  • verification_data.cvc_checkenum

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

    Possible enum values

    match Verification succeeded, values matched.

    mismatch Verification failed, values didn’t match.

    not_provided Verification was not performed because no value was provided.

  • verification_data.expiry_checkenum

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

    Possible enum values

    match Verification succeeded, values matched.

    mismatch Verification failed, values didn’t match.

    not_provided Verification was not performed because no value was provided.

  • verification_data.postal_codenullable string

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

  • verification_data.three_d_securenullable object

    3D Secure details.

    Hide child attributes

    • verification_data.three_d_secure.resultenum

      The outcome of the 3D Secure authentication request.

      Possible enum values

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

      authenticated Authentication successful.

      failed Authentication failed.

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

• verified_by_fraud_challengenullable boolean

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

• walletnullable string

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