JeelPay Items Checkout

Items Checkout

API Checkout

The API checkout is a checkout initiated from the API integration. API checkouts receive webhooks for the whole cycle of the checkout process.

In the webhook body, the checkoutType property will have the value of: ITEMS

Business Flow

This section explains the sequence and business flow between the systems in the API checkout phase:

  1. Merchant website will display the cost breakdown and installment details to the customer if they wish to choose JeelPay as an installment provider.

  2. The customer selects JeelPay then the merchant server create a checkout with Jeel.

  3. The merchant site redirects the customer to JeelPay checkout platform to (login/register) in JeelPay and finish the KYC and completes the downpayment.

  4. JeelPay Site will redirect the customer to the merchant site with the result.

  5. JeelPay Server will also send a webhook to merchant server to confirm the same result.

Below is a sequence diagram that illustrates the above

At any step, you can get the status of the request using the endpoint /v3/checkout/{id} -GET a checkout by IDarrow-up-right

API Documentation

For Items checkout you can use POST /v3/checkout and GET /v3/checkout/{id} which can be found detailed out in the API reference link below

Note: for POST /v3/checkout if your group has more than one entity, entity_id becomes required

Last updated