4. Direct Debit
Request URL
{domain}/open-api/jt/direct/debit/pay
Request Method
| 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
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(PENDING , COMPLETED , FAILED) |
| 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 Collection
Failed Response Example