payment_method_details_revolut_pay
{
"type": "object",
"title": "payment_method_details_revolut_pay",
"properties": {
"funding": {
"$ref": "#/components/schemas/revolut_pay_underlying_payment_method_funding_details"
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Revolut Pay transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": [
"funding"
]
}
payment_method_details_samsung_pay
{
"type": "object",
"title": "payment_method_details_samsung_pay",
"properties": {
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique identifier for the buyer as determined by the local payment processor."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Samsung Pay transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_satispay
{
"type": "object",
"title": "payment_method_details_satispay",
"properties": {
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Satispay transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_scalapay
{
"type": "object",
"title": "payment_method_details_scalapay",
"properties": {
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Scalapay transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_sepa_debit
{
"type": "object",
"title": "payment_method_details_sepa_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country the bank account is located in."
},
"mandate": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve)."
},
"bank_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank code of bank associated with the bank account."
},
"branch_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Branch code of 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."
},
"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_sofort
{
"type": "object",
"title": "payment_method_details_sofort",
"properties": {
"bic": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank Identifier Code of the bank associated with the bank account."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country the bank account is located in."
},
"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 SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"preferred_language": {
"enum": [
"de",
"en",
"es",
"fr",
"it",
"nl",
"pl"
],
"type": "string",
"nullable": true,
"description": "Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`"
},
"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_stripe_account
{
"type": "object",
"title": "payment_method_details_stripe_account",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_sunbit
{
"type": "object",
"title": "payment_method_details_sunbit",
"properties": {
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Sunbit transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_swish
{
"type": "object",
"title": "payment_method_details_swish",
"properties": {
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer"
},
"payment_reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Payer bank reference number for the payment"
},
"verified_phone_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the Swish account phone number"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_twint
{
"type": "object",
"title": "payment_method_details_twint",
"properties": {
"mandate": {
"type": "string",
"maxLength": 5000,
"description": "ID of the multi use Mandate generated by the PaymentIntent"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_upi
{
"type": "object",
"title": "payment_method_details_upi",
"properties": {
"vpa": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Customer's unique Virtual Payment Address."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_us_bank_account
{
"type": "object",
"title": "payment_method_details_us_bank_account",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"description": "ID of the mandate used to make this payment.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
},
"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."
},
"account_type": {
"enum": [
"checking",
"savings"
],
"type": "string",
"nullable": true,
"description": "Account type: checkings or savings. Defaults to checking if omitted."
},
"routing_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Routing number of the bank account."
},
"payment_reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Reference number to locate ACH payments with customer's bank."
},
"account_holder_type": {
"enum": [
"company",
"individual"
],
"type": "string",
"nullable": true,
"description": "Account holder type: individual or company."
},
"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": [
"mandate"
]
}
payment_method_details_wechat
{
"type": "object",
"title": "payment_method_details_wechat",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_wechat_pay
{
"type": "object",
"title": "payment_method_details_wechat_pay",
"properties": {
"reader": {
"type": "string",
"maxLength": 5000,
"description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
},
"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."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Transaction ID of this particular WeChat Pay transaction."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_zip
{
"type": "object",
"title": "payment_method_details_zip",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_domain
{
"type": "object",
"title": "PaymentMethodDomainResourcePaymentMethodDomain",
"required": [
"amazon_pay",
"apple_pay",
"created",
"domain_name",
"enabled",
"google_pay",
"id",
"klarna",
"link",
"livemode",
"object",
"paypal"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"link": {
"$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
},
"klarna": {
"$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
},
"object": {
"enum": [
"payment_method_domain"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"paypal": {
"$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"enabled": {
"type": "boolean",
"description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements."
},
"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`."
},
"apple_pay": {
"$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
},
"amazon_pay": {
"$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
},
"google_pay": {
"$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
},
"domain_name": {
"type": "string",
"maxLength": 5000,
"description": "The domain name that this payment method domain object represents."
}
},
"description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guide: [Payment method domains](https://docs.stripe.com/payments/payment-methods/pmd-registration).",
"x-resourceId": "payment_method_domain",
"x-expandableFields": [
"amazon_pay",
"apple_pay",
"google_pay",
"klarna",
"link",
"paypal"
]
}
payment_method_domain_resource_payment_method_status
{
"type": "object",
"title": "PaymentMethodDomainResourcePaymentMethodStatus",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"active",
"inactive"
],
"type": "string",
"description": "The status of the payment method on the domain."
},
"status_details": {
"$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status_details"
}
},
"description": "Indicates the status of a specific payment method on a payment method domain.",
"x-expandableFields": [
"status_details"
]
}
payment_method_domain_resource_payment_method_status_details
{
"type": "object",
"title": "PaymentMethodDomainResourcePaymentMethodStatusDetails",
"required": [
"error_message"
],
"properties": {
"error_message": {
"type": "string",
"maxLength": 5000,
"description": "The error message associated with the status of the payment method on the domain."
}
},
"description": "Contains additional details about the status of a payment method for a specific payment method domain.",
"x-expandableFields": []
}
payment_method_eps
{
"type": "object",
"title": "payment_method_eps",
"properties": {
"bank": {
"enum": [
"arzte_und_apotheker_bank",
"austrian_anadi_bank_ag",
"bank_austria",
"bankhaus_carl_spangler",
"bankhaus_schelhammer_und_schattera_ag",
"bawag_psk_ag",
"bks_bank_ag",
"brull_kallmus_bank_ag",
"btv_vier_lander_bank",
"capital_bank_grawe_gruppe_ag",
"deutsche_bank_ag",
"dolomitenbank",
"easybank_ag",
"erste_bank_und_sparkassen",
"hypo_alpeadriabank_international_ag",
"hypo_bank_burgenland_aktiengesellschaft",
"hypo_noe_lb_fur_niederosterreich_u_wien",
"hypo_oberosterreich_salzburg_steiermark",
"hypo_tirol_bank_ag",
"hypo_vorarlberg_bank_ag",
"marchfelder_bank",
"oberbank_ag",
"raiffeisen_bankengruppe_osterreich",
"schoellerbank_ag",
"sparda_bank_wien",
"volksbank_gruppe",
"volkskreditbank_ag",
"vr_bank_braunau"
],
"type": "string",
"nullable": true,
"description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_fpx
{
"type": "object",
"title": "payment_method_fpx",
"required": [
"bank"
],
"properties": {
"bank": {
"enum": [
"affin_bank",
"agrobank",
"alliance_bank",
"ambank",
"bank_islam",
"bank_muamalat",
"bank_of_china",
"bank_rakyat",
"bsn",
"cimb",
"deutsche_bank",
"hong_leong_bank",
"hsbc",
"kfh",
"maybank2e",
"maybank2u",
"ocbc",
"pb_enterprise",
"public_bank",
"rhb",
"standard_chartered",
"uob"
],
"type": "string",
"description": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_giropay
{
"type": "object",
"title": "payment_method_giropay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_grabpay
{
"type": "object",
"title": "payment_method_grabpay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_ideal
{
"type": "object",
"title": "payment_method_ideal",
"properties": {
"bic": {
"enum": [
"ABNANL2A",
"ADYBNL2A",
"ASNBNL21",
"BITSNL2A",
"BUNQNL2A",
"BUUTNL2A",
"FNOMNL22",
"FVLBNL22",
"HANDNL2A",
"INGBNL2A",
"KNABNL2H",
"MLLENL2A",
"MOYONL21",
"NNBANL2G",
"NTSBDEB1",
"RABONL2U",
"RBRBNL21",
"REVOIE23",
"REVOLT21",
"SNSBNL2A",
"TRIONL2U"
],
"type": "string",
"nullable": true,
"description": "The Bank Identifier Code of the customer's bank, if the bank was provided."
},
"bank": {
"enum": [
"abn_amro",
"adyen",
"asn_bank",
"bunq",
"buut",
"finom",
"handelsbanken",
"ing",
"knab",
"mollie",
"moneyou",
"n26",
"nn",
"rabobank",
"regiobank",
"revolut",
"sns_bank",
"triodos_bank",
"van_lanschot",
"yoursafe"
],
"type": "string",
"nullable": true,
"description": "The customer's bank, if provided. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_interac_present
{
"type": "object",
"title": "payment_method_interac_present",
"required": [
"exp_month",
"exp_year"
],
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card brand. Can be `interac`, `mastercard` or `visa`."
},
"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."
},
"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`."
},
"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."
},
"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"
]
}
payment_method_kakao_pay
{
"type": "object",
"title": "payment_method_kakao_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_klarna
{
"type": "object",
"title": "payment_method_klarna",
"properties": {
"dob": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_dob"
}
],
"nullable": true,
"description": "The customer's date of birth, if provided."
}
},
"description": "",
"x-expandableFields": [
"dob"
]
}
payment_method_konbini
{
"type": "object",
"title": "payment_method_konbini",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_kr_card
{
"type": "object",
"title": "payment_method_kr_card",
"properties": {
"brand": {
"enum": [
"bc",
"citi",
"hana",
"hyundai",
"jeju",
"jeonbuk",
"kakaobank",
"kbank",
"kdbbank",
"kookmin",
"kwangju",
"lotte",
"mg",
"nh",
"post",
"samsung",
"savingsbank",
"shinhan",
"shinhyup",
"suhyup",
"tossbank",
"woori"
],
"type": "string",
"nullable": true,
"description": "The local credit or debit card brand."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 4,
"description": "The last four digits of the card. This may not be present for American Express cards."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_link
{
"type": "object",
"title": "payment_method_link",
"properties": {
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Account owner's email address."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_mb_way
{
"type": "object",
"title": "payment_method_mb_way",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_mobilepay
{
"type": "object",
"title": "payment_method_mobilepay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_multibanco
{
"type": "object",
"title": "payment_method_multibanco",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_naver_pay
{
"type": "object",
"title": "payment_method_naver_pay",
"required": [
"funding"
],
"properties": {
"funding": {
"enum": [
"card",
"points"
],
"type": "string",
"description": "Whether to fund this transaction with Naver Pay points or a card.",
"x-stripeBypassValidation": true
},
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_nz_bank_account
{
"type": "object",
"title": "payment_method_nz_bank_account",
"required": [
"bank_code",
"bank_name",
"branch_code",
"last4"
],
"properties": {
"last4": {
"type": "string",
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"suffix": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The suffix of the bank account number."
},
"bank_code": {
"type": "string",
"maxLength": 5000,
"description": "The numeric code for the bank account's bank."
},
"bank_name": {
"type": "string",
"maxLength": 5000,
"description": "The name of the bank."
},
"branch_code": {
"type": "string",
"maxLength": 5000,
"description": "The numeric code for the bank account's bank branch."
},
"account_holder_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_affirm
{
"type": "object",
"title": "payment_method_options_affirm",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"preferred_locale": {
"type": "string",
"maxLength": 30,
"description": "Preferred language of the Affirm authorization page that the customer is redirected to."
},
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_afterpay_clearpay
{
"type": "object",
"title": "payment_method_options_afterpay_clearpay",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name."
},
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_alipay
{
"type": "object",
"title": "payment_method_options_alipay",
"properties": {
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_alma
{
"type": "object",
"title": "payment_method_options_alma",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_amazon_pay
{
"type": "object",
"title": "payment_method_options_amazon_pay",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_bancontact
{
"type": "object",
"title": "payment_method_options_bancontact",
"required": [
"preferred_language"
],
"properties": {
"preferred_language": {
"enum": [
"de",
"en",
"fr",
"nl"
],
"type": "string",
"description": "Preferred language of the Bancontact authorization page that the customer is redirected to."
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_billie
{
"type": "object",
"title": "payment_method_options_billie",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_bizum
{
"type": "object",
"title": "payment_method_options_bizum",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_options_boleto
{
"type": "object",
"title": "payment_method_options_boleto",
"required": [
"expires_after_days"
],
"properties": {
"expires_after_days": {
"type": "integer",
"description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time."
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_card_installments
{
"type": "object",
"title": "payment_method_options_card_installments",
"required": [
"enabled"
],
"properties": {
"plan": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_installments_plan"
}
],
"nullable": true,
"description": "Installment plan selected for this PaymentIntent."
},
"enabled": {
"type": "boolean",
"description": "Whether Installments are enabled for this PaymentIntent."
},
"available_plans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payment_method_details_card_installments_plan"
},
"nullable": true,
"description": "Installment plans that may be selected for this PaymentIntent."
}
},
"description": "",
"x-expandableFields": [
"available_plans",
"plan"
]
}
payment_method_options_card_mandate_options
{
"type": "object",
"title": "payment_method_options_card_mandate_options",
"required": [
"amount",
"amount_type",
"interval",
"reference",
"start_date"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount to be charged for future payments, specified in the presentment currency."
},
"end_date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."
},
"interval": {
"enum": [
"day",
"month",
"sporadic",
"week",
"year"
],
"type": "string",
"description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`."
},
"reference": {
"type": "string",
"maxLength": 80,
"description": "Unique identifier for the mandate or subscription."
},
"start_date": {
"type": "integer",
"format": "unix-time",
"description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday."
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string",
"description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "A description of the mandate or subscription that is meant to be displayed to the customer."
},
"interval_count": {
"type": "integer",
"nullable": true,
"description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`."
},
"supported_types": {
"type": "array",
"items": {
"enum": [
"india"
],
"type": "string"
},
"nullable": true,
"description": "Specifies the type of mandates supported. Possible values are `india`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_card_present
{
"type": "object",
"title": "payment_method_options_card_present",
"properties": {
"routing": {
"$ref": "#/components/schemas/payment_method_options_card_present_routing"
},
"capture_method": {
"enum": [
"manual",
"manual_preferred"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account.",
"x-stripeBypassValidation": true
},
"request_extended_authorization": {
"type": "boolean",
"nullable": true,
"description": "Request ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity)"
},
"request_incremental_authorization_support": {
"type": "boolean",
"nullable": true,
"description": "Request ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support."
}
},
"description": "",
"x-expandableFields": [
"routing"
]
}
payment_method_options_card_present_routing
{
"type": "object",
"title": "payment_method_options_card_present_routing",
"properties": {
"requested_priority": {
"enum": [
"domestic",
"international"
],
"type": "string",
"nullable": true,
"description": "Requested routing priority"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_cashapp
{
"type": "object",
"title": "payment_method_options_cashapp",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_crypto
{
"type": "object",
"title": "payment_method_options_crypto",
"properties": {
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_customer_balance
{
"type": "object",
"title": "payment_method_options_customer_balance",
"properties": {
"funding_type": {
"enum": [
"bank_transfer"
],
"type": "string",
"nullable": true,
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."
},
"bank_transfer": {
"$ref": "#/components/schemas/payment_method_options_customer_balance_bank_transfer"
},
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": [
"bank_transfer"
]
}