Creates a checkout session with a valid basket ID and payment type
Payment types
There are different types of checkouts depending on the payment method used; a combination of the methods below is also possible:
| TYPE | DESCRIPTION | PRE-REQUISITES | ENUM |
|---|---|---|---|
| Deliverect Pay API | For processing payment via our own payment API suite | Dpay integrated in Deliverect | dpay |
| Commerce Channel Managed | If the payment process is fully managed by the commerce platform, e.g. via a direct payment gateway integration. | None | third_party |
Deliverect Pay
The dpay payment type can be used only after the payment has been initiated through the Deliverect Pay API, a paymentId has been issued, and authorisation has been successfully confirmed.
During dpay checkout, use the "paymentId" from the payment request as the externalId as shown in the examples to the right.
For details on requesting payments via Deliverect Pay, see the guide below;
Third party
Use the third_party type for payments handled externally (e.g., via your own payment provider), rather than within Deliverect. Provide the corresponding transaction ID or equivalent as the externalId.
Unpaid orders
In order to send unpaid orders, set the order type to "third_party" and "isPrepaid": false.
Instrument Type
Payment type to be associated with the third-party payment in the order.
- CASH =
"cash" - CARD =
"card" - CASH ON DELIVERY =
"cash_on_delivery" - CARD ON DELIVERY =
"card_on_delivery" - ONLINE =
"online" - INVOICE =
"invoice" - OTHER =
"other"
Checkout confirmation
Regardless of the payment type, after sending a basket checkout request, Deliverect returns a 200 OK response if the request is valid.
Order creation is handled asynchronously, and a webhook event confirming successful order creation is sent to the configured checkout update webhook URL. checkout update webhook URL.
Only consider a checkout successful after the basket checkout webhook URL receives
"status": "completed".