π Payment Checkout
π’ Introductionβ
Welcome to the Payment Checkout API documentation! This API is designed to let your client pay for services created in Cortecloud using a checkout provided by your system. Integration streamlines the payment process in Cortecloud.
With this integration, your system is responsible for:
- Generating the checkout URL when the user chooses online payment.
- Sending the generated URL so we can redirect the user to the payment page.
- Notifying payment completion once a payment has been successfully processed.
π Integration Benefitsβ
- Automated payment flow for faster and more efficient processing.
- Enhanced end-user experience by allowing payments at any time.
- Accelerated service delivery ensuring quicker production.
π€ Payment Flow for the Userβ
The online payment process follows the steps below to ensure a simple and efficient experience for the end-user:
-
Quote generation: the user creates the quote in Cortecloud, including materials and services used in the production of the order's pieces.
-
Choosing online payment: after generating the quote, the option to make an online payment is displayed.
-
Redirected to checkout: by clicking the online payment option, the system processes the request and redirects the user to the checkout page.
-
Payment completion: in the checkout environment provided by your system, the user enters the necessary details and completes the payment.
-
Return to the system: after payment, the user can return to Cortecloud, where the service status will already be updated to "Approved".
This flow ensures that all steps are completed in an automated and secure manner, providing a smooth experience for the end-user.
π Payment Flow for Integrationβ
The integration flow follows the steps below:
-
Checkout URL request:
- The end-user opts for online payment in our system's interface.
- Our system calls an endpoint provided by you, sending the Cortecloud service number as payload to inform that the user chose online payment.
-
Checkout URL generation:
- Your system makes a call to an endpoint provided by us to get order details in Cortecloud, including materials and services like cutting, edging, and drilling.
- Your system is responsible for generating the checkout URL.
- Your system makes a call to an endpoint provided by us to inform the checkout URL.
-
Redirecting to payment:
- The end-user is redirected to the checkout URL to complete the payment.
-
Payment confirmation:
- After confirming payment in the checkout, your system must make a call to an endpoint provided by us to notify the successful completion of the order's payment.
- The quote status in Cortecloud is updated to "Approved".
Register or Update a Checkout Integrationβ
Contact Cortecloud support to register or update a checkout integration.
Simply provide the URL used to redirect users to your checkout, and we will configure it on our side.
Next Stepsβ
Check the checkout integration guide to learn how to implement this in practice.