Wallet API
Check subscription status

Check subscription status#

Support to check whether the subscription is successful.

Request URL#

POST https://www.okx.com/api/v5/waas/check-subscribe

Request parameters#

ParameterTypeRequiredDescription
urlStringYesURL for webhook callback
typeStringYesCurrently supports TRANSACTION-Any transaction related to any address will trigger BLOCK_HEIGHT-Any block generated will trigger
chainIdStringNoUnique identifier of the chain

Response parameters#

ParameterTypeDescription
databooleanWhether the subscription was successful

Request example#

shell
curl --location --request POST 'https://www.okx.com/api/v5/waas/check-subscribe' \
--header 'OK-ACCESS-PROJECT: 86af********d1bc' \
--header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \
--header 'OK-ACCESS-SIGN: leaV********3uw=' \
--header 'OK-ACCESS-PASSPHRASE: 1****6' \
--header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \
--data '{
  "callbackUrl":"http://your.server.com/webhook",
  "type":"TRANSACTION"
}'

Response example#

200
{
  "code": 0,
  "msg": "success",
  "data": [
    true
  ]
}