Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add documentation about the new spree_stripe api endpoint (#12600)

Damian Kaczmarczyke9e0c4564b80
diff --git a/docs/api-reference/storefront.yaml b/docs/api-reference/storefront.yaml
index 808edc3a06..c736b07ac7 100644
--- a/docs/api-reference/storefront.yaml
+++ b/docs/api-reference/storefront.yaml
@@ -1573,6 +1573,7 @@ paths:
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
+ "/api/v2/storefront/stripe/payment_intents/{id}":
get:
summary: Return a Stripe Payment Intent
description: 'Returns the Payment Intent information'
@@ -1623,6 +1624,24 @@ paths:
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
+ "/api/v2/storefront/stripe/payment_intents/{id}/confirm":
+ patch:
+ summary: Mark the payment intent as confirmed, and move the order to the complete state
+ description: This endpoint is used to complete the order with succeeded payment intent. First it will check if the payment intent has `status` `succeeded`, if yes, then it will move the order to the complete state.
+ tags:
+ - Stripe
+ operationId: confirm-stripe-payment-intent
+ security:
+ - orderToken: []
+ responses:
+ '200':
+ $ref: '#/components/responses/StripePaymentIntent'
+ '403':
+ $ref: '#/components/responses/403Forbidden'
+ '404':
+ $ref: '#/components/responses/404NotFound'
+ '422':
+ $ref: '#/components/responses/422UnprocessableEntity'
/api/v2/storefront/stripe/setup_intents:
post:
summary: Create a Stripe Setup Intent
diff --git a/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent-1.mdx b/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent-1.mdx
index ce4ef32510..964ad50753 100644
--- a/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent-1.mdx
+++ b/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent-1.mdx
@@ -1,4 +1,4 @@
---
-openapi: patch /api/v2/storefront/stripe/payment_intents
+openapi: patch /api/v2/storefront/stripe/payment_intents/{id}
version: v5
---
\ No newline at end of file
diff --git a/docs/api-reference/storefront/stripe/mark-the-payment-intent-as-confirmed-and-move-the-order-to-the-complete-state.mdx b/docs/api-reference/storefront/stripe/mark-the-payment-intent-as-confirmed-and-move-the-order-to-the-complete-state.mdx
new file mode 100644
index 0000000000..96ef278cae
--- /dev/null
+++ b/docs/api-reference/storefront/stripe/mark-the-payment-intent-as-confirmed-and-move-the-order-to-the-complete-state.mdx
@@ -0,0 +1,4 @@
+---
+openapi: patch /api/v2/storefront/stripe/payment_intents/{id}/confirm
+version: v5
+---
\ No newline at end of file
diff --git a/docs/api-reference/storefront/stripe/return-a-stripe-payment-intent.mdx b/docs/api-reference/storefront/stripe/return-a-stripe-payment-intent.mdx
index 20d83bf93f..48b058b38e 100644
--- a/docs/api-reference/storefront/stripe/return-a-stripe-payment-intent.mdx
+++ b/docs/api-reference/storefront/stripe/return-a-stripe-payment-intent.mdx
@@ -1,4 +1,4 @@
---
-openapi: get /api/v2/storefront/stripe/payment_intents
+openapi: get /api/v2/storefront/stripe/payment_intents/{id}
version: v5
---
\ No newline at end of file