Open API Reference for Bluepay

# 2. Check Authorization Status

# Request URL

  • {domain}/open-api/direct/debit/token/query

# Request Method

  • POST

# Request Headers

Parameter Name Required Type Description
Content-Type Yes string application/json

# Request Body Parameters

Parameter Name Required Type Description
appId Yes string Application APPID
param Yes string Parameter body
sign Yes string Signature

# param

Parameter Name Required Type Length Example Description
userID Yes string 1-32 - Merchant internal user id
payToken No string - - token
timestamp Yes long Current timestamp

# Request Example

# Request Body

{
  "appId":"b96f05030ffc411185c06f959e1c9210",
  "sign":"hu79rII/VwshksImrt5KHAHt8u+3qY4y+E/iAlYSYTRm3WYih+aLVV1Rmdm99b+MfYnkvSDgHjTDpUTSy2o4Q5QWyOJBC2BLoJv+ndjdysiGgHditCYgohY08FBEhgWtAX5GJG+rut9UxXnGeIob0tdemc2vJODaVJ4BZ0+iq7xQEl2MltiLpYBZnjvIsJoTYmyFwXeZ8zx+8iJ3nXHXwzspugXIlT0MiEouH0y+02RYOOmCZRmc1CgCywliS+3R+g/xLOK0m9tDGlXXg29NH4amJGqxQTFGzbDPLgrhrWbHsIBqfDDjRRGQrCufS3ZX3TuOGhOTPNKvBY8DTD/54A==",
  "param":"{\"userId\":\"u0009\",\"timestamp\":1726137892}"
}

How to construct request body

# Response Param

Parameter Name Type Description
code integer response code
message string response message
data Object data

# data

Parameter Name Type Description
userId String Merchant internal user id
tokenList List<TokenInfo> Token info list

# TokenInfo

Parameter Name Type Description
channelcode string Channel Code
paytoken string token
tokenStatus string token status (ACTIVED, INACTIVED)
expiresTime string token expiration time
inactiveTime string token inactive time
inactiveType string token inactive type (MCH_CANCEL, PLATFORM_CANCEL, USER_CANCEL, EXPIRED)

# Response Example

# Response Body

{
  "code": 10000,
  "message": "Success",
  "data": {
    "userId": "u00012",
    "tokenList": [
      {
        "channelCode": "BLUEPAY_DIRECT_DEBIT",
        "payToken": "TK1U2ODY9EPKRSOSU9",
        "tokenStatus": "INACTIVED",
        "expiresTime": "2034-09-18 18:10:35",
        "inactiveTime": "2024-09-18 18:14:15",
        "inactiveType": "MCH_CANCEL"
      },
      {
        "channelCode": "BLUEPAY_DIRECT_DEBIT",
        "payToken": "TKJ7F0DY9GD4JN1ATD",
        "tokenStatus": "INACTIVED",
        "expiresTime": "2034-09-18 18:29:08",
        "inactiveTime": "2024-09-18 18:30:28",
        "inactiveType": "MCH_CANCEL"
      },
      {
        "channelCode": "BLUEPAY_DIRECT_DEBIT",
        "payToken": "TKJ2F4DY9HWLMPJKLD",
        "tokenStatus": "ACTIVED",
        "expiresTime": "2034-09-18 18:46:24"
      }
    ]
  }
}

Code Collection

# Failed Response Example

{
    "code": 21010,
    "message": "transaction not found",
    "data": null
}

← 3. Cancel Authorization →