Payment Order

This page discuss the extended information for payment order scenarios, please also check the base API.


Order Status

Flow Chart

Notification can start from any status below and status can be skipped if necessary.

Order Status

Description

Display Sample (Index Page)

WAIT_PAY

When the user has to pay.

image

PAY_FAILED

When the autodebit process failed.

image.png

OVERDUED

When the bill has overdued.

image.png

CLOSED

When the order completes.

Notification will disappear.




Below shows the languageBusinessInfo of this scenario.

All fields are REQUIRED, except when status is CLOSED.

Request parameters

action_url string  

An URL for the action button to redirect when being clicked.

bill_amount string  

Amount of this bill in cents. (1 = $0.01, 100 = $1)

bill_amount_currency string  

Currency of bill_amount.

  • HKD
  • CNY

bill_desc string  

Description of the bill.

bill_due_time string  

Due date of this bill in yyyy-MM-dd.

bill_icon_url string  

An URL of the notification's icon (recommend 72 x 72 px).

More information:

  • Value range: < 100KB

bill_name string  

Name of the bill.

order_url string  

An URL to redirect when user clicks the notification but not the button.

Response parameters

No request parameters.
API Explorer

Request

Request Body

Response

Response Body