Instructions for using the Payos-Checkout library for Payos integrated applications

** Warning: ** This library is no longer maintained. Please use the new library @payos/payos-checkout

This library will help you open payment links or payment pop ups on React JS applications

1. Installation

Make sure you have the payos-checkout library installed

1     npm install payos-checkout

2. Initialization

1import { usePayOS, PayOSConfig } from "payos-checkout";
2
3const payOSConfig: PayOSConfig = {
4  RETURN_URL: "YOUR_RETURN_URL",
5  ELEMENT_ID:
6    "YOUR_ELEMENT_ID is the id of the div element will contain the payment interface",
7  CHECKOUT_URL: "YOUR_CHECKOUT_URL is the payment Link id",
8  embedded: true, // if use embedded payment interface
9  onSuccess: (event: any) => {
10    //TODO: Action when the order is successfully paid
11  },
12  onExit: (event: any) => {
13    //TODO: Action when the user clicks to exit the checkout
14  },
15  onCancel: (event: any) => {
16    //TODO: Action when the user clicks to cancel order
17  },
18};
19
20const { exit, open } = usePayOS(payOSConfig);

3. How to use

• Function open(): Will open the payment interface as a pop up or embedded in the page
• Function exit(): Will close the payment interface

Parameters in events:

1{
2  status: string;
3}