# 4. Direct Debit

# Request URL

  • {domain}/open-api/jt/direct/debit/pay

# 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

paramter name required type Length Example description
timestamp Yes long - 1677495496979 current timestamp
mchOrderId Yes string 1-32 CCP20220428011068111 mchOrderId, alphanumeric, max length 32
amount Yes long - - amount (unit: cents)
channelCode Yes string - Reference list channel code
payToken Yes string - - pay token
businessType No integer - - businessType, 1、Direct Sale Store(If not filled,default - 1.Direct Sale Store) 2、Franchisees
projectType No string projectType, 'PPCASH','VIP' (If not filled,default 'PPCASH')
items No List - - items detail
notifyUrl Yes string 1-256 - direct debit notification URL
remark No string 1-256 - remark

# Item parameter description

paramter name required type description
subOrderId Yes string subOrderId, alphanumeric, max length 32
customerName No string customer name
customerMobile No string customer mobile number(Mobile phone format: 06,08,09+8 digits (total 10 digits) Landline phone format: 02,03,04,05,07+7 digits (total 9 digits))
amount Yes long payment amount (unit: cents)
email No string customer email
regionNo Yes string region No(1-50 digits);Support uppercase and lowercase letters and numbers
branchNo Yes string branch No(1-100 digits);Support uppercase and lowercase letters and numbers
courierNo Yes string courier No(1-100 digits);Support uppercase and lowercase letters and numbers
courierName No string courier name(1-100 digits)
courierMobile No string courier mobile number(Mobile phone format: 06,08,09+8 digits (total 10 digits) Landline phone format: 02,03,04,05,07+7 digits (total 9 digits))

# Request Example

# Request Body

{
   "appId": "733b887a4a784708bb369524db5b6ded",
   "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
   "param": "{\"timestamp\":1715595802,\"mchOrderId\":\"10e5595801938341100\",\"channelCode\":\"BLUEPAY_DIRECT_DEBIT\",\"amount\":10000,\"remark\":\"remark\",\"notifyUrl\":\"https://www.test.com\",\"payToken\":\"TK1U2ODY9EPKRSOSU9\"}"
}

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
mchOrderId string Merchant order id
transactionId string Platform transaction id
transactionStatus string Transaction status(PENDINGCOMPLETEDFAILED
channelCode string Channel Code
businessType integer Business type ( 1、Direct Sale Store 2、Franchisees )
projectType string Project type (PPCASH,VIP)

# Response Example

# Response Body

{
  "code": 10000,
  "message": "Success",
  "data": {
    "mchOrderId": "10e051066810618100",
    "transactionId": "CU510579106014826496",
    "transactionStatus": "COMPLETED",
    "channelCode": "BLUEPAY_DIRECT_DEBIT",
    "businessType": 1,
    "projectType": "PPCASH"
  }
}

Code Collection

# Failed Response Example

{
    "code":21016,
    "message":"Merchant ip forbidden"
}