payment_method_bacs_debit
{
"type": "object",
"title": "payment_method_bacs_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"sort_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Sort code of the bank account. (e.g., `10-20-30`)"
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_bancontact
{
"type": "object",
"title": "payment_method_bancontact",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_billie
{
"type": "object",
"title": "payment_method_billie",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_blik
{
"type": "object",
"title": "payment_method_blik",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_boleto
{
"type": "object",
"title": "payment_method_boleto",
"required": [
"tax_id"
],
"properties": {
"tax_id": {
"type": "string",
"maxLength": 5000,
"description": "Uniquely identifies the customer tax id (CNPJ or CPF)"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_card
{
"type": "object",
"title": "payment_method_card",
"required": [
"brand",
"exp_month",
"exp_year",
"funding",
"last4"
],
"properties": {
"brand": {
"type": "string",
"maxLength": 5000,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"last4": {
"type": "string",
"maxLength": 5000,
"description": "The last four digits of the card."
},
"checks": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_card_checks"
}
],
"nullable": true,
"description": "Checks on Card address and CVC if provided."
},
"wallet": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_card_wallet"
}
],
"nullable": true,
"description": "If this Card is part of a card wallet, this contains the details of the card wallet."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"funding": {
"type": "string",
"maxLength": 5000,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"exp_year": {
"type": "integer",
"description": "Four-digit number representing the card's expiration year."
},
"networks": {
"anyOf": [
{
"$ref": "#/components/schemas/networks"
}
],
"nullable": true,
"description": "Contains information about card networks that can be used to process the payment."
},
"exp_month": {
"type": "integer",
"description": "Two-digit number representing the card's expiration month."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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.\n\n*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.*"
},
"display_brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"generated_from": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_card_generated_card"
}
],
"nullable": true,
"description": "Details of the original PaymentMethod that created this object."
},
"regulated_status": {
"enum": [
"regulated",
"unregulated"
],
"type": "string",
"nullable": true,
"description": "Status of a card based on the card issuer."
},
"three_d_secure_usage": {
"anyOf": [
{
"$ref": "#/components/schemas/three_d_secure_usage"
}
],
"nullable": true,
"description": "Contains details on how this Card may be used for 3D Secure authentication."
}
},
"description": "",
"x-expandableFields": [
"checks",
"generated_from",
"networks",
"three_d_secure_usage",
"wallet"
]
}
payment_method_card_checks
{
"type": "object",
"title": "payment_method_card_checks",
"properties": {
"cvc_check": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
},
"address_line1_check": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
},
"address_postal_code_check": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_card_generated_card
{
"type": "object",
"title": "payment_method_card_generated_card",
"properties": {
"charge": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The charge that created this object."
},
"setup_attempt": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/setup_attempt"
}
],
"nullable": true,
"description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/setup_attempt"
}
]
}
},
"payment_method_details": {
"anyOf": [
{
"$ref": "#/components/schemas/card_generated_from_payment_method_details"
}
],
"nullable": true,
"description": "Transaction-specific details of the payment method used in the payment."
}
},
"description": "",
"x-expandableFields": [
"payment_method_details",
"setup_attempt"
]
}
payment_method_card_present
{
"type": "object",
"title": "payment_method_card_present",
"required": [
"exp_month",
"exp_year"
],
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the card."
},
"issuer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the card's issuing bank."
},
"wallet": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"funding": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"offline": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_present_offline"
}
],
"nullable": true,
"description": "Details about payment methods collected offline."
},
"exp_year": {
"type": "integer",
"description": "Four-digit number representing the card's expiration year."
},
"networks": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_card_present_networks"
}
],
"nullable": true,
"description": "Contains information about card networks that can be used to process the payment."
},
"exp_month": {
"type": "integer",
"description": "Two-digit number representing the card's expiration month."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A high-level description of the type of cards issued in this range."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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.\n\n*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.*"
},
"read_method": {
"enum": [
"contact_emv",
"contactless_emv",
"contactless_magstripe_mode",
"magnetic_stripe_fallback",
"magnetic_stripe_track2"
],
"type": "string",
"nullable": true,
"description": "How card details were read in this transaction."
},
"brand_product": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card."
},
"cardholder_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"preferred_locales": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": [
"networks",
"offline",
"wallet"
]
}
payment_method_card_present_networks
{
"type": "object",
"title": "payment_method_card_present_networks",
"required": [
"available"
],
"properties": {
"available": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network)."
},
"preferred": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The preferred network for the card."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_card_wallet
{
"type": "object",
"title": "payment_method_card_wallet",
"required": [
"type"
],
"properties": {
"link": {
"$ref": "#/components/schemas/payment_method_card_wallet_link"
},
"type": {
"enum": [
"amex_express_checkout",
"apple_pay",
"google_pay",
"link",
"masterpass",
"samsung_pay",
"visa_checkout"
],
"type": "string",
"description": "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."
},
"apple_pay": {
"$ref": "#/components/schemas/payment_method_card_wallet_apple_pay"
},
"google_pay": {
"$ref": "#/components/schemas/payment_method_card_wallet_google_pay"
},
"masterpass": {
"$ref": "#/components/schemas/payment_method_card_wallet_masterpass"
},
"samsung_pay": {
"$ref": "#/components/schemas/payment_method_card_wallet_samsung_pay"
},
"dynamic_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "(For tokenized numbers only.) The last four digits of the device account number."
},
"visa_checkout": {
"$ref": "#/components/schemas/payment_method_card_wallet_visa_checkout"
},
"amex_express_checkout": {
"$ref": "#/components/schemas/payment_method_card_wallet_amex_express_checkout"
}
},
"description": "",
"x-expandableFields": [
"amex_express_checkout",
"apple_pay",
"google_pay",
"link",
"masterpass",
"samsung_pay",
"visa_checkout"
]
}
payment_method_card_wallet_amex_express_checkout
{
"type": "object",
"title": "payment_method_card_wallet_amex_express_checkout",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_card_wallet_apple_pay
{
"type": "object",
"title": "payment_method_card_wallet_apple_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_card_wallet_google_pay
{
"type": "object",
"title": "payment_method_card_wallet_google_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_card_wallet_link
{
"type": "object",
"title": "payment_method_card_wallet_link",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_card_wallet_masterpass
{
"type": "object",
"title": "payment_method_card_wallet_masterpass",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"billing_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "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."
},
"shipping_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": [
"billing_address",
"shipping_address"
]
}
payment_method_card_wallet_samsung_pay
{
"type": "object",
"title": "payment_method_card_wallet_samsung_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_card_wallet_visa_checkout
{
"type": "object",
"title": "payment_method_card_wallet_visa_checkout",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"billing_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "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."
},
"shipping_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": [
"billing_address",
"shipping_address"
]
}
payment_method_cashapp
{
"type": "object",
"title": "payment_method_cashapp",
"properties": {
"cashtag": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A public identifier for buyers using Cash App."
},
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique and immutable identifier assigned by Cash App to every buyer."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_config_biz_payment_method_configuration_details
{
"type": "object",
"title": "PaymentMethodConfigBizPaymentMethodConfigurationDetails",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "ID of the payment method configuration used."
},
"parent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the parent payment method configuration used."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_config_resource_display_preference
{
"type": "object",
"title": "PaymentMethodConfigResourceDisplayPreference",
"required": [
"preference",
"value"
],
"properties": {
"value": {
"enum": [
"off",
"on"
],
"type": "string",
"description": "The effective display preference value."
},
"preference": {
"enum": [
"none",
"off",
"on"
],
"type": "string",
"description": "The account's display preference."
},
"overridable": {
"type": "boolean",
"nullable": true,
"description": "For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_config_resource_payment_method_properties
{
"type": "object",
"title": "PaymentMethodConfigResourcePaymentMethodProperties",
"required": [
"available",
"display_preference"
],
"properties": {
"available": {
"type": "boolean",
"description": "Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active."
},
"display_preference": {
"$ref": "#/components/schemas/payment_method_config_resource_display_preference"
}
},
"description": "",
"x-expandableFields": [
"display_preference"
]
}
payment_method_configuration
{
"type": "object",
"title": "PaymentMethodConfigResourcePaymentMethodConfiguration",
"required": [
"active",
"id",
"is_default",
"livemode",
"name",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"eps": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"fpx": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"jcb": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"p24": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"pix": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"upi": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"zip": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"alma": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"blik": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"card": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"link": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "The configuration's name."
},
"oxxo": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"ideal": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"payco": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"payto": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"swish": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"twint": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"active": {
"type": "boolean",
"description": "Whether the configuration can be used for new payments."
},
"affirm": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"alipay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"billie": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"boleto": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"crypto": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"klarna": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"mb_way": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"object": {
"enum": [
"payment_method_configuration"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"parent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "For child configs, the configuration's parent configuration."
},
"paynow": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"paypal": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"sofort": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"sunbit": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"cashapp": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"giropay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"grabpay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"konbini": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"kr_card": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"satispay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"apple_pay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"kakao_pay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"mobilepay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"naver_pay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"promptpay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"acss_debit": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"amazon_pay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"bacs_debit": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"bancontact": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"google_pay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"is_default": {
"type": "boolean",
"description": "The default configuration is used whenever a payment method configuration is not specified."
},
"multibanco": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"sepa_debit": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"wechat_pay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"application": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "For child configs, the Connect application associated with the configuration."
},
"pay_by_bank": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"revolut_pay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"samsung_pay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"au_becs_debit": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"nz_bank_account": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"us_bank_account": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"cartes_bancaires": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"customer_balance": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"afterpay_clearpay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
}
},
"description": "PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.\n\nThere are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://docs.stripe.com/connect/charges):\n\n**Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.\n\n**Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.\n\nChild configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.\n\nRelated guides:\n- [Payment Method Configurations API](https://docs.stripe.com/connect/payment-method-configurations)\n- [Multiple configurations on dynamic payment methods](https://docs.stripe.com/payments/multiple-payment-method-configs)\n- [Multiple configurations for your Connect accounts](https://docs.stripe.com/connect/multiple-payment-method-configurations)",
"x-resourceId": "payment_method_configuration",
"x-expandableFields": [
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"apple_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"card",
"cartes_bancaires",
"cashapp",
"crypto",
"customer_balance",
"eps",
"fpx",
"giropay",
"google_pay",
"grabpay",
"ideal",
"jcb",
"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",
"sepa_debit",
"sofort",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay",
"zip"
]
}
payment_method_crypto
{
"type": "object",
"title": "payment_method_crypto",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_custom
{
"type": "object",
"title": "payment_method_custom",
"required": [
"type"
],
"properties": {
"logo": {
"anyOf": [
{
"$ref": "#/components/schemas/custom_logo"
}
],
"nullable": true,
"description": "Contains information about the Dashboard-only CustomPaymentMethodType logo."
},
"type": {
"type": "string",
"maxLength": 5000,
"description": "ID of the Dashboard-only CustomPaymentMethodType. Not expandable."
},
"display_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Display name of the Dashboard-only CustomPaymentMethodType."
}
},
"description": "",
"x-expandableFields": [
"logo"
]
}
payment_method_customer_balance
{
"type": "object",
"title": "payment_method_customer_balance",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details
{
"type": "object",
"title": "payment_method_details",
"required": [
"type"
],
"properties": {
"eps": {
"$ref": "#/components/schemas/payment_method_details_eps"
},
"fpx": {
"$ref": "#/components/schemas/payment_method_details_fpx"
},
"p24": {
"$ref": "#/components/schemas/payment_method_details_p24"
},
"pix": {
"$ref": "#/components/schemas/payment_method_details_pix"
},
"upi": {
"$ref": "#/components/schemas/payment_method_details_upi"
},
"zip": {
"$ref": "#/components/schemas/payment_method_details_zip"
},
"alma": {
"$ref": "#/components/schemas/payment_method_details_alma"
},
"blik": {
"$ref": "#/components/schemas/payment_method_details_blik"
},
"card": {
"$ref": "#/components/schemas/payment_method_details_card"
},
"link": {
"$ref": "#/components/schemas/payment_method_details_link"
},
"oxxo": {
"$ref": "#/components/schemas/payment_method_details_oxxo"
},
"type": {
"type": "string",
"maxLength": 5000,
"description": "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.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method."
},
"ideal": {
"$ref": "#/components/schemas/payment_method_details_ideal"
},
"payco": {
"$ref": "#/components/schemas/payment_method_details_payco"
},
"payto": {
"$ref": "#/components/schemas/payment_method_details_payto"
},
"swish": {
"$ref": "#/components/schemas/payment_method_details_swish"
},
"twint": {
"$ref": "#/components/schemas/payment_method_details_twint"
},
"affirm": {
"$ref": "#/components/schemas/payment_method_details_affirm"
},
"alipay": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details"
},
"billie": {
"$ref": "#/components/schemas/payment_method_details_billie"
},
"boleto": {
"$ref": "#/components/schemas/payment_method_details_boleto"
},
"crypto": {
"$ref": "#/components/schemas/payment_method_details_crypto"
},
"klarna": {
"$ref": "#/components/schemas/payment_method_details_klarna"
},
"mb_way": {
"$ref": "#/components/schemas/payment_method_details_mb_way"
},
"paynow": {
"$ref": "#/components/schemas/payment_method_details_paynow"
},
"paypal": {
"$ref": "#/components/schemas/payment_method_details_paypal"
},
"sofort": {
"$ref": "#/components/schemas/payment_method_details_sofort"
},
"sunbit": {
"$ref": "#/components/schemas/payment_method_details_sunbit"
},
"wechat": {
"$ref": "#/components/schemas/payment_method_details_wechat"
},
"cashapp": {
"$ref": "#/components/schemas/payment_method_details_cashapp"
},
"giropay": {
"$ref": "#/components/schemas/payment_method_details_giropay"
},
"grabpay": {
"$ref": "#/components/schemas/payment_method_details_grabpay"
},
"konbini": {
"$ref": "#/components/schemas/payment_method_details_konbini"
},
"kr_card": {
"$ref": "#/components/schemas/payment_method_details_kr_card"
},
"satispay": {
"$ref": "#/components/schemas/payment_method_details_satispay"
},
"ach_debit": {
"$ref": "#/components/schemas/payment_method_details_ach_debit"
},
"kakao_pay": {
"$ref": "#/components/schemas/payment_method_details_kakao_pay"
},
"mobilepay": {
"$ref": "#/components/schemas/payment_method_details_mobilepay"
},
"naver_pay": {
"$ref": "#/components/schemas/payment_method_details_naver_pay"
},
"promptpay": {
"$ref": "#/components/schemas/payment_method_details_promptpay"
},
"acss_debit": {
"$ref": "#/components/schemas/payment_method_details_acss_debit"
},
"amazon_pay": {
"$ref": "#/components/schemas/payment_method_details_amazon_pay"
},
"bacs_debit": {
"$ref": "#/components/schemas/payment_method_details_bacs_debit"
},
"bancontact": {
"$ref": "#/components/schemas/payment_method_details_bancontact"
},
"multibanco": {
"$ref": "#/components/schemas/payment_method_details_multibanco"
},
"sepa_debit": {
"$ref": "#/components/schemas/payment_method_details_sepa_debit"
},
"wechat_pay": {
"$ref": "#/components/schemas/payment_method_details_wechat_pay"
},
"pay_by_bank": {
"$ref": "#/components/schemas/payment_method_details_pay_by_bank"
},
"revolut_pay": {
"$ref": "#/components/schemas/payment_method_details_revolut_pay"
},
"samsung_pay": {
"$ref": "#/components/schemas/payment_method_details_samsung_pay"
},
"card_present": {
"$ref": "#/components/schemas/payment_method_details_card_present"
},
"au_becs_debit": {
"$ref": "#/components/schemas/payment_method_details_au_becs_debit"
},
"stripe_account": {
"$ref": "#/components/schemas/payment_method_details_stripe_account"
},
"interac_present": {
"$ref": "#/components/schemas/payment_method_details_interac_present"
},
"nz_bank_account": {
"$ref": "#/components/schemas/payment_method_details_nz_bank_account"
},
"us_bank_account": {
"$ref": "#/components/schemas/payment_method_details_us_bank_account"
},
"customer_balance": {
"$ref": "#/components/schemas/payment_method_details_customer_balance"
},
"afterpay_clearpay": {
"$ref": "#/components/schemas/payment_method_details_afterpay_clearpay"
},
"ach_credit_transfer": {
"$ref": "#/components/schemas/payment_method_details_ach_credit_transfer"
}
},
"description": "",
"x-expandableFields": [
"ach_credit_transfer",
"ach_debit",
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"card",
"card_present",
"cashapp",
"crypto",
"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",
"sepa_debit",
"sofort",
"stripe_account",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat",
"wechat_pay",
"zip"
]
}
payment_method_details_ach_credit_transfer
{
"type": "object",
"title": "payment_method_details_ach_credit_transfer",
"properties": {
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the routing number."
},
"swift_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "SWIFT code of the bank associated with the routing number."
},
"account_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Account number to transfer funds to."
},
"routing_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Routing transit number for the bank account to transfer funds to."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_ach_debit
{
"type": "object",
"title": "payment_method_details_ach_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country the bank account is located in."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
},
"routing_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Routing transit number of the bank account."
},
"account_holder_type": {
"enum": [
"company",
"individual"
],
"type": "string",
"nullable": true,
"description": "Type of entity that holds the account. This can be either `individual` or `company`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_acss_debit
{
"type": "object",
"title": "payment_method_details_acss_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"mandate": {
"type": "string",
"maxLength": 5000,
"description": "ID of the mandate used to make this payment."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
},
"transit_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Transit number of the bank account."
},
"institution_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Institution number of the bank account"
},
"expected_debit_date": {
"type": "string",
"maxLength": 5000,
"description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_affirm
{
"type": "object",
"title": "payment_method_details_affirm",
"properties": {
"reader": {
"type": "string",
"maxLength": 5000,
"description": "ID of the reader this transaction was made on."
},
"location": {
"type": "string",
"maxLength": 5000,
"description": "ID of the location that this reader is assigned to."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Affirm transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_afterpay_clearpay
{
"type": "object",
"title": "payment_method_details_afterpay_clearpay",
"properties": {
"order_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Afterpay order ID associated with this payment intent."
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Order identifier shown to the merchant in Afterpay's online portal."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_alma
{
"type": "object",
"title": "payment_method_details_alma",
"properties": {
"installments": {
"$ref": "#/components/schemas/alma_installments"
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Alma transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": [
"installments"
]
}
payment_method_details_amazon_pay
{
"type": "object",
"title": "payment_method_details_amazon_pay",
"properties": {
"funding": {
"$ref": "#/components/schemas/amazon_pay_underlying_payment_method_funding_details"
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Amazon Pay transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": [
"funding"
]
}
payment_method_details_au_becs_debit
{
"type": "object",
"title": "payment_method_details_au_becs_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"mandate": {
"type": "string",
"maxLength": 5000,
"description": "ID of the mandate used to make this payment."
},
"bsb_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank-State-Branch number of the bank account."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
},
"expected_debit_date": {
"type": "string",
"maxLength": 5000,
"description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_bacs_debit
{
"type": "object",
"title": "payment_method_details_bacs_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"mandate": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the mandate used to make this payment."
},
"sort_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Sort code of the bank account. (e.g., `10-20-30`)"
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
},
"expected_debit_date": {
"type": "string",
"maxLength": 5000,
"description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_bancontact
{
"type": "object",
"title": "payment_method_details_bancontact",
"properties": {
"bic": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank Identifier Code of the bank associated with the bank account."
},
"bank_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank code of bank associated with the bank account."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"iban_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"preferred_language": {
"enum": [
"de",
"en",
"fr",
"nl"
],
"type": "string",
"nullable": true,
"description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`"
},
"generated_sepa_debit": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"generated_sepa_debit_mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
]
}
payment_method_details_billie
{
"type": "object",
"title": "payment_method_details_billie",
"properties": {
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Billie transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_blik
{
"type": "object",
"title": "payment_method_details_blik",
"properties": {
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique and immutable identifier assigned by BLIK to every buyer."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_boleto
{
"type": "object",
"title": "payment_method_details_boleto",
"required": [
"tax_id"
],
"properties": {
"tax_id": {
"type": "string",
"maxLength": 5000,
"description": "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_card
{
"type": "object",
"title": "payment_method_details_card",
"required": [
"exp_month",
"exp_year"
],
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the card."
},
"checks": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_checks"
}
],
"nullable": true,
"description": "Check results by Card networks on Card address and CVC at time of payment."
},
"wallet": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_wallet"
}
],
"nullable": true,
"description": "If this Card is part of a card wallet, this contains the details of the card wallet."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"funding": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"mandate": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the mandate used to make this payment or created by it."
},
"network": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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`."
},
"exp_year": {
"type": "integer",
"description": "Four-digit number representing the card's expiration year."
},
"exp_month": {
"type": "integer",
"description": "Two-digit number representing the card's expiration month."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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.\n\n*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.*"
},
"overcapture": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"
},
"installments": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_installments"
}
],
"nullable": true,
"description": "Installment details for this payment.\n\nFor more information, see the [installments integration guide](https://docs.stripe.com/payments/installments)."
},
"multicapture": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_multicapture"
},
"network_token": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_network_token"
}
],
"nullable": true,
"description": "If this card has network token credentials, this contains the details of the network token credentials."
},
"capture_before": {
"type": "integer",
"format": "unix-time",
"description": "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured."
},
"three_d_secure": {
"anyOf": [
{
"$ref": "#/components/schemas/three_d_secure_details_charge"
}
],
"nullable": true,
"description": "Populated if this transaction used 3D Secure authentication."
},
"regulated_status": {
"enum": [
"regulated",
"unregulated"
],
"type": "string",
"nullable": true,
"description": "Status of a card based on the card issuer."
},
"amount_authorized": {
"type": "integer",
"nullable": true,
"description": "The authorized amount."
},
"authorization_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Authorization code on the charge."
},
"extended_authorization": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization"
},
"network_transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"incremental_authorization": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization"
}
},
"description": "",
"x-expandableFields": [
"checks",
"extended_authorization",
"incremental_authorization",
"installments",
"multicapture",
"network_token",
"overcapture",
"three_d_secure",
"wallet"
]
}
payment_method_details_card_checks
{
"type": "object",
"title": "payment_method_details_card_checks",
"properties": {
"cvc_check": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
},
"address_line1_check": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
},
"address_postal_code_check": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_card_installments
{
"type": "object",
"title": "payment_method_details_card_installments",
"properties": {
"plan": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_installments_plan"
}
],
"nullable": true,
"description": "Installment plan selected for the payment."
}
},
"description": "",
"x-expandableFields": [
"plan"
]
}
payment_method_details_card_installments_plan
{
"type": "object",
"title": "payment_method_details_card_installments_plan",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bonus",
"fixed_count",
"revolving"
],
"type": "string",
"description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`."
},
"count": {
"type": "integer",
"nullable": true,
"description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card."
},
"interval": {
"enum": [
"month"
],
"type": "string",
"nullable": true,
"description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_card_network_token
{
"type": "object",
"title": "payment_method_details_card_network_token",
"required": [
"used"
],
"properties": {
"used": {
"type": "boolean",
"description": "Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_card_present
{
"type": "object",
"title": "payment_method_details_card_present",
"required": [
"exp_month",
"exp_year",
"incremental_authorization_supported",
"overcapture_supported"
],
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the card."
},
"issuer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the card's issuing bank."
},
"reader": {
"type": "string",
"maxLength": 5000,
"description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
},
"wallet": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"funding": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"network": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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`."
},
"offline": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_present_offline"
}
],
"nullable": true,
"description": "Details about payments collected offline."
},
"receipt": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_present_receipt"
}
],
"nullable": true,
"description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions."
},
"exp_year": {
"type": "integer",
"description": "Four-digit number representing the card's expiration year."
},
"location": {
"type": "string",
"maxLength": 5000,
"description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
},
"exp_month": {
"type": "integer",
"description": "Two-digit number representing the card's expiration month."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A high-level description of the type of cards issued in this range."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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.\n\n*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.*"
},
"read_method": {
"enum": [
"contact_emv",
"contactless_emv",
"contactless_magstripe_mode",
"magnetic_stripe_fallback",
"magnetic_stripe_track2"
],
"type": "string",
"nullable": true,
"description": "How card details were read in this transaction."
},
"brand_product": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card."
},
"emv_auth_data": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Authorization response cryptogram."
},
"capture_before": {
"type": "integer",
"format": "unix-time",
"description": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured."
},
"generated_card": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"cardholder_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"amount_authorized": {
"type": "integer",
"nullable": true,
"description": "The authorized amount"
},
"preferred_locales": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "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."
},
"overcapture_supported": {
"type": "boolean",
"description": "Defines whether the authorized amount can be over-captured or not"
},
"network_transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"incremental_authorization_supported": {
"type": "boolean",
"description": "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)."
}
},
"description": "",
"x-expandableFields": [
"offline",
"receipt",
"wallet"
]
}
payment_method_details_card_present_offline
{
"type": "object",
"title": "payment_method_details_card_present_offline",
"properties": {
"type": {
"enum": [
"deferred"
],
"type": "string",
"nullable": true,
"description": "The method used to process this payment method offline. Only deferred is allowed."
},
"stored_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Time at which the payment was collected while offline"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_card_present_receipt
{
"type": "object",
"title": "payment_method_details_card_present_receipt",
"properties": {
"account_type": {
"enum": [
"checking",
"credit",
"prepaid",
"unknown"
],
"type": "string",
"description": "The type of account being debited or credited",
"x-stripeBypassValidation": true
},
"authorization_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Identifier for this transaction."
},
"dedicated_file_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84."
},
"application_cryptogram": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers."
},
"application_preferred_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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_response_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "EMV tag 8A. A code returned by the card issuer."
},
"terminal_verification_results": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"cardholder_verification_method": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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`."
},
"transaction_status_information": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_card_wallet
{
"type": "object",
"title": "payment_method_details_card_wallet",
"required": [
"type"
],
"properties": {
"link": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_link"
},
"type": {
"enum": [
"amex_express_checkout",
"apple_pay",
"google_pay",
"link",
"masterpass",
"samsung_pay",
"visa_checkout"
],
"type": "string",
"description": "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."
},
"apple_pay": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
},
"google_pay": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
},
"masterpass": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_masterpass"
},
"samsung_pay": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_samsung_pay"
},
"dynamic_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "(For tokenized numbers only.) The last four digits of the device account number."
},
"visa_checkout": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_visa_checkout"
},
"amex_express_checkout": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_amex_express_checkout"
}
},
"description": "",
"x-expandableFields": [
"amex_express_checkout",
"apple_pay",
"google_pay",
"link",
"masterpass",
"samsung_pay",
"visa_checkout"
]
}
payment_method_details_card_wallet_amex_express_checkout
{
"type": "object",
"title": "payment_method_details_card_wallet_amex_express_checkout",
"properties": {},
"description": "",
"x-expandableFields": []
}