Home > @vsf-enterprise/stripe-epcc
# stripe-epcc package
Stripe and ElasticPath Commerce Cloud integration for Vue Storefront 2.
# Remarks
The @vsf-enterprise/stripe-epcc library is complete solution to integrate with Stripe Payment Intents (opens new window).
# Functions
| Function | Description |
|---|---|
| isEpccErrors(response) | Checks if the param is the ElasticPath Commerce Cloud error (EpccErrors type). |
| mergeEpccErrors({ errors }) | Transforms EpccErrors object to the string with every error message. |
# Interfaces
| Interface | Description |
|---|---|
| EpccError | Error object in ElasticPath Commerce Cloud format |
| EpccErrors | Error response from the ElasticPath Commerce Cloud |
| EpccMiddlewareSettingsConfig | Settings provided for epcc property in the middleware.config.js file. |
| EpccPaymentTransactionResponse | Succesful response from operation on the Payment transaction object in ElasticPath Commerce Cloud |
| EpccPrice | Price object in ElasticPath Commerce Cloud format |
| EpccTransaction | Payment transaction object in ElasticPath Commerce Cloud format |
| IntegrationApiEndpoints | Endpoints call signatures of methods from the useContext().app.$vsf.$stripe |
| MiddlewareSettingsConfig | Settings provided in the middleware.config.js file. |
| StripeClientConfig | Settings provided in the nuxt.config.js file. |
| StripeIntegrationContext | Context of the integration available inside each endpoint's handler. |
| StripeMiddlewareSettingsConfig | Settings provided for stripe property in the middleware.config.js file. |
| UseStripeApiErrors | Errors storage of useStripeApi |
# Variables
| Variable | Description |
|---|---|
| LOGGER_PREFIX | Unique integration prefix put in Logger messages. |
| useStripeApi | Composable for communication with API endpoints created by the integration. |
| useStripeUi | Composable containing logic related to UI operations and their results - Stripe & VSF API calls. |
# Type Aliases
| Type Alias | Description |
|---|---|
| OptimizedConfirmIntentResponse | Optimized response from the POST /api/stripe/confirmIntent endpoint to provided only what's necessary |
| OptimizedInitResponse | Optimized response from the POST /api/stripe/init endpoint to provided only what's necessary |