Skip to content

Commit

Permalink
OpenAPI Update (#670)
Browse files Browse the repository at this point in the history 
Update OpenAPI for f528344f18443bc2da456e47695b92015d317397

Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] authored Feb 16, 2024
1 parent 384e2e5 commit 8b573bf
Showing 1 changed file with 140 additions and 0 deletions.
140 changes: 140 additions & 0 deletions embedded/openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -39213,6 +39254,7 @@
"type": "object",
"x-expandableFields": [
"checks",
"decremental_authorization",
"extended_authorization",
"incremental_authorization",
"installments",
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -142146,6 +142212,80 @@
}
}
},
"/v1/payment_intents/{intent}/decrement_authorization": {
"post": {
"description": "<p>Perform an decremental authorization on an eligible\n<a href=\"/docs/api/payment_intents/object\">PaymentIntent</a>. To be eligible, the\nPaymentIntent’s status must be <code>requires_capture</code> and\n<a href=\"/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization\">decremental_authorization.status</a>\nmust be <code>available</code>.</p>\n\n<p>Decremental authorizations decrease the authorized amount on your customer’s card\nto the new, lower <code>amount</code> provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.</p>\n\n<p>After decrement, the PaymentIntent object\nreturns with the updated\n<a href=\"/docs/api/payment_intents/object#payment_intent_object-amount\">amount</a>.\nThe PaymentIntent will now be capturable up to the new authorized amount.</p>\n\n<p>Each 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.</p>",
"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": "<p>Perform an incremental authorization on an eligible\n<a href=\"/docs/api/payment_intents/object\">PaymentIntent</a>. To be eligible, the\nPaymentIntent’s status must be <code>requires_capture</code> and\n<a href=\"/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported\">incremental_authorization_supported</a>\nmust be <code>true</code>.</p>\n\n<p>Incremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher <code>amount</code> 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.</p>\n\n<p>If the incremental authorization succeeds, the PaymentIntent object\nreturns with the updated\n<a href=\"/docs/api/payment_intents/object#payment_intent_object-amount\">amount</a>.\nIf the incremental authorization fails, a\n<a href=\"/docs/error-codes#card-declined\">card_declined</a> error returns, and no other\nfields on the PaymentIntent or Charge update. The PaymentIntent\nobject remains capturable for the previously authorized amount.</p>\n\n<p>Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be incremented.</p>\n\n<p>Learn more about <a href=\"/docs/terminal/features/incremental-authorizations\">incremental authorizations</a>.</p>",
Expand Down

0 comments on commit 8b573bf

Please sign in to comment.