Overview

This section outlines the common user journeys that can occur while using the payment system.

---

Successful Payment

1. The customer, on the client's website checks out his/her cart
2. A payment session is created by the client, and the hosted checkout process is initiated
3. The browser redirected to the payment page
4. The customer fills in his/her payment information and completes the payment successfully
5. The payment gateway redirects to the return_url on the clients website along with a reference_number
6. The client retrieves the transaction status based on the reference_number
7. The client displays an appropriate message for the customer

Cancelled Payment

1. The customer, on the client's website checks out his/her cart
2. A payment session is created by the client, and the hosted checkout process is initiated
3. The browser redirected to the payment page
4. The customer clicks cancel
5. The payment gateway redirects to the error_url on the clients website along with a reference_number
6. The client retrieves the transaction status based on the reference_number
7. The client displays an appropriate message for the customer

Failed Payment

1. The customer, on the client's website checks out his/her cart
2. A payment session is created by the client, and the hosted checkout process is initiated
3. The browser redirected to the payment page
4. The customer fills in payment infromation, and process, but an error occurs
5. The payment gateway redirects to the error_url on the clients website along with a reference_number
6. The client retrieves the transaction status based on the reference_number
7. The client displays an appropriate message for the customer

---

Development

As outlined by the above user journeys, the integration with our payment system requires code to be written both on the frontend(client-side) as well as on the backend(server-side).

Backend

On the backend, you will need services that perform the following tasks:

1. Acquire a session_id using the /create-session endpoint
2. Query the result of a transaction using the /transaction endpoint

Frontend

On the frontend, you will need pages to handle the below tasks:

1. Checkout page: to initiate the checkout process
2. Response handler: to handle success, failure or cancel events

---

Let us get into the details of this process in the next few sections