# 1 Disburse

# Describe

  • Merchant Disburse API

# HTTP Request Information

# Request URL

  • {domain}/open-api/disbursement

# Request Method

  • POST

# Request Header

parameter name Is it mandatory type of data description
Content-Type mandatory string application/json

# Request Params

parameter name Is it mandatory type of data length example description
appId mandatory string - - application APPID
param mandatory string - - Parameter Body
sign mandatory string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 sign

# param

parameter name Is it mandatory type of data length example description
mchOrderId mandatory string 10-32 CCP20220428011068111 Merchant order ID, format: letters + numbers, 10-32 characters
idempotencyId mandatory string 10-32 Idempotency key, format: letters + numbers, 10-32 characters
amount mandatory long 10000-100000000 50000 Disburse amount
accountNo mandatory string - - Payee account
accountName mandatory string 1-100 - Payee name
payMethodCode mandatory string - - PayCools payMethodCode
bankCode optional string string - Beneficiary Bank Code, if payMethodCode is BANK, mandatory
ewalletCode optional string string - Beneficiary Ewallet Code, if payMethodCode is EWALLET, mandatory
remark optional string - - Disburse remark
disbursementType optional string - - Disbursement Type,Value is BANK_TRANSFER OR BI_FAST,The default Value is BANK_TRANSFER
timestamp mandatory long - 1678356680000 Millisecond timestamp

# bankCode see reference

# Request Body Example

{
  "appId": "abc6e413c37f14f9fabc36fcee8d97c5e",
  "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "param": "{\"bankCode\":\"1123\",\"mchOrderId\":\"TestMchOrderIdD0001\",\"amount\":10000,\"accountNo\":\"12345678\",\"remark\":\"test disbursement\",\"timestamp\":1678356680000}"
}

# Response Example

# code see reference

# successful response example

{
  "code": 1000,
  "message": "success",
  "data": {
    "transactionId": "D1036653581161279102",
    "transactionStatus": "PENDING",
    "transactionTime": "2022-05-24 12:51:07"
  }
}

# failed response example

{
  "code": 21000,
  "message": "Service error, please contact administrator",
  "data": null
}