Getting Started

Environment Setup

Before you begin, make sure you have completed the Set Up Test Environment step.

Test	https://p-gate-uat.checus.com/aggregate-pay/api/gateway/<PATH>
Production	https://pay-gate-hk-prod.checus.com/aggregate-pay/api/gateway/<PATH>

Interaction Flow

Key APIs

Interaction	Direction	API / Method
Create Payment (API Order)	Merchant -> Checus	/orderAndPay
Payment Result Notification	Checus -> Merchant	/collectResultNotifyUrl
Query Payment Result	Merchant -> Checus	/orderQuery

Integration Steps

1. Create a payment session

Call orderAndPay API to create a payment (POST).

2. Redirect User for Authentication

If the payment requires additional authentication (e.g., card 3DS or wallet login), the orderAndPay API response will include a redirectUrl, and data.status = PENDING.

You should redirect the user to this URL to complete the authentication process. After the authentication is finished, the user will be returned to your page or the payment completion page.

3. Retrieve Payment Result

Method 1. Payment Result Notification

After the payment is completed, Checus will send a Payment Result Notification to collectResultNotifyUrl API endpoint.

Callback URL configuration options:

• Via API request: Provide the notifyUrl parameter in the /orderAndPay request. Applies to this order only.
• Via Merchant Platform: Configure a global callback URL in the Platform. Applies to all orders.

You must return a success response once the notification is processed.

If no response or a failure is returned, Checus will retry according to the following schedule: 0s / 30s / 300s / 600s / 3600s / 43200s (up to 6 attempts).

Method 2. Active Query

If no notification is received, or the order status remains unclear, you may actively call the Order Query orderQuery API to retrieve the payment result.

Do not rely on code, msg, or data.resultMsg to determine payment status.

Refer to the Error Codes List for troubleshooting in case of errors.

Payment Status Codes List

Status	Description
SUCCESS	Payment succeeded
PENDING	Waiting for payment
FAILED	Payment failed
CLOSED	Timed out, order closed