Skip to main content

Webhook APIs

Register / Update Webhook Configuration​

POST /abc/v1/webhook/register

Register a new Webhook configuration, or update the callback URL when a configuration already exists.

Request Headers

X-API-Key
string
Description
API access key
Example
{apiKey}
X-Timestamp
integer
Description
Request timestamp
Example
{{Timestamp}}
X-Nonce
string
Description
Unique random value for the request
Example
{{Nonce}}
X-Signature
string
Description
Request signature
Example
{{Signature}}
Content-Type
string
Description
Request content type
Example
application/json

Request Body

Data model: OpenWebhookRegisterRequest

callbackUrl
stringRequired
Description
HTTPS callback URL that receives Webhook notifications; maximum length: 512 characters
Example / Default
https://merchant.com/webhook

Successful Response

Data model: CommonResultBoolean

code
integer
Description
Error code
msg
string
Description
Human-readable status message
message
string
Description
Response message
data
boolean
Description
Whether the operation succeeded
Example / Default
true

Query Webhook Configuration​

POST /abc/v1/webhook/query

Retrieve the current merchant's Webhook configuration.

Request Headers

X-API-Key
string
Description
API access key
Example
{apiKey}
X-Timestamp
integer
Description
Request timestamp
Example
{{Timestamp}}
X-Nonce
string
Description
Unique random value for the request
Example
{{Nonce}}
X-Signature
string
Description
Request signature
Example
{{Signature}}

Request Body

This endpoint does not require a request body.

Successful Response

Data model: CommonResultOpenWebhookConfigResponse

code
integer
Description
Error code
msg
string
Description
Human-readable status message
message
string
Description
Response message
data
object
Description
Webhook configuration

data object

id
integer
Description
Configuration ID
Example / Default
1001
merchantId
string
Description
Merchant ID
Example / Default
merchant_001
callbackUrl
string
Description
Callback URL that receives Webhook notifications
Example / Default
https://merchant.com/webhook
eventTypes
string
Description
JSON array string containing subscribed event types
Example / Default
["card.transaction","card.status"]
status
integer
Description
Configuration status: 1 for enabled and 0 for disabled
Example / Default
1
retryCount
integer
Description
Number of retries after a delivery failure
Example / Default
3
createTime
string
Description
Creation time
Example / Default
2026-09-22T10:00:00Z
updateTime
string
Description
Last update time
Example / Default
2026-09-22T10:00:00Z

Disable Webhook Configuration​

POST /abc/v1/webhook/disable

Disable the current merchant's Webhook configuration.

Request Headers

X-API-Key
string
Description
API access key
Example
{apiKey}
X-Timestamp
integer
Description
Request timestamp
Example
{{Timestamp}}
X-Nonce
string
Description
Unique random value for the request
Example
{{Nonce}}
X-Signature
string
Description
Request signature
Example
{{Signature}}

Request Body

This endpoint does not require a request body.

Successful Response

Data model: CommonResultBoolean

code
integer
Description
Error code
msg
string
Description
Human-readable status message
message
string
Description
Response message
data
boolean
Description
Whether the operation succeeded
Example / Default
true