Embedded Checkout
Overview
Embedded Checkout enables you to embed a checkout on your website to accept payments without redirecting to a payment gateway.
Embedded Checkout has the following benefits over Redirect-based Checkout:
- Better user experience and less security concerns: Keeping the customer on your website when checking out makes the experience seamless and allays security concerns.
- Theming: Customise parts of the payment experience to match your branding.
- Custom payment method ordering: Order payment methods according to your preferences.
Example Embedded Checkout with custom colours and payment method order; note that not all payment methods are available in all regions or for all currencies.
API endpoints
The API endpoints for the live and sandbox servers are:
| Service | Live | Sandbox |
|---|---|---|
| Authentication | https://dashboard.peachpayments.com | https://sandbox-dashboard.peachpayments.com |
| Checkout | https://secure.peachpayments.com | https://testsecure.peachpayments.com |
| Embedded Checkout | https://checkout.peachpayments.com/js/checkout.js | https://sandbox-checkout.peachpayments.com/js/checkout.js |
Known limitations
-
Embedded Checkout does not support the following payment methods:
- InstantEFT by Peach
- Payflex
- Apple Pay
- PayPal
- Mobicred
- FinChoicePay
-
Checkout expiry is 30 minutes and is not extended by calls like Hosted Checkout
-
The secondary brand theme colour is not used
Quick links
| 📝 API playground Detailed reference to the Embedded Checkout API endpoint and mock calls. API reference | 📝 SDK reference Detailed reference to all the SDK functionality. SDK reference |
| 🚀 Postman collection Use the sample Embedded Checkout (v2) calls in Postman. See the collection overview for more information.  |  Sample projectExperiment with an Embedded Checkout sample integration project. Sample project |
Updated about 1 month ago