API Doc

# Open API Common Code List

  • API Common Code List (real time return of error code)

  • response example

{
    "code":1002,
    "message":"merchant white ip forbidden",
}
Error Code Error message
1001 merchant appid is invalid
1002 merchant white ip forbidden
1003 request sign is invalid
1004 merchant unavailable
1005 merchant institute unavailable
1006 merchant balance insufficient
1007 transaction exceed limit
1008 transaction not found
1009 request params invalid(pls refer to the specific return message)
1010 request bank name invalid
1011 merchant channel unavailable
1012 merchant order id is repeat
1013 merchant access frequency limit
1014 merchant payout idempoteny repeat
1015 request email invalid
1016 request ewallet name invalid
1017 the static virtual account exist
1018 network failed, please retry
1019 the bank transfer account exist
1020 dynamic qrcode amount is null
# Open API Error Code List
Error Code Error message
1501 The original transaction Id not exist
1502 Refund is processing
1503 System error, please contract Paycools
1504 AppId is not match
1505 Refund is not allow
1506 The refund amount is greater than the amount that can be refunded
1507 The original transaction channel does not support refunds
1508 The original transaction channel only allows one refund to be initiated
1509 Transactions 60 days ago cannot initiate refunds
1510 The original transaction channel not support refund
1511 The original transaction channel not support partial refund
1512 The full refund transaction amount must be the same as the original transaction
1513 Refund amount invalid
1515 Merchant refund order id is repeat
1516 The original transaction is not completed
# Open API Transaction Failed Code List

  • Used for transaction query or callback results

  • response data example

{
	"amount":5735,
	"createTime":"2022-01-10 17:55:45",
	"eventName":"disbursement.failed",
	"failedCode":1001,
	"failedMessage":"Transaction Exceed Limit",
	"mchOrderId":"CCP16418085446081",
	"remark":"cash credit",
	"returnTime":"2022-01-10 18:33:37",
	"sign":"5a9dd499ddf1c2a4dcf054aceafe409b45f37ca6",
	"transactionId":"d149b0a575e5344740b2d9698babcede1f68",
	"transactionStatus":"FAILED"
}
failedCode failedMessage
-10000 Transaction Service Error
-10001 Transaction Exceed Limit
-10002 Transaction Params Error
-10003 Transaction Insufficient Balance
-10004 Transaction Channel Rejected
-10005 Transaction Destination Account Error
-10006 Transaction Network Reject
-10007 Transaction Channel Temporarily Close
-10008 Merchant Unavailable Error
-10009 Recipient Account Blocked
-10010 Channel Refund Failed
# Open API Transaction Status List
  • Both of Collection and Disburse
transaction status description
PENDING transaction pending
COMPLETE transaction successful
FAILED transaction failed

← API FAQ →