Overview

This document provides detailed descriptions of the common and business parameters required when calling all Order Management API interfaces. Please read carefully before making a request.

Common Request Headers (Required for all endpoints)

This section defines the access token that must be included in requests for all APIs.

Parameter	Type	Required	Description	Example
Content-Type	string	Yes	Data type	application/json
Authorization	string	Yes	API access token

Webhook List

Request

Parameter	Type	Length	Required	Description	Example
cursor	int	10	No	Cursor for pagination
limit	int	5	No	Number of records to query
webhook_name	string	20	No	Name of the webhook
webhook_url	string	100	No	Notification URL
ascending	boolean		No	Sort order, default is descending (true/false)

Response

Parameter	Type	Description	Example
msg	string	Description
code	int	Http code
trace_id	string	Error Trace ID
data	object	Data info
next_cursor	string	Page cursor
has_more	boolean	Has next page
data	array	Data list
webhook_id	int	Webhook Id
webhook_name	string	Webhook name
webhook_url	string	Webhook URL
sign_secret	string	Signature Key
creator_id	int	Creator ID
creator_name	string	Creator name
create_time	string	Create time
operator_id	int	Operator ID
operator_name	string	Operator name
operate_time	string	Operator time
event_code	string	Event code
event_type	string	Event type
event_description	string	Event description

Create Webhook

Request

Parameter	Type	Length	Required	Description	Example
webhook_name	string	20	Yes	Name of the webhook
webhook_url	string	100	No	Notification URL

Response

Parameter	Type	Description	Example
msg	string	Description
code	int	Http code
trace_id	string	Error Trace ID
data	array	Data info
webhook_id	int	Webhook Id
webhook_name	string	Webhook Name
webhook_url	string	Webhook URL
sign_secret	string	Signature Key
creator_id	int	Creator ID
creator_name	string	Creator name
create_time	string	Create time
operator_id	string	Operator ID
operator_name	string	Operator name
operate_time	string	Operator time

Update Webhook

Request

Parameter	Type	Length	Required	Description	Example
webhook_name	string	20	Yes	Name of the webhook
webhook_url	string	100	No	Notification URL

Response

Parameter	Type	Description	Example
msg	string	Description
code	int	Http code
trace_id	string	Error Trace ID
data	array	Data info
webhook_id	int	Webhook Id
webhook_name	string	Webhook name
webhook_url	string	Webhook URL
sign_secret	string	Signature Key
creator_id	int	Operator ID
creator_name	string	Operator name
create_time	string	Create time
operator_id	string	Operator ID
operator_name	string	Operator name
operate_time	string	Operator time

Event List

Request

Parameter	Type	Length	Required	Description	Example
cursor	int	10	No	Cursor for pagination, returned from previous call; leave empty for first call
limit	int	10	No	Number of records to query
event_type	string	50	No	Event type card.transaction.success: Transaction success card.load: Reload card.transaction.failure: Transaction failure card.authorization.success: Authorization success card.authorization.failure: Authorization failure
event_code	string	20	No	Event code 165801: Transaction success 165802: Reload 165803: Transaction failure 165804: Authorization success 165805: Authorization failure
ascending	boolean		No	Sort order, default is descending (true/false)

Response

Parameter	Type	Description	Example
msg	string	Description
code	int	Http code
trace_id	string	Error Trace ID
data	object	Data info
next_cursor	string	Pagination cursor
has_more	boolean	Has next page
data	array	Data list
event_id	int	Event ID
event_type	string	Event type card.transaction.success: Transaction success card.load: Reload card.transaction.failure: Transaction failure card.authorization.success: Authorization success card.authorization.failure: Authorization failure
event_category	string	Event category
event_code	string	Event code 165801: Transaction success 165802: Reload 165803: Transaction failure 165804: Authorization success 165805: Authorization failure
event_description	string	Event description

Event Subscription

Request

Parameter	Type	Length	Required	Description	Example
event_type	string	50	Yes	Event type card.transaction.success: Transaction success card.load: Reload card.transaction.failure: Transaction failure card.authorization.success: Authorization success card.authorization.failure: Authorization failure

Response

Parameter	Type	Description	Example
msg	string	Description
code	int	Http code
trace_id	string	Error Trace ID
data	array	Data info
webhook_id	int	Webhook Id
webhook_name	string	Webhook name
webhook_url	string	Webhook URL
sign_secret	string	Signature Key
creator_id	int	Creator ID
creator_name	string	Creator name
create_time	string	Creator time
operator_id	string	Operator ID
operator_name	string	Operator name
operate_time	string	Operator time
event_type	string	Event type card.transaction.success: Transaction success card.load: Reload card.transaction.failure: Transaction failure card.authorization.success: Authorization success card.authorization.failure: Authorization failure
event_code	string	Event code 165801: Transaction success 165802: Reload 165803: Transaction failure 165804: Authorization success 165805: Authorization failure
event_description	string	Event description

Event Unsubscription

Request

Parameter	Type	Length	Required	Description	Example
event_type	string	50	Yes	Event type card.transaction.success: Transaction success card.load: Reload card.transaction.failure: Transaction failure card.authorization.success: Authorization success card.authorization.failure: Authorization failure

Response

Parameter	Type	Description	Example
msg	string	Description
code	int	Http code
trace_id	string	Error Trace ID
data	array	Data info
webhook_id	int	Webhook Id
webhook_name	string	Webhook name
webhook_url	string	Webhook URL
sign_secret	string	Signature Key
creator_id	int	Creator ID
creator_name	string	Creator name
create_time	string	Creator time
operator_id	string	Operator ID
operator_name	string	Operator name
operate_time	string	Operator time
event_type	string	Event type card.transaction.success: Transaction success card.load: Reload card.transaction.failure: Transaction failure card.authorization.success: Authorization success card.authorization.failure: Authorization failure
event_code	string	Event code 165801: Transaction success 165802: Reload 165803: Transaction failure 165804: Authorization success 165805: Authorization failure
event_description	string	Event description