Open API Reference for Bluepay

# 3. Cancel Authorization

# Request URL

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

# 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
payToken Yes string - - token
timestamp Yes long Current timestamp

# Request Example

# Request Body

{
  "appId":"b96f05030ffc411185c06f959e1c9210",
  "sign":"Rh2MijTBum94FrBSMXrFRX1x+2UMJDNg34V7rKAt/M6fM9bSI95z8xh9X1PIWIHOv/anQ/9Hn2q7zePgDzXxTTP1mSBUdTq2ZSHOo6C/iu6i13VsF/rpLseBekwRnbYUYvDUH3vlsDyGveZIvoioAlfdgn2Ts5rIwMdtY+LV06PpVGsY3Qt0GcJqiy53a7sOjqeqvwHTtNs4Ecc2NuS8NRGuO6Aifu5bAVeglkTkGDttAKLNw4GxbW2RiIGOkcOrXE7dbu+JX0S3L5zmzi4MfuX7axAXegSr9tBkz47wH1Nx13Ys0VZqGxnjklbJlwnyj7lnZ4R2uNtdmK22LvgEIQ==",
  "param":"{\"userId\":\"u0009\",\"payToken\":\"TKIBRTDXO1HTXW9GJL\",\"timestamp\":1726138137}"
}

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
requestId string Merchant request id
userId string Merchant internal user id
channelCode string Channel code
tokenStatus string Token status

# Response Example

# Response Body

{
  "code": 10000,
  "message": "Success",
  "data": {
    "requestId": "Joey44kgio64idqz045si100",
    "userId": "u0009",
    "channelCode": "BLUEPAY_DIRECT_DEBIT",
    "tokenStatus": "INACTIVED"
  }
}

Code Collection

# Failed Response Example

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

← 4. Direct Debit →