Skip to content

Getting Started

You can obtain the payment result through the following two methods.

Method 1. Payment Result Notification

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

The notification may be retried multiple times until a successful response is returned.

Configure webhook URL via:

  • Via API request: Provide the notifyUrl parameter in the /orderAndPay request. Applies to this order only.
  • Via Merchant Plantform: Configure a global callback URL in the Plateform. 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 to retrieve the payment result.

You should use the code field to determine whether the query request itself was successful, and use data.status to determine the payment status.

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

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

Payment Status Codes List

StatusDescription
SUCCESSPayment succeeded
PENDINGWaiting for payment
FAILEDPayment failed
CLOSEDTimed out, order closed

Released under the MIT License.