1. Disbursement Order Interface

Brief Description

• Merchant disbursement - order placement interface

Request URL

• /api/v1/payout

Request Method

• POST

Request Headers

Parameter Name	Required	Type	Description
Content-Type	mandatory	string	application/json

Request Parameters

Parameter Name	Required	Type	Length Limit	Example	Description
appId	Yes	string	-	-	Application APPID
mchOrderId	Yes	string	1-32	CCP20220428011068111	Merchant order ID, format: letters+numbers, 1-32 characters
appName	Yes	string	1-100	-	Merchant integration application name, format: letters+spaces, 1-100 characters
idempotencyId	Yes	string	10-30	-	Idempotency check KEY, format: letters+numbers, 10-30 characters
amount	Yes	int	100-500000000	50000	Disbursement amount, unit: cents. For example PHP:500.10, should be set as 50010 cents
accountNo	Yes	string	-	-	Recipient account number: if it's an e-wallet, accountNo
accountName	Yes	string	1-30	-	Recipient name, format: English uppercase/lowercase with spaces allowed, 1-30 characters, "firstName middleName lastName" (middleName optional, special characters supported: '.-)
payMethodCode	Yes	string	-	-	PayCools disbursement type, fixed EWALLET
bankCode	Yes - required if payMethodCode is BANK	string	-	-	Recipient bank name (abbreviated)
ewalletCode	Yes - required if payMethodCode is EWALLET	string	-	-	Recipient e-wallet name (abbreviated), fixed JT
remark	No	string	1-200	-	Disbursement remark
idCardPicUrl	No	string	1-200	-	User ID card image URL
idCardExpiryDate	No	string	1-20	2022-05-26	User ID card expiration date, format: yyyy-MM-dd
birthPlace	No	string	1-200	-	User birthplace
gender	No	int	2	1	User gender: Male: 1; Female: 0; Other: 2
email	No	string	1-50	-	User email
sign	Yes	string	-	45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892	Signature

Request Example

{
    "appId": "c35353bd69834040af5c3ed45f326d83",
    "mchOrderId": "Payout123456789789",
    "appName": "Test",
    "idempotencyId": "Payout123456789789",
    "amount": 100000,
    "accountNo": "09123456789",
    "accountName": "Test",
    "payMethodCode": "EWALLET",
    "ewalletCode": "JT",
    "remark": "remark",
    "sign": "45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892"
}

Response Parameters

Parameter Name	Type	Description
code	int	Status code
message	string	Status message
data	object	Response data

data Parameters

Parameter Name	Type	Example	Description
transactionId	String	D1036653581161279102	Paycools system order number, unique identifier in Paycools system
transactionStatus	String	PENDING	Order transaction status
transactionTime	String	2022-05-24 12:51:07	Transaction creation time

Response Example

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

Response Failure Example see reference

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