# 1. Create Payout

# 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 Required Type of data Length Example Description
timestamp Y long - 1678356680000 Current timestamp
mchOrderId Y string 10-32 CCP20220428011068111 Merchant order id (unique for merchant), 1-32 characters
idempotencyId Y string 10-32 - Idempotency ID KEY, format:letter + space,10-30 characters
amount Y long - 50000 Payout amount (unit: cents)
accountNo Y string 1-50 - Beneficiary account
accountName Y string 1-128 - Payee Name
payMethodCode Y string - Reference List payMethodCode
transferCode Y string - Reference List Transfer code
accountType Y string - Account type (MOBILE_NUMBER, BANK_ACCOUNT)
remark N string 1-256 - Remark

# Request Body Example

{
  "appId": "123456",
  "sign": "abcdef",
  "param": "{\"mchOrderId\":\"TestMchOrderIdD0001\",\"idempotencyId\":\"TestMchOrderIdD0001\",\"amount\":100,\"payMethodCode\":\"BANK\",\"transferCode\":\"RHBB\",\"accountNo\":\"1234\",\"accountName\":\"account\",\"remark\":\"remark\",\"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": "Server error, Please try again later.",
  "data": null
}