Skip to content

Introduction

To start using the API, follow these steps:

1. All HTTP requests in this document use Basic Auth authentication

2. Content-Type for POST requests: application/json

3. For GET requests, use spliced parameters, e.g.: https://domain/search/list/order?currPage=2

4. Obtain the merchant number and secret key (The merchant number/secret key can be viewed in System -> Basic Information menu)

Checkout API

Description: This API is used to create checkout orders. In addition to credit cards, it also supports a variety of local payment methods

Note:
Obtain the appId field from System -> Website App -> APP ID

Checkout Subscription API

Description: This API is used to create checkout subscription orders. In addition to credit cards, it also supports a variety of local payment methods

Note:
Obtain the appId field from System -> Website App -> APP ID

Direct Payment API

Description: This API is used for direct credit card payment,

Note:
Obtain the appId field from System -> Website App -> APP ID

Direct Payment Subscription API

Description: This API is used for direct credit card payment subscription,

Note:
Obtain the appId field from System -> Website App -> APP ID

Refund API

Description: This API is used for refunds of successful transactions

Asynchronous Notification API

Description: This API is used to receive asynchronous notifications of transactions and refunds.

Note:
Since the final result of transactions and refunds often cannot be obtained in real time, judge whether the transaction order and refund are successful only according to the value of the notification code
Refer to Appendix for the value of the notification code

Batch Upload Tracking Number API

Description: This API is used to upload tracking numbers for successful transactions

Query API

Description: This API is used to query detailed order and refund information

Note:
For the pagination parameters of order query and refund query, please refer to Query Description