From 8b573bfde5bd03a7b9187dd76ea6b08799c89a9b Mon Sep 17 00:00:00 2001
From: "stripe-openapi[bot]"
<105521251+stripe-openapi[bot]@users.noreply.github.com>
Date: Fri, 16 Feb 2024 17:31:37 +0000
Subject: [PATCH] OpenAPI Update (#670)
Update OpenAPI for f528344f18443bc2da456e47695b92015d317397
Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
---
embedded/openapi/spec3.beta.sdk.json | 140 +++++++++++++++++++++++++++
1 file changed, 140 insertions(+)
diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json
index f0a170d0..96d48c3e 100644
--- a/embedded/openapi/spec3.beta.sdk.json
+++ b/embedded/openapi/spec3.beta.sdk.json
@@ -33140,6 +33140,29 @@
"type": "object",
"x-expandableFields": []
},
+ "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_decremental_authorization_decremental_authorization": {
+ "description": "",
+ "properties": {
+ "status": {
+ "description": "Indicates whether or not the decremental authorization feature is supported.",
+ "enum": [
+ "available",
+ "unavailable"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesDecrementalAuthorizationDecrementalAuthorization",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "DecrementalAuthorizationRequest",
+ "in_package": ""
+ }
+ },
"payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization": {
"description": "",
"properties": {
@@ -33868,6 +33891,13 @@
"operation": "post",
"path": "/v1/payment_intents/{intent}/confirm"
},
+ {
+ "method_name": "decrement_authorization",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/payment_intents/{intent}/decrement_authorization"
+ },
{
"method_name": "increment_authorization",
"method_on": "service",
@@ -35195,6 +35225,14 @@
"nullable": true,
"type": "string"
},
+ "request_decremental_authorization": {
+ "description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_extended_authorization": {
"description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
"enum": [
@@ -39084,6 +39122,9 @@
"nullable": true,
"type": "string"
},
+ "decremental_authorization": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_decremental_authorization_decremental_authorization"
+ },
"description": {
"description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)",
"maxLength": 5000,
@@ -39213,6 +39254,7 @@
"type": "object",
"x-expandableFields": [
"checks",
+ "decremental_authorization",
"extended_authorization",
"incremental_authorization",
"installments",
@@ -131678,6 +131720,14 @@
"type": "string",
"x-stripeBypassValidation": true
},
+ "request_decremental_authorization": {
+ "description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_extended_authorization": {
"description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
"enum": [
@@ -135664,6 +135714,14 @@
"type": "string",
"x-stripeBypassValidation": true
},
+ "request_decremental_authorization": {
+ "description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_extended_authorization": {
"description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
"enum": [
@@ -140586,6 +140644,14 @@
"type": "string",
"x-stripeBypassValidation": true
},
+ "request_decremental_authorization": {
+ "description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_extended_authorization": {
"description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
"enum": [
@@ -142146,6 +142212,80 @@
}
}
},
+ "/v1/payment_intents/{intent}/decrement_authorization": {
+ "post": {
+ "description": "Perform an decremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\ndecremental_authorization.status\nmust be available.
\n\nDecremental authorizations decrease the authorized amount on your customer’s card\nto the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
\n\nAfter decrement, the PaymentIntent object\nreturns with the updated\namount.\nThe PaymentIntent will now be capturable up to the new authorized amount.
\n\nEach PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be decremented.
",
+ "operationId": "PostPaymentIntentsIntentDecrementAuthorization",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "intent",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount.",
+ "type": "integer"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "amount"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/payment_intent"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/payment_intents/{intent}/increment_authorization": {
"post": {
"description": "Perform an incremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\nincremental_authorization_supported\nmust be true.
\n\nIncremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher amount provided. Similar to the\ninitial authorization, incremental authorizations can be declined. A\nsingle PaymentIntent can call this endpoint multiple times to further\nincrease the authorized amount.
\n\nIf the incremental authorization succeeds, the PaymentIntent object\nreturns with the updated\namount.\nIf the incremental authorization fails, a\ncard_declined error returns, and no other\nfields on the PaymentIntent or Charge update. The PaymentIntent\nobject remains capturable for the previously authorized amount.
\n\nEach PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be incremented.
\n\nLearn more about incremental authorizations.
",