Skip to content

Commit

Permalink
Update OpenAPI for 8dc9c09ec88b8f8a02a659897a85e045205fcf8d
Browse files Browse the repository at this point in the history
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] committed Aug 9, 2024
1 parent 69f103a commit 0168157
Showing 1 changed file with 193 additions and 0 deletions.
193 changes: 193 additions & 0 deletions embedded/openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9048,6 +9048,27 @@
"type": "object",
"x-expandableFields": []
},
"checkout_payto_payment_method_options": {
"description": "",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/mandate_options_payto"
},
"setup_future_usage": {
"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).",
"enum": [
"none",
"off_session"
],
"type": "string"
}
},
"title": "CheckoutPaytoPaymentMethodOptions",
"type": "object",
"x-expandableFields": [
"mandate_options"
]
},
"checkout_pix_payment_method_options": {
"description": "",
"properties": {
Expand Down Expand Up @@ -9178,6 +9199,9 @@
"paypal": {
"$ref": "#/components/schemas/checkout_paypal_payment_method_options"
},
"payto": {
"$ref": "#/components/schemas/checkout_payto_payment_method_options"
},
"pix": {
"$ref": "#/components/schemas/checkout_pix_payment_method_options"
},
Expand Down Expand Up @@ -9226,6 +9250,7 @@
"p24",
"paynow",
"paypal",
"payto",
"pix",
"revolut_pay",
"sepa_debit",
Expand Down Expand Up @@ -33563,6 +33588,91 @@
"type": "object",
"x-expandableFields": []
},
"mandate_options_payto": {
"description": "",
"properties": {
"amount": {
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`.",
"nullable": true,
"type": "integer"
},
"amount_type": {
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.",
"enum": [
"fixed",
"maximum"
],
"nullable": true,
"type": "string"
},
"end_date": {
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"payment_schedule": {
"description": "The periodicity at which payments will be collected.",
"enum": [
"adhoc",
"annual",
"daily",
"fortnightly",
"monthly",
"quarterly",
"semi_annual",
"weekly"
],
"nullable": true,
"type": "string"
},
"payments_per_period": {
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.",
"nullable": true,
"type": "integer"
},
"purpose": {
"description": "The purpose for which payments are made. Defaults to retail.",
"enum": [
"dependant_support",
"government",
"loan",
"mortgage",
"other",
"pension",
"personal",
"retail",
"salary",
"tax",
"utility"
],
"nullable": true,
"type": "string"
},
"start_date": {
"description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
"required": [
"amount",
"amount_type",
"end_date",
"payment_schedule",
"payments_per_period",
"purpose",
"start_date"
],
"title": "mandate_options_payto",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Payto",
"in_package": ""
}
},
"mandate_payment_method_details": {
"description": "",
"properties": {
Expand Down Expand Up @@ -39072,6 +39182,7 @@
"p24",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"sepa_debit",
Expand Down Expand Up @@ -92105,6 +92216,85 @@
"title": "payment_method_options_param",
"type": "object"
},
"payto": {
"description": "contains details about the PayTo payment method options.",
"properties": {
"mandate_options": {
"description": "Additional fields for Mandate creation",
"properties": {
"amount": {
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`.",
"type": "integer"
},
"amount_type": {
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.",
"enum": [
"fixed",
"maximum"
],
"type": "string"
},
"end_date": {
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.",
"maxLength": 5000,
"type": "string"
},
"payment_schedule": {
"description": "The periodicity at which payments will be collected.",
"enum": [
"adhoc",
"annual",
"daily",
"fortnightly",
"monthly",
"quarterly",
"semi_annual",
"weekly"
],
"type": "string"
},
"payments_per_period": {
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.",
"type": "integer"
},
"purpose": {
"description": "The purpose for which payments are made. Defaults to retail.",
"enum": [
"dependant_support",
"government",
"loan",
"mortgage",
"other",
"pension",
"personal",
"retail",
"salary",
"tax",
"utility"
],
"type": "string"
},
"start_date": {
"description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.",
"maxLength": 5000,
"type": "string"
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
"type": "object"
},
"setup_future_usage": {
"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).",
"enum": [
"none",
"off_session"
],
"type": "string"
}
},
"title": "payment_method_options_param",
"type": "object"
},
"pix": {
"description": "contains details about the Pix payment method options.",
"properties": {
Expand Down Expand Up @@ -92300,6 +92490,7 @@
"p24",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"revolut_pay",
Expand Down Expand Up @@ -153353,6 +153544,7 @@
"p24",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"sepa_debit",
Expand Down Expand Up @@ -154669,6 +154861,7 @@
"p24",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"sepa_debit",
Expand Down

0 comments on commit 0168157

Please sign in to comment.