Stripe Documentation

The Shared Payment Granted Token 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.

  • agent_details (object, nullable) Details about the agent that issued this SharedPaymentGrantedToken.

    • agent_details.network_business_profile (string, nullable) The Stripe Profile ID of the agent that issued this SharedPaymentGrantedToken.

  • created (timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.

  • deactivated_at (timestamp, nullable) Time at which this SharedPaymentGrantedToken expires and can no longer be used to confirm a PaymentIntent.

  • deactivated_reason (enum, nullable) The reason why the SharedPaymentGrantedToken has been deactivated. Possible enum values:

    • consumedconsumed indicates that this token has been consumed due to hitting the allowed amount limit.

    • expiredexpired indicates that this token has expired.

    • resolvedresolved indicates that this token has been resolved by a seller.

    • revokedrevoked indicates that this token has been revoked by the issuer.

  • livemode (boolean) If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

  • payment_method_details (object, nullable) Details of the PaymentMethod that was shared via this token.

    • payment_method_details.acss_debit (object, nullable) If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.

      • payment_method_details.acss_debit.bank_name (string, nullable) Name of the bank associated with the bank account.

      • payment_method_details.acss_debit.fingerprint (string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

      • payment_method_details.acss_debit.institution_number (string, nullable) Institution number of the bank account.

      • payment_method_details.acss_debit.last4 (string, nullable) Last four digits of the bank account number.

      • payment_method_details.acss_debit.transit_number (string, nullable) Transit number of the bank account.

    • payment_method_details.affirm (object, nullable) If this is an affirm PaymentMethod, this hash contains details about the Affirm payment method.

    • payment_method_details.afterpay_clearpay (object, nullable) If this is an AfterpayClearpay PaymentMethod, this hash contains details about the AfterpayClearpay payment method.

    • payment_method_details.alipay (object, nullable) If this is an Alipay PaymentMethod, this hash contains details about the Alipay payment method.

    • payment_method_details.alma (object, nullable) If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.

    • payment_method_details.amazon_pay (object, nullable) If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.

    • payment_method_details.au_becs_debit (object, nullable) If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.

      • payment_method_details.au_becs_debit.bsb_number (string, nullable) Six-digit number identifying bank and branch associated with this bank account.

      • payment_method_details.au_becs_debit.fingerprint (string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

      • payment_method_details.au_becs_debit.last4 (string, nullable) Last four digits of the bank account number.

    • payment_method_details.bacs_debit (object, nullable) If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.

      • payment_method_details.bacs_debit.fingerprint (string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

      • payment_method_details.bacs_debit.last4 (string, nullable) Last four digits of the bank account number.

      • payment_method_details.bacs_debit.sort_code (string, nullable) Sort code of the bank account. (e.g., 10-20-30)

    • payment_method_details.bancontact (object, nullable) If this is a bancontact PaymentMethod, this hash contains details about the Bancontact payment method.

    • payment_method_details.billie (object, nullable) If this is a billie PaymentMethod, this hash contains details about the Billie payment method.

    • payment_method_details.billing_details (object, nullable) Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

      • payment_method_details.billing_details.address (object, nullable) Billing address.

        • payment_method_details.billing_details.address.city (string, nullable) City, district, suburb, town, or village.

        • payment_method_details.billing_details.address.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

        • payment_method_details.billing_details.address.line1 (string, nullable) Address line 1, such as the street, PO Box, or company name.

        • payment_method_details.billing_details.address.line2 (string, nullable) Address line 2, such as the apartment, suite, unit, or building.

        • payment_method_details.billing_details.address.postal_code (string, nullable) ZIP or postal code.

        • payment_method_details.billing_details.address.state (string, nullable) State, county, province, or region (ISO 3166-2).

      • payment_method_details.billing_details.email (string, nullable) Email address.

      • payment_method_details.billing_details.name (string, nullable) Full name.

      • payment_method_details.billing_details.phone (string, nullable) Billing phone number (including extension).

      • payment_method_details.billing_details.tax_id (string, nullable) Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.

    • payment_method_details.blik (object, nullable) If this is a blik PaymentMethod, this hash contains details about the BLIK payment method.

    • payment_method_details.boleto (object, nullable) If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.

      • payment_method_details.boleto.tax_id (string) Uniquely identifies the customer tax id (CNPJ or CPF)

    • payment_method_details.card (object, nullable) If this is a card PaymentMethod, this hash contains the user’s card details.

      • payment_method_details.card.brand (string) Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.

      • payment_method_details.card.checks (object, nullable) Checks on Card address and CVC if provided.

        • payment_method_details.card.checks.address_line1_check (string, nullable) If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked.

        • payment_method_details.card.checks.address_postal_code_check (string, nullable) If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked.

        • payment_method_details.card.checks.cvc_check (string, nullable) If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked.

      • payment_method_details.card.country (string, nullable) Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

      • payment_method_details.card.display_brand (string, nullable) The brand to use when displaying the card, this accounts for customer’s brand choice on dual-branded cards. Can be american_express, cartes_bancaires, diners_club, discover, eftpos_australia, interac, jcb, mastercard, union_pay, visa, or other and may contain more values in the future.

      • payment_method_details.card.exp_month (integer) Two-digit number representing the card’s expiration month.

      • payment_method_details.card.exp_year (integer) Four-digit number representing the card’s expiration year.

      • payment_method_details.card.fingerprint (string, nullable) Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

        As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card - one for India and one for the rest of the world.

      • payment_method_details.card.funding (string) Card funding type. Can be credit, debit, prepaid, or unknown.

      • payment_method_details.card.last4 (string) The last four digits of the card.

      • payment_method_details.card.networks (object, nullable) Contains information about card networks that can be used to process the payment.

        • payment_method_details.card.networks.available (array of strings) All networks available for selection via payment_method_options.card.network.

        • payment_method_details.card.networks.preferred (string, nullable) The preferred network for co-branded cards. Can be cartes_bancaires, mastercard, visa or invalid_preference if requested network is not valid for the card.

      • payment_method_details.card.wallet (object, nullable) If this Card is part of a card wallet, this contains the details of the card wallet.

        • payment_method_details.card.wallet.amex_express_checkout (object, nullable) If this is a amex_express_checkout card wallet, this hash contains details about the wallet.

        • payment_method_details.card.wallet.apple_pay (object, nullable) If this is a apple_pay card wallet, this hash contains details about the wallet.

        • payment_method_details.card.wallet.dynamic_last4 (string, nullable) (For tokenized numbers only.) The last four digits of the device account number.

        • payment_method_details.card.wallet.google_pay (object, nullable) If this is a google_pay card wallet, this hash contains details about the wallet.

        • payment_method_details.card.wallet.link (object, nullable) If this is a link card wallet, this hash contains details about the wallet.

        • payment_method_details.card.wallet.masterpass (object, nullable) If this is a masterpass card wallet, this hash contains details about the wallet.

          • payment_method_details.card.wallet.masterpass.billing_address (object, nullable) Owner’s verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

            • payment_method_details.card.wallet.masterpass.billing_address.city (string, nullable) City, district, suburb, town, or village.

            • payment_method_details.card.wallet.masterpass.billing_address.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

            • payment_method_details.card.wallet.masterpass.billing_address.line1 (string, nullable) Address line 1, such as the street, PO Box, or company name.

            • payment_method_details.card.wallet.masterpass.billing_address.line2 (string, nullable) Address line 2, such as the apartment, suite, unit, or building.

            • payment_method_details.card.wallet.masterpass.billing_address.postal_code (string, nullable) ZIP or postal code.

            • payment_method_details.card.wallet.masterpass.billing_address.state (string, nullable) State, county, province, or region (ISO 3166-2).

          • payment_method_details.card.wallet.masterpass.email (string, nullable) Owner’s verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

          • payment_method_details.card.wallet.masterpass.name (string, nullable) Owner’s verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

          • payment_method_details.card.wallet.masterpass.shipping_address (object, nullable) Owner’s verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

            • payment_method_details.card.wallet.masterpass.shipping_address.city (string, nullable) City, district, suburb, town, or village.

            • payment_method_details.card.wallet.masterpass.shipping_address.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

            • payment_method_details.card.wallet.masterpass.shipping_address.line1 (string, nullable) Address line 1, such as the street, PO Box, or company name.

            • payment_method_details.card.wallet.masterpass.shipping_address.line2 (string, nullable) Address line 2, such as the apartment, suite, unit, or building.

            • payment_method_details.card.wallet.masterpass.shipping_address.postal_code (string, nullable) ZIP or postal code.

            • payment_method_details.card.wallet.masterpass.shipping_address.state (string, nullable) State, county, province, or region (ISO 3166-2).

        • payment_method_details.card.wallet.samsung_pay (object, nullable) If this is a samsung_pay card wallet, this hash contains details about the wallet.

        • payment_method_details.card.wallet.type (enum) The type of the card wallet, one of amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout, or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. Possible enum values:

          • amex_express_checkout
          • apple_pay
          • google_pay
          • link
          • masterpass
          • samsung_pay
          • visa_checkout

        • payment_method_details.card.wallet.visa_checkout (object, nullable) If this is a visa_checkout card wallet, this hash contains details about the wallet.

          • payment_method_details.card.wallet.visa_checkout.billing_address (object, nullable) Owner’s verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

            • payment_method_details.card.wallet.visa_checkout.billing_address.city (string, nullable) City, district, suburb, town, or village.

            • payment_method_details.card.wallet.visa_checkout.billing_address.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

            • payment_method_details.card.wallet.visa_checkout.billing_address.line1 (string, nullable) Address line 1, such as the street, PO Box, or company name.

            • payment_method_details.card.wallet.visa_checkout.billing_address.line2 (string, nullable) Address line 2, such as the apartment, suite, unit, or building.

            • payment_method_details.card.wallet.visa_checkout.billing_address.postal_code (string, nullable) ZIP or postal code.

            • payment_method_details.card.wallet.visa_checkout.billing_address.state (string, nullable) State, county, province, or region (ISO 3166-2).

          • payment_method_details.card.wallet.visa_checkout.email (string, nullable) Owner’s verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

          • payment_method_details.card.wallet.visa_checkout.name (string, nullable) Owner’s verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

          • payment_method_details.card.wallet.visa_checkout.shipping_address (object, nullable) Owner’s verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

            • payment_method_details.card.wallet.visa_checkout.shipping_address.city (string, nullable) City, district, suburb, town, or village.

            • payment_method_details.card.wallet.visa_checkout.shipping_address.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

            • payment_method_details.card.wallet.visa_checkout.shipping_address.line1 (string, nullable) Address line 1, such as the street, PO Box, or company name.

            • payment_method_details.card.wallet.visa_checkout.shipping_address.line2 (string, nullable) Address line 2, such as the apartment, suite, unit, or building.

            • payment_method_details.card.wallet.visa_checkout.shipping_address.postal_code (string, nullable) ZIP or postal code.

            • payment_method_details.card.wallet.visa_checkout.shipping_address.state (string, nullable) State, county, province, or region (ISO 3166-2).

    • payment_method_details.card_present (object, nullable) If this is a card_present PaymentMethod, this hash contains details about the Card Present payment method.

      • payment_method_details.card_present.brand (string, nullable) Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.

      • payment_method_details.card_present.brand_product (string, nullable) The product code that identifies the specific program or product associated with a card.

      • payment_method_details.card_present.cardholder_name (string, nullable) The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.

      • payment_method_details.card_present.country (string, nullable) Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

      • payment_method_details.card_present.description (string, nullable) A high-level description of the type of cards issued in this range.

      • payment_method_details.card_present.exp_month (integer) Two-digit number representing the card’s expiration month.

      • payment_method_details.card_present.exp_year (integer) Four-digit number representing the card’s expiration year.

      • payment_method_details.card_present.fingerprint (string, nullable) Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

        As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card - one for India and one for the rest of the world.

      • payment_method_details.card_present.funding (string, nullable) Card funding type. Can be credit, debit, prepaid, or unknown.

      • payment_method_details.card_present.issuer (string, nullable) The name of the card’s issuing bank.

      • payment_method_details.card_present.last4 (string, nullable) The last four digits of the card.

      • payment_method_details.card_present.networks (object, nullable) Contains information about card networks that can be used to process the payment.

        • payment_method_details.card_present.networks.available (array of strings) All networks available for selection via payment_method_options.card.network.

        • payment_method_details.card_present.networks.preferred (string, nullable) The preferred network for the card.

      • payment_method_details.card_present.offline (object, nullable) Details about payment methods collected offline.

        • payment_method_details.card_present.offline.stored_at (timestamp, nullable) Time at which the payment was collected while offline

        • payment_method_details.card_present.offline.type (enum, nullable) The method used to process this payment method offline. Only deferred is allowed. Possible enum values:

          • deferred

      • payment_method_details.card_present.preferred_locales (array of strings, nullable) The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card’s chip.

      • payment_method_details.card_present.read_method (enum, nullable) How card details were read in this transaction. Possible enum values:

        • contact_emv Inserting a chip card into the card reader.

        • contactless_emv Tapping a contactless-enabled chip card or mobile wallet.

        • contactless_magstripe_mode Older standard for contactless payments that emulated a magnetic stripe read.

        • magnetic_stripe_fallback When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.

        • magnetic_stripe_track2 Swiping a card using the magnetic stripe reader.

      • payment_method_details.card_present.wallet (object, nullable) If a mobile wallet was presented in the transaction, this contains the details of the mobile wallet.

        • payment_method_details.card_present.wallet.type (enum) The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown. Possible enum values:

          • apple_pay Apple Pay is a mobile payment service by Apple.

          • google_pay Google Pay is a mobile payment service by Google.

          • samsung_pay Samsung Pay is a mobile payment service by Samsung Electronics.

          • unknown The wallet provider is unknown.

    • payment_method_details.cashapp (object, nullable) If this is a cashapp PaymentMethod, this hash contains details about the Cash App Pay payment method.

      • payment_method_details.cashapp.buyer_id (string, nullable) A unique and immutable identifier assigned by Cash App to every buyer.

      • payment_method_details.cashapp.cashtag (string, nullable) A public identifier for buyers using Cash App.

    • payment_method_details.crypto (object, nullable) If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.

    • payment_method_details.customer_balance (object, nullable) If this is a customer_balance PaymentMethod, this hash contains details about the CustomerBalance payment method.

    • payment_method_details.eps (object, nullable) If this is an eps PaymentMethod, this hash contains details about the EPS payment method.

      • payment_method_details.eps.bank (enum, nullable) The customer’s bank. Should be one of arzte_und_apotheker_bank, austrian_anadi_bank_ag, bank_austria, bankhaus_carl_spangler, bankhaus_schelhammer_und_schattera_ag, bawag_psk_ag, bks_bank_ag, brull_kallmus_bank_ag, btv_vier_lander_bank, capital_bank_grawe_gruppe_ag, deutsche_bank_ag, dolomitenbank, easybank_ag, erste_bank_und_sparkassen, hypo_alpeadriabank_international_ag, hypo_noe_lb_fur_niederosterreich_u_wien, hypo_oberosterreich_salzburg_steiermark, hypo_tirol_bank_ag, hypo_vorarlberg_bank_ag, hypo_bank_burgenland_aktiengesellschaft, marchfelder_bank, oberbank_ag, raiffeisen_bankengruppe_osterreich, schoellerbank_ag, sparda_bank_wien, volksbank_gruppe, volkskreditbank_ag, or vr_bank_braunau. Possible enum values:
        • arzte_und_apotheker_bank
        • austrian_anadi_bank_ag
        • bank_austria
        • bankhaus_carl_spangler
        • bankhaus_schelhammer_und_schattera_ag
        • bawag_psk_ag
        • bks_bank_ag
        • brull_kallmus_bank_ag
        • btv_vier_lander_bank
        • capital_bank_grawe_gruppe_ag
        • deutsche_bank_ag
        • dolomitenbank
        • easybank_ag
        • erste_bank_und_sparkassen
        • hypo_alpeadriabank_international_ag
        • hypo_bank_burgenland_aktiengesellschaft
        • hypo_noe_lb_fur_niederosterreich_u_wien
        • hypo_oberosterreich_salzburg_steiermark
        • hypo_tirol_bank_ag
        • hypo_vorarlberg_bank_ag
        • marchfelder_bank
        • oberbank_ag
        • raiffeisen_bankengruppe_osterreich
        • schoellerbank_ag
        • sparda_bank_wien
        • volksbank_gruppe
        • volkskreditbank_ag
        • vr_bank_braunau

    • payment_method_details.fpx (object, nullable) If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.

      • payment_method_details.fpx.bank (enum) The customer’s bank, if provided. Can be one of affin_bank, agrobank, alliance_bank, ambank, bank_islam, bank_muamalat, bank_rakyat, bsn, cimb, hong_leong_bank, hsbc, kfh, maybank2u, ocbc, public_bank, rhb, standard_chartered, uob, deutsche_bank, maybank2e, pb_enterprise, or bank_of_china. Possible enum values:
        • affin_bank
        • agrobank
        • alliance_bank
        • ambank
        • bank_islam
        • bank_muamalat
        • bank_of_china
        • bank_rakyat
        • bsn
        • cimb
        • deutsche_bank
        • hong_leong_bank
        • hsbc
        • kfh
        • maybank2e
        • maybank2u
        • ocbc
        • pb_enterprise
        • public_bank
        • rhb
        • standard_chartered
        • uob

    • payment_method_details.giropay (object, nullable) If this is a giropay PaymentMethod, this hash contains details about the Giropay payment method.

    • payment_method_details.grabpay (object, nullable) If this is a grabpay PaymentMethod, this hash contains details about the GrabPay payment method.

    • payment_method_details.ideal (object, nullable) If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.

      • payment_method_details.ideal.bank (enum, nullable) The customer’s bank, if provided. Can be one of abn_amro, adyen, asn_bank, bunq, buut, finom, handelsbanken, ing, knab, mollie, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, or yoursafe. Possible enum values:

        • abn_amro
        • adyen
        • asn_bank
        • bunq
        • buut
        • finom
        • handelsbanken
        • ing
        • knab
        • mollie
        • moneyou
        • n26
        • nn
        • rabobank
        • regiobank
        • revolut
        • sns_bank
        • triodos_bank
        • van_lanschot
        • yoursafe

      • payment_method_details.ideal.bic (enum, nullable) The Bank Identifier Code of the customer’s bank, if the bank was provided. Possible enum values:

        • ABNANL2A
        • ADYBNL2A
        • ASNBNL21
        • BITSNL2A
        • BUNQNL2A
        • BUUTNL2A
        • FNOMNL22
        • FVLBNL22
        • HANDNL2A
        • INGBNL2A
        • KNABNL2H
        • MLLENL2A
        • MOYONL21
        • NNBANL2G
        • NTSBDEB1
        • RABONL2U
        • RBRBNL21
        • REVOIE23
        • REVOLT21
        • SNSBNL2A
        • TRIONL2U

    • payment_method_details.interac_present (object, nullable) If this is an interac_present PaymentMethod, this hash contains details about the Interac Present payment method.

      • payment_method_details.interac_present.brand (string, nullable) Card brand. Can be interac, mastercard or visa.

      • payment_method_details.interac_present.cardholder_name (string, nullable) The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.

      • payment_method_details.interac_present.country (string, nullable) Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

      • payment_method_details.interac_present.description (string, nullable) A high-level description of the type of cards issued in this range.

      • payment_method_details.interac_present.exp_month (integer) Two-digit number representing the card’s expiration month.

      • payment_method_details.interac_present.exp_year (integer) Four-digit number representing the card’s expiration year.

      • payment_method_details.interac_present.fingerprint (string, nullable) Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

        As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card - one for India and one for the rest of the world.

      • payment_method_details.interac_present.funding (string, nullable) Card funding type. Can be credit, debit, prepaid, or unknown.

      • payment_method_details.interac_present.issuer (string, nullable) The name of the card’s issuing bank.

      • payment_method_details.interac_present.last4 (string, nullable) The last four digits of the card.

      • payment_method_details.interac_present.networks (object, nullable) Contains information about card networks that can be used to process the payment.

        • payment_method_details.interac_present.networks.available (array of strings) All networks available for selection via payment_method_options.card.network.

        • payment_method_details.interac_present.networks.preferred (string, nullable) The preferred network for the card.

      • payment_method_details.interac_present.preferred_locales (array of strings, nullable) The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card’s chip.

      • payment_method_details.interac_present.read_method (enum, nullable) How card details were read in this transaction. Possible enum values:

        • contact_emv Inserting a chip card into the card reader.

        • contactless_emv Tapping a contactless-enabled chip card or mobile wallet.

        • contactless_magstripe_mode Older standard for contactless payments that emulated a magnetic stripe read.

        • magnetic_stripe_fallback When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.

        • magnetic_stripe_track2 Swiping a card using the magnetic stripe reader.

    • payment_method_details.kakao_pay (object, nullable) If this is a kakao_pay PaymentMethod, this hash contains details about the Kakao Pay payment method.

    • payment_method_details.klarna (object, nullable) If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.

      • payment_method_details.klarna.dob (object, nullable, expandable (can be expanded into an object with the expand request parameter)) The customer’s date of birth, if provided.

        • payment_method_details.klarna.dob.day (integer, nullable) The day of birth, between 1 and 31.

        • payment_method_details.klarna.dob.month (integer, nullable) The month of birth, between 1 and 12.

        • payment_method_details.klarna.dob.year (integer, nullable) The four-digit year of birth.

    • payment_method_details.konbini (object, nullable) If this is a konbini PaymentMethod, this hash contains details about the Konbini payment method.

    • payment_method_details.kr_card (object, nullable) If this is a kr_card PaymentMethod, this hash contains details about the Korean Card payment method.

      • payment_method_details.kr_card.brand (enum, nullable) The local credit or debit card brand. Possible enum values:

        • bc BC

        • citi Citi

        • hana Hana

        • hyundai Hyundai

        • jeju Jeju

        • jeonbuk Jeonbuk

        • kakaobank Kakao Bank

        • kbank KBank

        • kdbbank KDB Bank

        • kookmin Kookmin

        • kwangju Kwangju

        • lotte Lotte

        • mg MG

        • nh NG

        • post Post

        • samsung Samsung

        • savingsbank Savings Bank

        • shinhan Shinhan

        • shinhyup Shinhyup

        • suhyup Suhyup

        • tossbank Toss Bank

        • woori Woori

      • payment_method_details.kr_card.last4 (string, nullable) The last four digits of the card. This may not be present for American Express cards.

        The maximum length is 4 characters.

    • payment_method_details.link (object, nullable) If this is an Link PaymentMethod, this hash contains details about the Link payment method.

      • payment_method_details.link.email (string, nullable) Account owner’s email address.

    • payment_method_details.mb_way (object, nullable) If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.

    • payment_method_details.mobilepay (object, nullable) If this is a mobilepay PaymentMethod, this hash contains details about the MobilePay payment method.

    • payment_method_details.multibanco (object, nullable) If this is a multibanco PaymentMethod, this hash contains details about the Multibanco payment method.

    • payment_method_details.naver_pay (object, nullable) If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.

      • payment_method_details.naver_pay.buyer_id (string, nullable) Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.

      • payment_method_details.naver_pay.funding (enum) Whether to fund this transaction with Naver Pay points or a card. Possible enum values:

        • card Use a card to fund this transaction.

        • points Use Naver Pay points to fund this transaction.

    • payment_method_details.nz_bank_account (object, nullable) If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.

      • payment_method_details.nz_bank_account.account_holder_name (string, nullable) The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.

      • payment_method_details.nz_bank_account.bank_code (string) The numeric code for the bank account’s bank.

      • payment_method_details.nz_bank_account.bank_name (string) The name of the bank.

      • payment_method_details.nz_bank_account.branch_code (string) The numeric code for the bank account’s bank branch.

      • payment_method_details.nz_bank_account.last4 (string) Last four digits of the bank account number.

      • payment_method_details.nz_bank_account.suffix (string, nullable) The suffix of the bank account number.

    • payment_method_details.oxxo (object, nullable) If this is an oxxo PaymentMethod, this hash contains details about the OXXO payment method.

    • payment_method_details.p24 (object, nullable) If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.

      • payment_method_details.p24.bank (enum, nullable) The customer’s bank, if provided.

    • payment_method_details.pay_by_bank (object, nullable) If this is a pay_by_bank PaymentMethod, this hash contains details about the PayByBank payment method.

    • payment_method_details.payco (object, nullable) If this is a payco PaymentMethod, this hash contains details about the PAYCO payment method.

    • payment_method_details.paynow (object, nullable) If this is a paynow PaymentMethod, this hash contains details about the PayNow payment method.

    • payment_method_details.paypal (object, nullable) If this is a paypal PaymentMethod, this hash contains details about the PayPal payment method.

      • payment_method_details.paypal.country (string, nullable) Two-letter ISO code representing the buyer’s country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

      • payment_method_details.paypal.payer_email (string, nullable) Owner’s email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

      • payment_method_details.paypal.payer_id (string, nullable) PayPal account PayerID. This identifier uniquely identifies the PayPal customer.

    • payment_method_details.paypay (object, nullable) If this is a paypay PaymentMethod, this hash contains details about the PayPay payment method.

    • payment_method_details.payto (object, nullable) If this is a payto PaymentMethod, this hash contains details about the PayTo payment method.

      • payment_method_details.payto.bsb_number (string, nullable) Bank-State-Branch number of the bank account.

      • payment_method_details.payto.last4 (string, nullable) Last four digits of the bank account number.

      • payment_method_details.payto.pay_id (string, nullable) The PayID alias for the bank account.

    • payment_method_details.pix (object, nullable) If this is a pix PaymentMethod, this hash contains details about the Pix payment method.

    • payment_method_details.promptpay (object, nullable) If this is a promptpay PaymentMethod, this hash contains details about the PromptPay payment method.

    • payment_method_details.revolut_pay (object, nullable) If this is a revolut_pay PaymentMethod, this hash contains details about the Revolut Pay payment method.

    • payment_method_details.samsung_pay (object, nullable) If this is a samsung_pay PaymentMethod, this hash contains details about the SamsungPay payment method.

    • payment_method_details.satispay (object, nullable) If this is a satispay PaymentMethod, this hash contains details about the Satispay payment method.

    • payment_method_details.sepa_debit (object, nullable) If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.

      • payment_method_details.sepa_debit.bank_code (string, nullable) Bank code of bank associated with the bank account.

      • payment_method_details.sepa_debit.branch_code (string, nullable) Branch code of bank associated with the bank account.

      • payment_method_details.sepa_debit.country (string, nullable) Two-letter ISO code representing the country the bank account is located in.

      • payment_method_details.sepa_debit.fingerprint (string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

      • payment_method_details.sepa_debit.generated_from (object, nullable) Information about the object that generated this PaymentMethod.

        • payment_method_details.sepa_debit.generated_from.charge (string, nullable, expandable (can be expanded into an object with the expand request parameter)) The ID of the Charge that generated this PaymentMethod, if any.

        • payment_method_details.sepa_debit.generated_from.setup_attempt (string, nullable, expandable (can be expanded into an object with the expand request parameter)) The ID of the SetupAttempt that generated this PaymentMethod, if any.

      • payment_method_details.sepa_debit.last4 (string, nullable) Last four characters of the IBAN.

    • payment_method_details.sofort (object, nullable) If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.

      • payment_method_details.sofort.country (string, nullable) Two-letter ISO code representing the country the bank account is located in.

    • payment_method_details.sunbit (object, nullable) If this is a Sunbit PaymentMethod, this hash contains details about the Sunbit payment method.

    • payment_method_details.swish (object, nullable) If this is a swish PaymentMethod, this hash contains details about the Swish payment method.

    • payment_method_details.twint (object, nullable) If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.

    • payment_method_details.type (enum) The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. Possible enum values:

      • acss_debit Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).

      • affirm Affirm is a buy now, pay later payment method in the US.

      • afterpay_clearpay Afterpay / Clearpay is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.

      • alipay Alipay is a digital wallet payment method used in China.

      • alma Alma is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments.

      • amazon_pay Amazon Pay is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day.

      • au_becs_debit BECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).

      • bacs_debit Bacs Direct Debit is used to debit UK bank accounts.

      • bancontact Bancontact is a bank redirect payment method used in Belgium.

      • billie Billie is a payment method.

      • blik BLIK is a single-use payment method common in Poland.

      • boleto Boleto is a voucher-based payment method used in Brazil.

      • card Card payments are supported through many networks, card brands, and select Link funding sources.

      • card_present Stripe Terminal is used to collect in-person card payments.

      • cashapp Cash App Pay enables customers to frictionlessly authenticate payments in the Cash App using their stored balance or linked card.

      • crypto Stablecoin payments enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask.

      • custom Custom payment methods are user-defined payment methods that Stripe doesn’t process. You can’t use them in PaymentIntents or SetupIntents.

      • customer_balance Uses a customer’s cash balance for the payment.

      • eps EPS is an Austria-based bank redirect payment method.

      • fpx FPX is a Malaysia-based bank redirect payment method.

      • giropay giropay is a German bank redirect payment method.

      • grabpay GrabPay is a digital wallet payment method used in Southeast Asia.

      • ideal iDEAL is a Netherlands-based bank redirect payment method.

      • interac_present Stripe Terminal accepts Interac debit cards for in-person payments in Canada.

      • kakao_pay Kakao Pay is a digital wallet payment method used in South Korea.

      • klarna Klarna is a global buy now, pay later payment method.

      • konbini Konbini is a cash-based voucher payment method used in Japan.

      • kr_card Korean cards enables customers to accept local credit and debit cards in South Korea.

      • link Link allows customers to pay with their saved payment details.

      • mb_way MB WAY is a payment method.

      • mobilepay MobilePay is a Nordic card-passthrough wallet payment method where customers authorize the payment in the MobilePay application.

      • multibanco Multibanco is a voucher payment method

      • naver_pay Naver Pay is a digital wallet payment method used in South Korea.

      • nz_bank_account New Zealand BECS Direct Debit is used to debit New Zealand bank accounts through the Bulk Electronic Clearing System (BECS).

      • oxxo OXXO is a cash-based voucher payment method used in Mexico.

      • p24 Przelewy24 is a bank redirect payment method used in Poland.

      • pay_by_bank Pay By Bank is an open banking payment method in the UK.

      • payco PAYCO is a digital wallet payment method used in South Korea.

      • paynow PayNow is a QR code payment method used in Singapore.

      • paypal PayPal is an online wallet and redirect payment method commonly used in Europe.

      • paypay PayPay is a payment method.

      • payto PayTo is a real time payment method

      • pix Pix is an instant bank transfer payment method in Brazil.

      • promptpay PromptPay is an instant funds transfer service popular in Thailand.

      • revolut_pay Revolut Pay is a digital wallet payment method used in the United Kingdom.

      • samsung_pay Samsung Pay is a digital wallet payment method used in South Korea.

      • satispay Satispay is a payment method.

      • sepa_debit SEPA Direct Debit is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.

      • sofort Sofort is a bank redirect payment method used in Europe.

      • sunbit Sunbit is a payment method.

      • swish Swish is a Swedish wallet payment method where customers authorize the payment in the Swish application.

      • twint TWINT is a single-use payment method used in Switzerland.

      • upi UPI is an instant real-time payment system in India.

      • us_bank_account ACH Direct Debit is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.

      • wechat_pay WeChat Pay is a digital wallet payment method based in China.

      • zip Zip is a Buy now, pay later Payment Method

    • payment_method_details.upi (object, nullable) If this is a upi PaymentMethod, this hash contains details about the UPI payment method.

      • payment_method_details.upi.vpa (string, nullable) Customer’s unique Virtual Payment Address

    • payment_method_details.us_bank_account (object, nullable) If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.

      • payment_method_details.us_bank_account.account_holder_type (enum, nullable) Account holder type: individual or company. Possible enum values:

        • company Account belongs to a company

        • individual Account belongs to an individual

      • payment_method_details.us_bank_account.account_type (enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:

        • checking Bank account type is checking

        • savings Bank account type is savings

      • payment_method_details.us_bank_account.bank_name (string, nullable) The name of the bank.

      • payment_method_details.us_bank_account.financial_connections_account (string, nullable) The ID of the Financial Connections Account used to create the payment method.

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

      • payment_method_details.us_bank_account.last4 (string, nullable) Last four digits of the bank account number.

      • payment_method_details.us_bank_account.networks (object, nullable) Contains information about US bank account networks that can be used.

        • payment_method_details.us_bank_account.networks.preferred (string, nullable) The preferred network.

        • payment_method_details.us_bank_account.networks.supported (array of enums) All supported networks. Possible enum values:

          • ach
          • us_domestic_wire

      • payment_method_details.us_bank_account.routing_number (string, nullable) Routing number of the bank account.

      • payment_method_details.us_bank_account.status_details (object, nullable) Contains information about the future reusability of this PaymentMethod.

        • payment_method_details.us_bank_account.status_details.blocked (object, nullable) Contains more information about the underlying block. This field will only be rendered if the PaymentMethod is blocked.

          • payment_method_details.us_bank_account.status_details.blocked.network_code (enum, nullable) The ACH network code that resulted in this block. Possible enum values:

            • R02 Account Closed

            • R03 No Account, Unable to Locate Account

            • R04 Invalid Account Number Structure

            • R05 Unauthorized Debit to Consumer Account Using Corporate SEC Code

            • R07 Authorization Revoked By Consumer

            • R08 Payment Stopped

            • R10 Customer Advises Originator is Not Known to Receiver and/or Originator is Not Authorized by Receiver to Debit Receiver’s Account

            • R11 Customer Advises Entry Not in Accordance with the Terms of Authorization

            • R16 Account Frozen, Entry Returned Per OFAC Instructions

            • R20 Non-Transaction Account

            • R29 Corporate Customer Advises Not Authorized

            • R31 Permissible Return Entry (CCD and CTX only)

          • payment_method_details.us_bank_account.status_details.blocked.reason (enum, nullable) The reason why this PaymentMethod’s fingerprint has been blocked Possible enum values:

            • bank_account_closed Bank account has been closed.

            • bank_account_frozen Bank account has been frozen.

            • bank_account_invalid_details Bank account details are incorrect. Please check the account number, routing number, account holder name, and account type.

            • bank_account_restricted Bank account does not support debits.

            • bank_account_unusable Bank account has been blocked by Stripe. Please contact Support.

            • debit_not_authorized Customer has disputed a previous payment with their bank. If the network_code is R29, please confirm that Stripe’s Company IDs are allowlisted before attempting additional payments.

            • tokenized_account_number_deactivated Bank account’s tokenized account number is invalid. Please use a different account.

    • payment_method_details.wechat_pay (object, nullable) If this is an wechat_pay PaymentMethod, this hash contains details about the wechat_pay payment method.

    • payment_method_details.zip (object, nullable) If this is a zip PaymentMethod, this hash contains details about the Zip payment method.

  • risk_details (object, nullable) Risk details of the SharedPaymentGrantedToken.

    • risk_details.insights (object) Risk insights for this token, including scores and recommended actions for each risk type.

      • risk_details.insights.bot (object, nullable) Bot risk insight.

        • risk_details.insights.bot.recommended_action (string) Recommended action for this insight.

        • risk_details.insights.bot.score (float) Risk score for this insight.

      • risk_details.insights.card_issuer_decline (object, nullable) Card issuer decline risk insight.

        • risk_details.insights.card_issuer_decline.recommended_action (string) Recommended action for this insight.

        • risk_details.insights.card_issuer_decline.score (float) Risk score for this insight.

      • risk_details.insights.card_testing (object, nullable) Card testing risk insight.

        • risk_details.insights.card_testing.recommended_action (string) Recommended action for this insight.

        • risk_details.insights.card_testing.score (float) Risk score for this insight.

      • risk_details.insights.fraudulent_dispute (object, nullable) Fraudulent dispute risk insight.

        • risk_details.insights.fraudulent_dispute.recommended_action (string) Recommended action for this insight.

        • risk_details.insights.fraudulent_dispute.score (integer) Risk score for this insight.

      • risk_details.insights.stolen_card (object, nullable) Stolen card risk insight.

        • risk_details.insights.stolen_card.recommended_action (string) Recommended action for this insight.

        • risk_details.insights.stolen_card.score (integer) Risk score for this insight.

  • shared_metadata (object, nullable) Metadata about the SharedPaymentGrantedToken.

  • usage_details (object, nullable) Some details about how the SharedPaymentGrantedToken has been used already.

    • usage_details.amount_captured (object, nullable) The total amount captured using this SharedPaymentToken.

      • usage_details.amount_captured.currency (enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.

      • usage_details.amount_captured.value (integer) Integer value of the amount in the smallest currency unit.

  • usage_limits (object, nullable) Limits on how this SharedPaymentGrantedToken can be used.

    • usage_limits.currency (string) Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • usage_limits.expires_at (timestamp, nullable) Time at which this SharedPaymentToken expires and can no longer be used to confirm a PaymentIntent.

    • usage_limits.max_amount (integer) Max amount that can be captured using this SharedPaymentToken.

The Shared Payment Granted Token object ​

json
{
  "id": "spt_1RgaZcFPC5QUO6ZCDVZuVA8q",
  "object": "shared_payment.granted_token",
  "agent_details": {
    "network_business_profile": "profile_test_61U92KWAstyE3VYhXA6U91t01FSQ3ByrZzKJOCR0y5ey"
  },
  "created": 1751500820,
  "deactivated_at": null,
  "deactivated_reason": null,
  "livemode": false,
  "payment_method_details": {
    "type": "card",
    "billing_details": {
      "address": {
        "city": null,
        "country": null,
        "line1": null,
        "line2": null,
        "postal_code": null,
        "state": null
      },
      "email": null,
      "name": "John Doe",
      "phone": null
    },
    "card": {
      "brand": "visa",
      "country": "US",
      "display_brand": "visa",
      "exp_month": 9,
      "exp_year": 2029,
      "fingerprint": "dyRcYjZNxnHpC51l",
      "funding": "credit",
      "last4": "4242",
      "networks": {
        "available": [
          "visa"
        ],
        "preferred": null
      },
      "wallet": null
    }
  },
  "shared_metadata": {},
  "usage_details": {
    "amount_captured": {
      "value": 0,
      "currency": "usd"
    }
  },
  "usage_limits": {
    "currency": "usd",
    "expires_at": 1751587220,
    "max_amount": 1000
  }
}

Stripe API Reference - Self-contained docs reference, refreshed 2026-05-18