1. Create Payout

Request URL

• /api/v1/payout

Request Method

• POST

Request Header

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

Request Body

parameter name	Is it mandatory	type of data	length	example	description
appId	mandatory	string	-	-	application APPID
mchOrderId	mandatory	string	1-32	CCP20220428011068111	Merchant order id (unique for merchant), 1-32 characters
appName	mandatory	string	1-100	-	Merchant application name, format: letter + space, 1-100 characters
idempotencyId	mandatory	string	10-30	-	idempotency ID KEY, format：letter + numbers，10-30 characters
amount	mandatory	int	100-500000000	50000	payout amount (unit: cents) PHP:500.10, should set 50010 cents
accountNo	mandatory	string	-	-	Beneficiary Account. if payMethodCode is EWALLET, the accountNo format is 09xxxxxxxxx（Moblie）
accountName	mandatory	string	1-30	-	Payee Name format:"firstName middleName lastName" (middleName optional, Special characters are only supported '.-)
payMethodCode	mandatory	string	-	-	PayCools payMethodCode
bankCode	optional - if payMethodCode is BANK, mandatory	string	-	-	-
ewalletCode	optional - if payMethodCode is EWALLET, mandatory	string	-	-	-
remark	optional	string	1-200	-	remark
idCardPicUrl	optional	string	1-200	-	User ID image url
idCardExpiryDate	optional	string	1-20	2022-05-26	User ID Expiration Date format: yyyy-MM-dd
birthPlace	optional	string	1-200	-	User's birthplace
gender	optional	int	2	1	User gender Male: 1; Female: 0; others: 2;
email	optional	string	1-50	-	User eamil
sign	mandatory	string	-	45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892	sign

response params

parameter name	type of data	example	description
code	int	1000	Status code see reference
message	String	success	The message of status code
data	Object	-	Response Data
- transactionId	String	D1036653581161279102	PayCools Unique transaction number
- transactionStatus	String	PENDING	Transaction status
- transactionTime	String	2022-05-24 12:51:07	Transaction create time

payMethodCode, bankCode, ewalletCode Refer to this list

successful response example

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

failed response example. code see reference

{
    "code":1002,
    "message":"merchant white ip forbidden",
}