From 0f2952a3b21ad4b35026907920ce53cd260dea53 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Tue, 10 Dec 2024 01:08:35 +0000 Subject: [PATCH] Update OpenAPI specification for beta --- openapi/spec3.beta.sdk.json | 100 ++++++++++++++++++++++++++++++++++++ openapi/spec3.beta.sdk.yaml | 89 ++++++++++++++++++++++++++++++++ 2 files changed, 189 insertions(+) diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json index 18837ff1..68d8545a 100644 --- a/openapi/spec3.beta.sdk.json +++ b/openapi/spec3.beta.sdk.json @@ -42969,6 +42969,30 @@ "status" ] }, + "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_partial_authorization_partial_authorization": { + "description": "", + "properties": { + "status": { + "description": "Indicates whether the transaction requested for partial authorization feature and the authorization outcome.", + "enum": [ + "declined", + "fully_authorized", + "not_requested", + "partially_authorized" + ], + "type": "string" + } + }, + "required": [ + "status" + ], + "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesPartialAuthorizationPartialAuthorization", + "type": "object", + "x-expandableFields": [], + "x-stripeMostCommon": [ + "status" + ] + }, "payment_flows_private_payment_methods_card_details_api_resource_multicapture": { "description": "", "properties": { @@ -45622,6 +45646,14 @@ ], "type": "string" }, + "request_partial_authorization": { + "description": "Request partial authorization on this PaymentIntent.", + "enum": [ + "if_available", + "never" + ], + "type": "string" + }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ @@ -45683,6 +45715,7 @@ "request_incremental_authorization", "request_multicapture", "request_overcapture", + "request_partial_authorization", "request_three_d_secure", "require_cvc_recollection", "setup_future_usage", @@ -50346,6 +50379,11 @@ "nullable": true, "type": "integer" }, + "amount_requested": { + "description": "The latest amount intended to be authorized by this charge.", + "nullable": true, + "type": "integer" + }, "authorization_code": { "description": "Authorization code on the charge.", "maxLength": 5000, @@ -50472,6 +50510,9 @@ "overcapture": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture" }, + "partial_authorization": { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_partial_authorization_partial_authorization" + }, "regulated_status": { "description": "Status of a card based on the card issuer.", "enum": [ @@ -50527,11 +50568,13 @@ "multicapture", "network_token", "overcapture", + "partial_authorization", "three_d_secure", "wallet" ], "x-stripeMostCommon": [ "amount_authorized", + "amount_requested", "authorization_code", "brand", "capture_before", @@ -50555,6 +50598,7 @@ "network", "network_token", "overcapture", + "partial_authorization", "regulated_status", "three_d_secure", "wallet" @@ -166378,6 +166422,14 @@ ], "type": "string" }, + "request_partial_authorization": { + "description": "Request partial authorization on this PaymentIntent.", + "enum": [ + "if_available", + "never" + ], + "type": "string" + }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ @@ -171984,6 +172036,14 @@ ], "type": "string" }, + "request_partial_authorization": { + "description": "Request partial authorization on this PaymentIntent.", + "enum": [ + "if_available", + "never" + ], + "type": "string" + }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ @@ -178786,6 +178846,14 @@ ], "type": "string" }, + "request_partial_authorization": { + "description": "Request partial authorization on this PaymentIntent.", + "enum": [ + "if_available", + "never" + ], + "type": "string" + }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ @@ -181431,6 +181499,10 @@ "explode": true, "style": "deepObject" }, + "payment_method_options": { + "explode": true, + "style": "deepObject" + }, "transfer_data": { "explode": true, "style": "deepObject" @@ -181515,6 +181587,34 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "payment_method_options": { + "description": "Payment method-specific configuration for this PaymentIntent.", + "properties": { + "card": { + "description": "Configuration for any card payments attempted on this PaymentIntent.", + "properties": { + "request_partial_authorization": { + "description": "Request partial authorization on this PaymentIntent.", + "enum": [ + "if_available", + "never" + ], + "type": "string" + } + }, + "title": "payment_intent_increment_authorization_param", + "type": "object", + "x-stripeMostCommon": [ + "request_partial_authorization" + ] + } + }, + "title": "payment_method_options_increment_authorization_param", + "type": "object", + "x-stripeMostCommon": [ + "card" + ] + }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).", "maxLength": 22, diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml index 1229959c..6004b4ec 100644 --- a/openapi/spec3.beta.sdk.yaml +++ b/openapi/spec3.beta.sdk.yaml @@ -38728,6 +38728,27 @@ components: x-stripeMostCommon: - maximum_amount_capturable - status + payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_partial_authorization_partial_authorization: + description: '' + properties: + status: + description: >- + Indicates whether the transaction requested for partial + authorization feature and the authorization outcome. + enum: + - declined + - fully_authorized + - not_requested + - partially_authorized + type: string + required: + - status + title: >- + PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesPartialAuthorizationPartialAuthorization + type: object + x-expandableFields: [] + x-stripeMostCommon: + - status payment_flows_private_payment_methods_card_details_api_resource_multicapture: description: '' properties: @@ -41164,6 +41185,12 @@ components: - if_available - never type: string + request_partial_authorization: + description: Request partial authorization on this PaymentIntent. + enum: + - if_available + - never + type: string request_three_d_secure: description: >- We strongly recommend that you rely on our SCA Engine to @@ -41263,6 +41290,7 @@ components: - request_incremental_authorization - request_multicapture - request_overcapture + - request_partial_authorization - request_three_d_secure - require_cvc_recollection - setup_future_usage @@ -45553,6 +45581,10 @@ components: description: The authorized amount. nullable: true type: integer + amount_requested: + description: The latest amount intended to be authorized by this charge. + nullable: true + type: integer authorization_code: description: Authorization code on the charge. maxLength: 5000 @@ -45692,6 +45724,9 @@ components: overcapture: $ref: >- #/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture + partial_authorization: + $ref: >- + #/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_partial_authorization_partial_authorization regulated_status: description: Status of a card based on the card issuer. enum: @@ -45737,10 +45772,12 @@ components: - multicapture - network_token - overcapture + - partial_authorization - three_d_secure - wallet x-stripeMostCommon: - amount_authorized + - amount_requested - authorization_code - brand - capture_before @@ -45764,6 +45801,7 @@ components: - network - network_token - overcapture + - partial_authorization - regulated_status - three_d_secure - wallet @@ -153595,6 +153633,14 @@ paths: - if_available - never type: string + request_partial_authorization: + description: >- + Request partial authorization on this + PaymentIntent. + enum: + - if_available + - never + type: string request_three_d_secure: description: >- We strongly recommend that you rely on our SCA @@ -160590,6 +160636,14 @@ paths: - if_available - never type: string + request_partial_authorization: + description: >- + Request partial authorization on this + PaymentIntent. + enum: + - if_available + - never + type: string request_three_d_secure: description: >- We strongly recommend that you rely on our SCA @@ -168700,6 +168754,14 @@ paths: - if_available - never type: string + request_partial_authorization: + description: >- + Request partial authorization on this + PaymentIntent. + enum: + - if_available + - never + type: string request_three_d_secure: description: >- We strongly recommend that you rely on our SCA @@ -172497,6 +172559,9 @@ paths: metadata: explode: true style: deepObject + payment_method_options: + explode: true + style: deepObject transfer_data: explode: true style: deepObject @@ -172577,6 +172642,30 @@ paths: value to them. All keys can be unset by posting an empty value to `metadata`. type: object + payment_method_options: + description: >- + Payment method-specific configuration for this + PaymentIntent. + properties: + card: + description: >- + Configuration for any card payments attempted on this + PaymentIntent. + properties: + request_partial_authorization: + description: Request partial authorization on this PaymentIntent. + enum: + - if_available + - never + type: string + title: payment_intent_increment_authorization_param + type: object + x-stripeMostCommon: + - request_partial_authorization + title: payment_method_options_increment_authorization_param + type: object + x-stripeMostCommon: + - card statement_descriptor: description: >- Text that appears on the customer's statement as the