payment_links_resource_payment_intent_data
{
"type": "object",
"title": "PaymentLinksResourcePaymentIntentData",
"required": [
"metadata"
],
"properties": {
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"capture_method": {
"enum": [
"automatic",
"automatic_async",
"manual"
],
"type": "string",
"nullable": true,
"description": "Indicates when the funds will be captured from the customer's account."
},
"transfer_group": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details."
},
"setup_future_usage": {
"enum": [
"off_session",
"on_session"
],
"type": "string",
"nullable": true,
"description": "Indicates that you intend to make future payments with the payment method collected during checkout."
},
"statement_descriptor": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge."
},
"statement_descriptor_suffix": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_payment_method_options
{
"type": "object",
"title": "PaymentLinksResourcePaymentMethodOptions",
"properties": {
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_card_payment_method_options"
}
],
"nullable": true,
"description": "Configuration for `card` payment methods."
}
},
"description": "",
"x-expandableFields": [
"card"
]
}
payment_links_resource_payment_method_reuse_agreement
{
"type": "object",
"title": "PaymentLinksResourcePaymentMethodReuseAgreement",
"required": [
"position"
],
"properties": {
"position": {
"enum": [
"auto",
"hidden"
],
"type": "string",
"description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_phone_number_collection
{
"type": "object",
"title": "PaymentLinksResourcePhoneNumberCollection",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "If `true`, a phone number will be collected during checkout."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_restrictions
{
"type": "object",
"title": "PaymentLinksResourceRestrictions",
"required": [
"completed_sessions"
],
"properties": {
"completed_sessions": {
"$ref": "#/components/schemas/payment_links_resource_completed_sessions"
}
},
"description": "",
"x-expandableFields": [
"completed_sessions"
]
}
payment_links_resource_shipping_address_collection
{
"type": "object",
"title": "PaymentLinksResourceShippingAddressCollection",
"required": [
"allowed_countries"
],
"properties": {
"allowed_countries": {
"type": "array",
"items": {
"enum": [
"AC",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CV",
"CW",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MK",
"ML",
"MM",
"MN",
"MO",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SZ",
"TA",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VN",
"VU",
"WF",
"WS",
"XK",
"YE",
"YT",
"ZA",
"ZM",
"ZW",
"ZZ"
],
"type": "string"
},
"description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_shipping_option
{
"type": "object",
"title": "PaymentLinksResourceShippingOption",
"required": [
"shipping_amount",
"shipping_rate"
],
"properties": {
"shipping_rate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/shipping_rate"
}
],
"description": "The ID of the Shipping Rate to use for this shipping option.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/shipping_rate"
}
]
}
},
"shipping_amount": {
"type": "integer",
"description": "A non-negative integer in cents representing how much to charge."
}
},
"description": "",
"x-expandableFields": [
"shipping_rate"
]
}
payment_links_resource_subscription_data
{
"type": "object",
"title": "PaymentLinksResourceSubscriptionData",
"required": [
"invoice_settings",
"metadata"
],
"properties": {
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
},
"trial_settings": {
"anyOf": [
{
"$ref": "#/components/schemas/subscriptions_trials_resource_trial_settings"
}
],
"nullable": true,
"description": "Settings related to subscription trials."
},
"invoice_settings": {
"$ref": "#/components/schemas/payment_links_resource_subscription_data_invoice_settings"
},
"trial_period_days": {
"type": "integer",
"nullable": true,
"description": "Integer representing the number of trial period days before the customer is charged for the first time."
}
},
"description": "",
"x-expandableFields": [
"invoice_settings",
"trial_settings"
]
}
payment_links_resource_subscription_data_invoice_settings
{
"type": "object",
"title": "PaymentLinksResourceSubscriptionDataInvoiceSettings",
"required": [
"issuer"
],
"properties": {
"issuer": {
"$ref": "#/components/schemas/connect_account_reference"
}
},
"description": "",
"x-expandableFields": [
"issuer"
]
}
payment_links_resource_tax_id_collection
{
"type": "object",
"title": "PaymentLinksResourceTaxIdCollection",
"required": [
"enabled",
"required"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether tax ID collection is enabled for the session."
},
"required": {
"enum": [
"if_supported",
"never"
],
"type": "string"
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_transfer_data
{
"type": "object",
"title": "PaymentLinksResourceTransferData",
"required": [
"destination"
],
"properties": {
"amount": {
"type": "integer",
"nullable": true,
"description": "The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination."
},
"destination": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"description": "The connected account receiving the transfer.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"destination"
]
}
payment_method
{
"type": "object",
"title": "PaymentMethod",
"required": [
"billing_details",
"created",
"id",
"livemode",
"object",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"eps": {
"$ref": "#/components/schemas/payment_method_eps"
},
"fpx": {
"$ref": "#/components/schemas/payment_method_fpx"
},
"p24": {
"$ref": "#/components/schemas/payment_method_p24"
},
"pix": {
"$ref": "#/components/schemas/payment_method_pix"
},
"upi": {
"$ref": "#/components/schemas/payment_method_upi"
},
"zip": {
"$ref": "#/components/schemas/payment_method_zip"
},
"alma": {
"$ref": "#/components/schemas/payment_method_alma"
},
"blik": {
"$ref": "#/components/schemas/payment_method_blik"
},
"card": {
"$ref": "#/components/schemas/payment_method_card"
},
"link": {
"$ref": "#/components/schemas/payment_method_link"
},
"oxxo": {
"$ref": "#/components/schemas/payment_method_oxxo"
},
"type": {
"enum": [
"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"
],
"type": "string",
"description": "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.",
"x-stripeBypassValidation": true
},
"bizum": {
"$ref": "#/components/schemas/payment_method_bizum"
},
"ideal": {
"$ref": "#/components/schemas/payment_method_ideal"
},
"payco": {
"$ref": "#/components/schemas/payment_method_payco"
},
"payto": {
"$ref": "#/components/schemas/payment_method_payto"
},
"swish": {
"$ref": "#/components/schemas/payment_method_swish"
},
"twint": {
"$ref": "#/components/schemas/payment_method_twint"
},
"affirm": {
"$ref": "#/components/schemas/payment_method_affirm"
},
"alipay": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay"
},
"billie": {
"$ref": "#/components/schemas/payment_method_billie"
},
"boleto": {
"$ref": "#/components/schemas/payment_method_boleto"
},
"crypto": {
"$ref": "#/components/schemas/payment_method_crypto"
},
"custom": {
"$ref": "#/components/schemas/payment_method_custom"
},
"klarna": {
"$ref": "#/components/schemas/payment_method_klarna"
},
"mb_way": {
"$ref": "#/components/schemas/payment_method_mb_way"
},
"object": {
"enum": [
"payment_method"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"paynow": {
"$ref": "#/components/schemas/payment_method_paynow"
},
"paypal": {
"$ref": "#/components/schemas/payment_method_paypal"
},
"sofort": {
"$ref": "#/components/schemas/payment_method_sofort"
},
"sunbit": {
"$ref": "#/components/schemas/payment_method_sunbit"
},
"cashapp": {
"$ref": "#/components/schemas/payment_method_cashapp"
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"giropay": {
"$ref": "#/components/schemas/payment_method_giropay"
},
"grabpay": {
"$ref": "#/components/schemas/payment_method_grabpay"
},
"konbini": {
"$ref": "#/components/schemas/payment_method_konbini"
},
"kr_card": {
"$ref": "#/components/schemas/payment_method_kr_card"
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
}
],
"nullable": true,
"description": "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.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
}
]
}
},
"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`."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"satispay": {
"$ref": "#/components/schemas/payment_method_satispay"
},
"scalapay": {
"$ref": "#/components/schemas/payment_method_scalapay"
},
"kakao_pay": {
"$ref": "#/components/schemas/payment_method_kakao_pay"
},
"mobilepay": {
"$ref": "#/components/schemas/payment_method_mobilepay"
},
"naver_pay": {
"$ref": "#/components/schemas/payment_method_naver_pay"
},
"promptpay": {
"$ref": "#/components/schemas/payment_method_promptpay"
},
"acss_debit": {
"$ref": "#/components/schemas/payment_method_acss_debit"
},
"amazon_pay": {
"$ref": "#/components/schemas/payment_method_amazon_pay"
},
"bacs_debit": {
"$ref": "#/components/schemas/payment_method_bacs_debit"
},
"bancontact": {
"$ref": "#/components/schemas/payment_method_bancontact"
},
"multibanco": {
"$ref": "#/components/schemas/payment_method_multibanco"
},
"sepa_debit": {
"$ref": "#/components/schemas/payment_method_sepa_debit"
},
"wechat_pay": {
"$ref": "#/components/schemas/payment_method_wechat_pay"
},
"pay_by_bank": {
"$ref": "#/components/schemas/payment_method_pay_by_bank"
},
"revolut_pay": {
"$ref": "#/components/schemas/payment_method_revolut_pay"
},
"samsung_pay": {
"$ref": "#/components/schemas/payment_method_samsung_pay"
},
"card_present": {
"$ref": "#/components/schemas/payment_method_card_present"
},
"au_becs_debit": {
"$ref": "#/components/schemas/payment_method_au_becs_debit"
},
"radar_options": {
"$ref": "#/components/schemas/radar_radar_options"
},
"allow_redisplay": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string",
"description": "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”."
},
"billing_details": {
"$ref": "#/components/schemas/billing_details"
},
"interac_present": {
"$ref": "#/components/schemas/payment_method_interac_present"
},
"nz_bank_account": {
"$ref": "#/components/schemas/payment_method_nz_bank_account"
},
"us_bank_account": {
"$ref": "#/components/schemas/payment_method_us_bank_account"
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000
},
"customer_balance": {
"$ref": "#/components/schemas/payment_method_customer_balance"
},
"afterpay_clearpay": {
"$ref": "#/components/schemas/payment_method_afterpay_clearpay"
}
},
"description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios).",
"x-resourceId": "payment_method",
"x-expandableFields": [
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"billing_details",
"bizum",
"blik",
"boleto",
"card",
"card_present",
"cashapp",
"crypto",
"custom",
"customer",
"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",
"radar_options",
"revolut_pay",
"samsung_pay",
"satispay",
"scalapay",
"sepa_debit",
"sofort",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay",
"zip"
]
}
payment_method_acss_debit
{
"type": "object",
"title": "payment_method_acss_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"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."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_affirm
{
"type": "object",
"title": "payment_method_affirm",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_afterpay_clearpay
{
"type": "object",
"title": "payment_method_afterpay_clearpay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_alma
{
"type": "object",
"title": "payment_method_alma",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_amazon_pay
{
"type": "object",
"title": "payment_method_amazon_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_au_becs_debit
{
"type": "object",
"title": "payment_method_au_becs_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"bsb_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Six-digit number identifying bank and branch associated with this 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."
}
},
"description": "",
"x-expandableFields": []
}
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_bizum
{
"type": "object",
"title": "payment_method_bizum",
"properties": {
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique identifier for the buyer as determined by the local payment processor."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_blik
{
"type": "object",
"title": "payment_method_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_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"
},
"bizum": {
"$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"
},
"scalapay": {
"$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",
"bizum",
"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",
"scalapay",
"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."
},
"bizum": {
"$ref": "#/components/schemas/payment_method_details_bizum"
},
"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"
},
"scalapay": {
"$ref": "#/components/schemas/payment_method_details_scalapay"
},
"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",
"bizum",
"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",
"scalapay",
"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": []
}