--- title: "List Payment Attempt Records" method: GET path: "/v1/payment_attempt_records" --- # List Payment Attempt Records `GET /v1/payment_attempt_records` List all the Payment Attempt Records attached to the specified Payment Record. ## Query parameters - `expand` string[] - `limit` integer - `payment_record` string, required - `starting_after` string ## Response `200` Successful response. - object — A list of PaymentAttemptRecords. - `data` PaymentAttemptRecord[], required - `amount` PaymentsPrimitivesPaymentRecordsResourceAmount, required — A representation of an amount of money, consisting of an amount and a currency. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `value` integer, required — A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. - `amount_authorized` PaymentsPrimitivesPaymentRecordsResourceAmount, required — A representation of an amount of money, consisting of an amount and a currency. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `value` integer, required — A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. - `amount_canceled` PaymentsPrimitivesPaymentRecordsResourceAmount, required — A representation of an amount of money, consisting of an amount and a currency. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `value` integer, required — A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. - `amount_failed` PaymentsPrimitivesPaymentRecordsResourceAmount, required — A representation of an amount of money, consisting of an amount and a currency. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `value` integer, required — A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. - `amount_guaranteed` PaymentsPrimitivesPaymentRecordsResourceAmount, required — A representation of an amount of money, consisting of an amount and a currency. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `value` integer, required — A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. - `amount_refunded` PaymentsPrimitivesPaymentRecordsResourceAmount, required — A representation of an amount of money, consisting of an amount and a currency. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `value` integer, required — A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. - `amount_requested` PaymentsPrimitivesPaymentRecordsResourceAmount, required — A representation of an amount of money, consisting of an amount and a currency. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `value` integer, required — A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. - `application` string, nullable — ID of the Connect application that created the PaymentAttemptRecord. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `customer_details` PaymentsPrimitivesPaymentRecordsResourceCustomerDetails — Information about the customer for this payment. - `customer` string, nullable — ID of the Stripe Customer associated with this payment. - `email` string, nullable — The customer's email address. - `name` string, nullable — The customer's name. - `phone` string, nullable — The customer's phone number. - `customer_presence` 'off_session' | 'on_session', nullable — Indicates whether the customer was present in your checkout flow during this payment. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'payment_attempt_record', required — String representing the object's type. Objects of the same type share the same value. - `payment_method_details` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails — Details about the Payment Method used in this payment attempt. - `ach_credit_transfer` PaymentMethodDetailsAchCreditTransfer - `account_number` string, nullable — Account number to transfer funds to. - `bank_name` string, nullable — Name of the bank associated with the routing number. - `routing_number` string, nullable — Routing transit number for the bank account to transfer funds to. - `swift_code` string, nullable — SWIFT code of the bank associated with the routing number. - `ach_debit` PaymentMethodDetailsAchDebit - `account_holder_type` 'company' | 'individual', nullable — Type of entity that holds the account. This can be either `individual` or `company`. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `country` string, nullable — Two-letter ISO code representing the country the bank account is located in. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `routing_number` string, nullable — Routing transit number of the bank account. - `acss_debit` PaymentMethodDetailsPaymentRecordAcssDebit - `bank_name` string, nullable — Name of the bank associated with the bank account. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `institution_number` string, nullable — Institution number of the bank account - `last4` string, nullable — Last four digits of the bank account number. - `mandate` string — ID of the mandate used to make this payment. - `transit_number` string, nullable — Transit number of the bank account. - `affirm` PaymentMethodDetailsPaymentRecordAffirm - `location` string — ID of the location that this reader is assigned to. - `reader` string — ID of the reader this transaction was made on. - `transaction_id` string, nullable — The Affirm transaction ID associated with this payment. - `afterpay_clearpay` PaymentMethodDetailsPaymentRecordAfterpayClearpay - `order_id` string, nullable — The Afterpay order ID associated with this payment intent. - `reference` string, nullable — Order identifier shown to the merchant in Afterpay's online portal. - `alipay` PaymentMethodDetailsPaymentRecordAlipay - `buyer_id` string — Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. - `fingerprint` string, nullable — Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. - `transaction_id` string, nullable — Transaction ID of this particular Alipay transaction. - `alma` PaymentMethodDetailsPaymentRecordAlma - `installments` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodAlmaDetailsResourceInstallments - `count` integer, required — The number of installments. - `transaction_id` string, nullable — The Alma transaction ID associated with this payment. - `amazon_pay` PaymentMethodDetailsPaymentRecordAmazonPay - `funding` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodAmazonPayDetailsResourceFunding - `card` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodAmazonPayDetailsResourceFundingResourceFundingCard - `brand` string, nullable — Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. - `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. - `exp_month` integer, nullable — Two-digit number representing the card's expiration month. - `exp_year` integer, nullable — Four-digit number representing the card's expiration year. - `funding` string, nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `last4` string, nullable — The last four digits of the card. - `type` 'card', nullable — funding type of the underlying payment method. - `transaction_id` string, nullable — The Amazon Pay transaction ID associated with this payment. - `au_becs_debit` PaymentMethodDetailsPaymentRecordAuBecsDebit - `bsb_number` string, nullable — Bank-State-Branch number of the bank account. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `mandate` string — ID of the mandate used to make this payment. - `bacs_debit` PaymentMethodDetailsPaymentRecordBacsDebit - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `mandate` string, nullable — ID of the mandate used to make this payment. - `sort_code` string, nullable — Sort code of the bank account. (e.g., `10-20-30`) - `bancontact` PaymentMethodDetailsPaymentRecordBancontact - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `bic` string, nullable — Bank Identifier Code of the bank associated with the bank account. - `generated_sepa_debit` union — The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - `acss_debit` PaymentMethodAcssDebit - … - `affirm` PaymentMethodAffirm - `afterpay_clearpay` PaymentMethodAfterpayClearpay - `alipay` PaymentFlowsPrivatePaymentMethodsAlipay - `allow_redisplay` 'always' | 'limited' | 'unspecified' — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `alma` PaymentMethodAlma - `amazon_pay` PaymentMethodAmazonPay - `au_becs_debit` PaymentMethodAuBecsDebit - … - `bacs_debit` PaymentMethodBacsDebit - … - `bancontact` PaymentMethodBancontact - `billie` PaymentMethodBillie - `billing_details` BillingDetails, required - … - `bizum` PaymentMethodBizum - … - `blik` PaymentMethodBlik - … - `boleto` PaymentMethodBoleto - … - `card` PaymentMethodCard - … - `card_present` PaymentMethodCardPresent - … - `cashapp` PaymentMethodCashapp - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `crypto` PaymentMethodCrypto - `custom` PaymentMethodCustom - … - `customer` union — The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. - … - `customer_account` string, nullable - `customer_balance` PaymentMethodCustomerBalance - `eps` PaymentMethodEps - … - `fpx` PaymentMethodFpx - … - `giropay` PaymentMethodGiropay - `grabpay` PaymentMethodGrabpay - `id` string, required — Unique identifier for the object. - `ideal` PaymentMethodIdeal - … - `interac_present` PaymentMethodInteracPresent - … - `kakao_pay` PaymentMethodKakaoPay - `klarna` PaymentMethodKlarna - … - `konbini` PaymentMethodKonbini - `kr_card` PaymentMethodKrCard - … - `link` PaymentMethodLink - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `mb_way` PaymentMethodMbWay - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - … - `nz_bank_account` PaymentMethodNzBankAccount - … - `object` 'payment_method', required — String representing the object's type. Objects of the same type share the same value. - `oxxo` PaymentMethodOxxo - `p24` PaymentMethodP24 - … - `pay_by_bank` PaymentMethodPayByBank - `payco` PaymentMethodPayco - `paynow` PaymentMethodPaynow - `paypal` PaymentMethodPaypal - … - `payto` PaymentMethodPayto - … - `pix` PaymentMethodPix - … - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. - … - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `satispay` PaymentMethodSatispay - `scalapay` PaymentMethodScalapay - `sepa_debit` PaymentMethodSepaDebit - … - `sofort` PaymentMethodSofort - … - `sunbit` PaymentMethodSunbit - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip', required — 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. - `upi` PaymentMethodUpi - … - `us_bank_account` PaymentMethodUsBankAccount - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `generated_sepa_debit_mandate` union — The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. - string - Mandate — A Mandate is a record of the permission that your customer gives you to debit their payment method. - `customer_acceptance` CustomerAcceptance, required - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `multi_use` MandateMultiUse - … - `object` 'mandate', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` string — The account (if any) that the mandate is intended for. - `payment_method` union, required — ID of the payment method associated with this mandate. - … - `payment_method_details` MandatePaymentMethodDetails, required - … - `single_use` MandateSingleUse - … - `status` 'active' | 'inactive' | 'pending', required — The mandate status indicates whether or not you can use it to initiate a payment. - `type` 'multi_use' | 'single_use', required — The type of the mandate. - `iban_last4` string, nullable — Last four characters of the IBAN. - `preferred_language` 'de' | 'en' | 'fr' | 'nl', nullable — Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `billie` PaymentMethodDetailsPaymentRecordBillie - `transaction_id` string, nullable — The Billie transaction ID associated with this payment. - `billing_details` PaymentsPrimitivesPaymentRecordsResourceBillingDetails — Billing details used by the customer for this payment. - `address` PaymentsPrimitivesPaymentRecordsResourceAddress, required — A representation of a physical address. - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `email` string, nullable — The billing email associated with the method of payment. - `name` string, nullable — The billing name associated with the method of payment. - `phone` string, nullable — The billing phone number associated with the method of payment. - `bizum` PaymentMethodDetailsPaymentRecordBizum - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `transaction_id` string, nullable — The Bizum transaction ID associated with this payment. - `blik` PaymentMethodDetailsPaymentRecordBlik - `buyer_id` string, nullable — A unique and immutable identifier assigned by BLIK to every buyer. - `boleto` PaymentMethodDetailsPaymentRecordBoleto - `tax_id` string, nullable — The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) - `card` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetails — Details of the card used for this payment attempt. - `authorization_code` string, nullable — The authorization code of the payment. - `brand` 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'eftpos_au' | 'interac' | 'jcb' | 'link' | 'mastercard' | 'unionpay' | 'unknown' | 'visa', nullable — Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. - `capture_before` integer — When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured. - `checks` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceChecks - `address_line1_check` 'fail' | 'pass' | 'unavailable' | 'unchecked', nullable — If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. - `address_postal_code_check` 'fail' | 'pass' | 'unavailable' | 'unchecked', nullable — If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. - `cvc_check` 'fail' | 'pass' | 'unavailable' | 'unchecked', nullable — If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`. - `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. - `exp_month` integer, nullable — Two-digit number representing the card's expiration month. - `exp_year` integer, nullable — Four-digit number representing the card's expiration year. - `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.* - `funding` 'credit' | 'debit' | 'prepaid' | 'unknown', nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `installments` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallments - `plan` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallmentPlan - `count` integer, nullable — For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. - `interval` 'month', nullable — For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. One of `month`. - `type` 'bonus' | 'fixed_count' | 'revolving', required — Type of installment plan, one of `fixed_count`, `revolving`, or `bonus`. - `last4` string, nullable — The last four digits of the card. - `network` 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'eftpos_au' | 'interac' | 'jcb' | 'link' | 'mastercard' | 'unionpay' | 'unknown' | 'visa', nullable — Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. - `network_advice_code` string, nullable — Advice code from the card network for the failed payment. - `network_decline_code` string, nullable — Decline code from the card network for the failed payment. - `network_token` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceNetworkToken - `used` boolean, required — Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction. - `network_transaction_id` string, nullable — This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. - `three_d_secure` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceThreeDSecure - `authentication_flow` 'challenge' | 'frictionless', nullable — For authenticated transactions: Indicates how the issuing bank authenticated the customer. - `cryptogram` string, nullable — The 3D Secure cryptogram, also known as the "authentication value" (AAV, CAVV or AEVV). - `electronic_commerce_indicator` '01' | '02' | '03' | '04' | '05' | '06' | '07', nullable — The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed. - `exemption_indicator` 'low_risk' | 'none', nullable — The exemption requested via 3DS and accepted by the issuer at authentication time. - `exemption_indicator_applied` boolean, nullable — Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on the outcome of Stripe's internal risk assessment. - `result` 'attempt_acknowledged' | 'authenticated' | 'data_share_only' | 'exempted' | 'failed' | 'not_supported' | 'processing_error', nullable — Indicates the outcome of 3D Secure authentication. - `result_reason` 'abandoned' | 'bypassed' | 'canceled' | 'card_not_enrolled' | 'network_not_supported' | 'protocol_error' | 'rejected', nullable — Additional information about why 3D Secure succeeded or failed, based on the `result`. - `version` '1.0.2' | '2.1.0' | '2.2.0', nullable — The version of 3D Secure that was used. - `wallet` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWallet - `apple_pay` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceApplePay - `type` string, required — Type of the apple_pay transaction, one of `apple_pay` or `apple_pay_later`. - `dynamic_last4` string — (For tokenized numbers only.) The last four digits of the device account number. - `google_pay` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceGooglePay - `type` string, required — The type of the card wallet, one of `apple_pay` or `google_pay`. 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. - `card_present` PaymentMethodDetailsCardPresent - `amount_authorized` integer, nullable — The authorized amount - `brand` string, nullable — Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. - `brand_product` string, nullable — The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. - `capture_before` integer — When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. - `cardholder_name` string, nullable — The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_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. - `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. - `description` string, nullable — A high-level description of the type of cards issued in this range. - `emv_auth_data` string, nullable — Authorization response cryptogram. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `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.* - `funding` string, nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `generated_card` string, nullable — ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. - `incremental_authorization_supported` boolean, required — Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). - `issuer` string, nullable — The name of the card's issuing bank. - `last4` string, nullable — The last four digits of the card. - `location` string — ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. - `network` string, nullable — Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. - `network_transaction_id` string, nullable — This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. - `offline` PaymentMethodDetailsCardPresentOffline - `stored_at` integer, nullable — Time at which the payment was collected while offline - `type` 'deferred', nullable — The method used to process this payment method offline. Only deferred is allowed. - `overcapture_supported` boolean, required — Defines whether the authorized amount can be over-captured or not - `preferred_locales` string[], 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. - `read_method` 'contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2', nullable — How card details were read in this transaction. - `reader` string — ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. - `receipt` PaymentMethodDetailsCardPresentReceipt - `account_type` 'checking' | 'credit' | 'prepaid' | 'unknown' — The type of account being debited or credited - `application_cryptogram` string, nullable — The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers. - `application_preferred_name` string, nullable — The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip. - `authorization_code` string, nullable — Identifier for this transaction. - `authorization_response_code` string, nullable — EMV tag 8A. A code returned by the card issuer. - `cardholder_verification_method` string, nullable — Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. - `dedicated_file_name` string, nullable — Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84. - `terminal_verification_results` string, nullable — A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95. - `transaction_status_information` string, nullable — An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B. - `wallet` PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet - `type` 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown', required — The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`. - `cashapp` PaymentMethodDetailsPaymentRecordCashapp - `buyer_id` string, nullable — A unique and immutable identifier assigned by Cash App to every buyer. - `cashtag` string, nullable — A public identifier for buyers using Cash App. - `transaction_id` string, nullable — A unique and immutable identifier of payments assigned by Cash App. - `crypto` PaymentMethodDetailsCrypto - `buyer_address` string — The wallet address of the customer. - `network` 'base' | 'ethereum' | 'polygon' | 'solana' | 'sui' | 'tempo' — The blockchain network that the transaction was sent on. - `token_currency` 'phantom_cash' | 'usdc' | 'usdg' | 'usdp' | 'usdsui' | 'usdt' — The token currency that the transaction was sent with. - `transaction_hash` string — The blockchain transaction hash of the crypto payment. - `custom` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCustomDetails — Custom Payment Methods represent Payment Method types not modeled directly in the Stripe API. This resource consists of details about the custom payment method used for this payment attempt. - `display_name` string, required — Display name for the custom (user-defined) payment method type used to make this payment. - `type` string, nullable — The custom payment method type associated with this payment. - `customer_balance` PaymentMethodDetailsCustomerBalance - `eps` PaymentMethodDetailsPaymentRecordEps - `bank` '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', 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` - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by EPS directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. EPS rarely provides this information so the attribute is usually empty. - `fpx` PaymentMethodDetailsFpx - `bank` 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bnp_paribas' | 'bsn' | 'cimb' | 'citibank' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'mbsb_bank' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob', required — The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`. - `transaction_id` string, nullable — Unique transaction id generated by FPX for every request from the merchant - `giropay` PaymentMethodDetailsPaymentRecordGiropay - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `bic` string, nullable — Bank Identifier Code of the bank associated with the bank account. - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. - `grabpay` PaymentMethodDetailsGrabpay - `transaction_id` string, nullable — Unique transaction id generated by GrabPay - `ideal` PaymentMethodDetailsPaymentRecordIdeal - `bank` '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', nullable — The customer's bank. 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`. - `bic` 'ABNANL2A' | 'ADYBNL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'BUUTNL2A' | 'FNOMNL22' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | 'MLLENL2A' | 'MOYONL21' | 'NNBANL2G' | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' | 'REVOLT21' | 'SNSBNL2A' | 'TRIONL2U', nullable — The Bank Identifier Code of the customer's bank. - `generated_sepa_debit` union — The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - `acss_debit` PaymentMethodAcssDebit - … - `affirm` PaymentMethodAffirm - `afterpay_clearpay` PaymentMethodAfterpayClearpay - `alipay` PaymentFlowsPrivatePaymentMethodsAlipay - `allow_redisplay` 'always' | 'limited' | 'unspecified' — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `alma` PaymentMethodAlma - `amazon_pay` PaymentMethodAmazonPay - `au_becs_debit` PaymentMethodAuBecsDebit - … - `bacs_debit` PaymentMethodBacsDebit - … - `bancontact` PaymentMethodBancontact - `billie` PaymentMethodBillie - `billing_details` BillingDetails, required - … - `bizum` PaymentMethodBizum - … - `blik` PaymentMethodBlik - … - `boleto` PaymentMethodBoleto - … - `card` PaymentMethodCard - … - `card_present` PaymentMethodCardPresent - … - `cashapp` PaymentMethodCashapp - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `crypto` PaymentMethodCrypto - `custom` PaymentMethodCustom - … - `customer` union — The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. - … - `customer_account` string, nullable - `customer_balance` PaymentMethodCustomerBalance - `eps` PaymentMethodEps - … - `fpx` PaymentMethodFpx - … - `giropay` PaymentMethodGiropay - `grabpay` PaymentMethodGrabpay - `id` string, required — Unique identifier for the object. - `ideal` PaymentMethodIdeal - … - `interac_present` PaymentMethodInteracPresent - … - `kakao_pay` PaymentMethodKakaoPay - `klarna` PaymentMethodKlarna - … - `konbini` PaymentMethodKonbini - `kr_card` PaymentMethodKrCard - … - `link` PaymentMethodLink - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `mb_way` PaymentMethodMbWay - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - … - `nz_bank_account` PaymentMethodNzBankAccount - … - `object` 'payment_method', required — String representing the object's type. Objects of the same type share the same value. - `oxxo` PaymentMethodOxxo - `p24` PaymentMethodP24 - … - `pay_by_bank` PaymentMethodPayByBank - `payco` PaymentMethodPayco - `paynow` PaymentMethodPaynow - `paypal` PaymentMethodPaypal - … - `payto` PaymentMethodPayto - … - `pix` PaymentMethodPix - … - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. - … - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `satispay` PaymentMethodSatispay - `scalapay` PaymentMethodScalapay - `sepa_debit` PaymentMethodSepaDebit - … - `sofort` PaymentMethodSofort - … - `sunbit` PaymentMethodSunbit - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip', required — 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. - `upi` PaymentMethodUpi - … - `us_bank_account` PaymentMethodUsBankAccount - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `generated_sepa_debit_mandate` union — The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. - string - Mandate — A Mandate is a record of the permission that your customer gives you to debit their payment method. - `customer_acceptance` CustomerAcceptance, required - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `multi_use` MandateMultiUse - … - `object` 'mandate', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` string — The account (if any) that the mandate is intended for. - `payment_method` union, required — ID of the payment method associated with this mandate. - … - `payment_method_details` MandatePaymentMethodDetails, required - … - `single_use` MandateSingleUse - … - `status` 'active' | 'inactive' | 'pending', required — The mandate status indicates whether or not you can use it to initiate a payment. - `type` 'multi_use' | 'single_use', required — The type of the mandate. - `iban_last4` string, nullable — Last four characters of the IBAN. - `transaction_id` string, nullable — Unique transaction ID generated by iDEAL. - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by iDEAL directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `interac_present` PaymentMethodDetailsInteracPresent - `brand` string, nullable — Card brand. Can be `interac`, `mastercard` or `visa`. - `cardholder_name` string, nullable — The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_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. - `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. - `description` string, nullable — A high-level description of the type of cards issued in this range. - `emv_auth_data` string, nullable — Authorization response cryptogram. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `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.* - `funding` string, nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `generated_card` string, nullable — ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. - `issuer` string, nullable — The name of the card's issuing bank. - `last4` string, nullable — The last four digits of the card. - `location` string — ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. - `network` string, nullable — Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. - `network_transaction_id` string, nullable — This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. - `preferred_locales` string[], 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. - `read_method` 'contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2', nullable — How card details were read in this transaction. - `reader` string — ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. - `receipt` PaymentMethodDetailsInteracPresentReceipt - `account_type` 'checking' | 'savings' | 'unknown' — The type of account being debited or credited - `application_cryptogram` string, nullable — The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers. - `application_preferred_name` string, nullable — The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip. - `authorization_code` string, nullable — Identifier for this transaction. - `authorization_response_code` string, nullable — EMV tag 8A. A code returned by the card issuer. - `cardholder_verification_method` string, nullable — Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. - `dedicated_file_name` string, nullable — Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84. - `terminal_verification_results` string, nullable — A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95. - `transaction_status_information` string, nullable — An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B. - `kakao_pay` PaymentMethodDetailsPaymentRecordKakaoPay - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `transaction_id` string, nullable — The Kakao Pay transaction ID associated with this payment. - `klarna` PaymentMethodDetailsPaymentRecordKlarna - `location` string — ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. - `payer_details` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodKlarnaDetailsResourcePayerDetails - `address` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodKlarnaDetailsResourcePayerDetailsResourcePayerDetailsAddress - `country` string, nullable — The payer address country - `payment_method_category` string, nullable — The Klarna payment method used for this transaction. Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` - `preferred_locale` string, nullable — Preferred language of the Klarna authorization page that the customer is redirected to. Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH` - `reader` string — ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. - `konbini` PaymentMethodDetailsPaymentRecordKonbini - `store` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodKonbiniDetailsResourceStore - `chain` 'familymart' | 'lawson' | 'ministop' | 'seicomart', nullable — The name of the convenience store chain where the payment was completed. - `kr_card` PaymentMethodDetailsKrCard - `brand` 'bc' | 'citi' | 'hana' | 'hyundai' | 'jeju' | 'jeonbuk' | 'kakaobank' | 'kbank' | 'kdbbank' | 'kookmin' | 'kwangju' | 'lotte' | 'mg' | 'nh' | 'post' | 'samsung' | 'savingsbank' | 'shinhan' | 'shinhyup' | 'suhyup' | 'tossbank' | 'woori', nullable — The local credit or debit card brand. - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `last4` string, nullable — The last four digits of the card. This may not be present for American Express cards. - `transaction_id` string, nullable — The Korean Card transaction ID associated with this payment. - `link` PaymentMethodDetailsPaymentRecordLink - `country` string, nullable — Two-letter ISO code representing the funding source country beneath the Link payment. You could use this attribute to get a sense of international fees. - `mb_way` PaymentMethodDetailsPaymentRecordMbWay - `mobilepay` PaymentMethodDetailsPaymentRecordMobilepay - `card` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodMobilepayDetailsResourceCard - `brand` string, nullable — Brand of the card used in the transaction - `country` string, nullable — Two-letter ISO code representing the country of the card - `exp_month` integer, nullable — Two digit number representing the card's expiration month - `exp_year` integer, nullable — Two digit number representing the card's expiration year - `last4` string, nullable — The last 4 digits of the card - `multibanco` PaymentMethodDetailsPaymentRecordMultibanco - `entity` string, nullable — Entity number associated with this Multibanco payment. - `reference` string, nullable — Reference number associated with this Multibanco payment. - `naver_pay` PaymentMethodDetailsPaymentRecordNaverPay - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `transaction_id` string, nullable — The Naver Pay transaction ID associated with this payment. - `nz_bank_account` PaymentMethodDetailsNzBankAccount - `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. - `bank_code` string, required — The numeric code for the bank account's bank. - `bank_name` string, required — The name of the bank. - `branch_code` string, required — The numeric code for the bank account's bank branch. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `last4` string, required — Last four digits of the bank account number. - `suffix` string, nullable — The suffix of the bank account number. - `oxxo` PaymentMethodDetailsPaymentRecordOxxo - `number` string, nullable — OXXO reference number - `p24` PaymentMethodDetailsPaymentRecordP24 - `bank` 'alior_bank' | 'bank_millennium' | 'bank_nowy_bfg_sa' | 'bank_pekao_sa' | 'banki_spbdzielcze' | 'blik' | 'bnp_paribas' | 'boz' | 'citi_handlowy' | 'credit_agricole' | 'envelobank' | 'etransfer_pocztowy24' | 'getin_bank' | 'ideabank' | 'ing' | 'inteligo' | 'mbank_mtransfer' | 'nest_przelew' | 'noble_pay' | 'pbac_z_ipko' | 'plus_bank' | 'santander_przelew24' | 'tmobile_usbugi_bankowe' | 'toyota_bank' | 'velobank' | 'volkswagen_bank', nullable — The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. - `reference` string, nullable — Unique reference for this Przelewy24 payment. - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by Przelewy24 directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Przelewy24 rarely provides this information so the attribute is usually empty. - `pay_by_bank` PaymentMethodDetailsPaymentRecordPayByBank - `payco` PaymentMethodDetailsPaymentRecordPayco - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `transaction_id` string, nullable — The Payco transaction ID associated with this payment. - `payment_method` string, nullable — ID of the Stripe PaymentMethod used to make this payment. - `paynow` PaymentMethodDetailsPaymentRecordPaynow - `location` string — ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. - `reader` string — ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. - `reference` string, nullable — Reference number associated with this PayNow payment - `paypal` PaymentMethodDetailsPaypal - `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. - `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. - `payer_id` string, nullable — PayPal account PayerID. This identifier uniquely identifies the PayPal customer. - `payer_name` string, nullable — Owner's full name. Values provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `seller_protection` PaypalSellerProtection - `dispute_categories` string[], nullable — An array of conditions that are covered for the transaction, if applicable. - `status` 'eligible' | 'not_eligible' | 'partially_eligible', required — Indicates whether the transaction is eligible for PayPal's seller protection. - `transaction_id` string, nullable — A unique ID generated by PayPal for this transaction. - `payto` PaymentMethodDetailsPaymentRecordPayto - `bsb_number` string, nullable — Bank-State-Branch number of the bank account. - `last4` string, nullable — Last four digits of the bank account number. - `mandate` string — ID of the mandate used to make this payment. - `pay_id` string, nullable — The PayID alias for the bank account. - `pix` PaymentMethodDetailsPaymentRecordPix - `bank_transaction_id` string, nullable — Unique transaction id generated by BCB - `mandate` string — ID of the multi use Mandate generated by the PaymentIntent - `promptpay` PaymentMethodDetailsPaymentRecordPromptpay - `reference` string, nullable — Bill reference generated by PromptPay - `revolut_pay` PaymentMethodDetailsPaymentRecordRevolutPay - `funding` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodRevolutPayDetailsResourceFunding - `card` PaymentsPrimitivesPaymentRecordsResourcePaymentMethodRevolutPayDetailsResourceFundingResourceFundingCard - `brand` string, nullable — Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. - `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. - `exp_month` integer, nullable — Two-digit number representing the card's expiration month. - `exp_year` integer, nullable — Four-digit number representing the card's expiration year. - `funding` string, nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `last4` string, nullable — The last four digits of the card. - `type` 'card', nullable — Funding type of the underlying payment method. - `transaction_id` string, nullable — The Revolut Pay transaction ID associated with this payment. - `samsung_pay` PaymentMethodDetailsPaymentRecordSamsungPay - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `transaction_id` string, nullable — The Samsung Pay transaction ID associated with this payment. - `satispay` PaymentMethodDetailsPaymentRecordSatispay - `transaction_id` string, nullable — The Satispay transaction ID associated with this payment. - `scalapay` PaymentMethodDetailsPaymentRecordScalapay - `transaction_id` string, nullable — The Scalapay transaction ID associated with this payment. - `sepa_debit` PaymentMethodDetailsPaymentRecordSepaDebit - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `branch_code` string, nullable — Branch code of bank associated with the bank account. - `country` string, nullable — Two-letter ISO code representing the country the bank account is located in. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four characters of the IBAN. - `mandate` string, nullable — Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve). - `sofort` PaymentMethodDetailsPaymentRecordSofort - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `bic` string, nullable — Bank Identifier Code of the bank associated with the bank account. - `country` string, nullable — Two-letter ISO code representing the country the bank account is located in. - `generated_sepa_debit` union — The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - `acss_debit` PaymentMethodAcssDebit - … - `affirm` PaymentMethodAffirm - `afterpay_clearpay` PaymentMethodAfterpayClearpay - `alipay` PaymentFlowsPrivatePaymentMethodsAlipay - `allow_redisplay` 'always' | 'limited' | 'unspecified' — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `alma` PaymentMethodAlma - `amazon_pay` PaymentMethodAmazonPay - `au_becs_debit` PaymentMethodAuBecsDebit - … - `bacs_debit` PaymentMethodBacsDebit - … - `bancontact` PaymentMethodBancontact - `billie` PaymentMethodBillie - `billing_details` BillingDetails, required - … - `bizum` PaymentMethodBizum - … - `blik` PaymentMethodBlik - … - `boleto` PaymentMethodBoleto - … - `card` PaymentMethodCard - … - `card_present` PaymentMethodCardPresent - … - `cashapp` PaymentMethodCashapp - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `crypto` PaymentMethodCrypto - `custom` PaymentMethodCustom - … - `customer` union — The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. - … - `customer_account` string, nullable - `customer_balance` PaymentMethodCustomerBalance - `eps` PaymentMethodEps - … - `fpx` PaymentMethodFpx - … - `giropay` PaymentMethodGiropay - `grabpay` PaymentMethodGrabpay - `id` string, required — Unique identifier for the object. - `ideal` PaymentMethodIdeal - … - `interac_present` PaymentMethodInteracPresent - … - `kakao_pay` PaymentMethodKakaoPay - `klarna` PaymentMethodKlarna - … - `konbini` PaymentMethodKonbini - `kr_card` PaymentMethodKrCard - … - `link` PaymentMethodLink - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `mb_way` PaymentMethodMbWay - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - … - `nz_bank_account` PaymentMethodNzBankAccount - … - `object` 'payment_method', required — String representing the object's type. Objects of the same type share the same value. - `oxxo` PaymentMethodOxxo - `p24` PaymentMethodP24 - … - `pay_by_bank` PaymentMethodPayByBank - `payco` PaymentMethodPayco - `paynow` PaymentMethodPaynow - `paypal` PaymentMethodPaypal - … - `payto` PaymentMethodPayto - … - `pix` PaymentMethodPix - … - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. - … - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `satispay` PaymentMethodSatispay - `scalapay` PaymentMethodScalapay - `sepa_debit` PaymentMethodSepaDebit - … - `sofort` PaymentMethodSofort - … - `sunbit` PaymentMethodSunbit - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip', required — 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. - `upi` PaymentMethodUpi - … - `us_bank_account` PaymentMethodUsBankAccount - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `generated_sepa_debit_mandate` union — The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. - string - Mandate — A Mandate is a record of the permission that your customer gives you to debit their payment method. - `customer_acceptance` CustomerAcceptance, required - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `multi_use` MandateMultiUse - … - `object` 'mandate', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` string — The account (if any) that the mandate is intended for. - `payment_method` union, required — ID of the payment method associated with this mandate. - … - `payment_method_details` MandatePaymentMethodDetails, required - … - `single_use` MandateSingleUse - … - `status` 'active' | 'inactive' | 'pending', required — The mandate status indicates whether or not you can use it to initiate a payment. - `type` 'multi_use' | 'single_use', required — The type of the mandate. - `iban_last4` string, nullable — Last four characters of the IBAN. - `preferred_language` 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl', nullable — Preferred language of the SOFORT authorization page that the customer is redirected to. Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by SOFORT directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `stripe_account` PaymentMethodDetailsStripeAccount - `sunbit` PaymentMethodDetailsPaymentRecordSunbit - `transaction_id` string, nullable — The Sunbit transaction ID associated with this payment. - `swish` PaymentMethodDetailsPaymentRecordSwish - `fingerprint` string, nullable — Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer - `payment_reference` string, nullable — Payer bank reference number for the payment - `verified_phone_last4` string, nullable — The last four digits of the Swish account phone number - `twint` PaymentMethodDetailsPaymentRecordTwint - `mandate` string — ID of the multi use Mandate generated by the PaymentIntent - `type` string, required — The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types. An additional hash is included on `payment_method_details` with a name matching this value. It contains information specific to the payment method. - `upi` PaymentMethodDetailsPaymentRecordUpi - `vpa` string, nullable — Customer's unique Virtual Payment Address. - `us_bank_account` PaymentMethodDetailsPaymentRecordUsBankAccount - `account_holder_type` 'company' | 'individual', nullable — The type of entity that holds the account. This can be either 'individual' or 'company'. - `account_type` 'checking' | 'savings', nullable — The type of the bank account. This can be either 'checking' or 'savings'. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `mandate` union — ID of the mandate used to make this payment. - string - Mandate — A Mandate is a record of the permission that your customer gives you to debit their payment method. - `customer_acceptance` CustomerAcceptance, required - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `multi_use` MandateMultiUse - … - `object` 'mandate', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` string — The account (if any) that the mandate is intended for. - `payment_method` union, required — ID of the payment method associated with this mandate. - … - `payment_method_details` MandatePaymentMethodDetails, required - … - `single_use` MandateSingleUse - … - `status` 'active' | 'inactive' | 'pending', required — The mandate status indicates whether or not you can use it to initiate a payment. - `type` 'multi_use' | 'single_use', required — The type of the mandate. - `payment_reference` string, nullable — The ACH payment reference for this transaction. - `routing_number` string, nullable — The routing number for the bank account. - `wechat` PaymentMethodDetailsWechat - `wechat_pay` PaymentMethodDetailsPaymentRecordWechatPay - `fingerprint` string, nullable — Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. - `location` string — ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. - `reader` string — ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. - `transaction_id` string, nullable — Transaction ID of this particular WeChat Pay transaction. - `zip` PaymentMethodDetailsPaymentRecordZip - `payment_record` string, nullable — ID of the Payment Record this Payment Attempt Record belongs to. - `processor_details` PaymentsPrimitivesPaymentRecordsResourceProcessorDetails, required — Processor information associated with this payment. - `custom` PaymentsPrimitivesPaymentRecordsResourceProcessorDetailsResourceCustomDetails — Custom processors represent payment processors not modeled directly in the Stripe API. This resource consists of details about the custom processor used for this payment attempt. - `payment_reference` string, nullable — An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID. - `type` 'custom', required — The processor used for this payment attempt. - `reported_by` 'self' | 'stripe', required — Indicates who reported the payment. - `shipping_details` PaymentsPrimitivesPaymentRecordsResourceShippingDetails — The customer's shipping information associated with this payment. - `address` PaymentsPrimitivesPaymentRecordsResourceAddress, required — A representation of a physical address. - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `name` string, nullable — The shipping recipient's name. - `phone` string, nullable — The shipping recipient's phone number. - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stripe/apis/stripe-api-2.md) · [All operations](https://skmtc.net/stripe/apis/stripe-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/stripe-api-2/versions/3653ad45bbec/schema)