API Doc
Languages
Languages
  • English
  • 简体中文
Languages
Languages
  • English
  • 简体中文
    • API Signature Process
    • API General Code
    • 1. Callback
      • Merchant Subscription Event Notification - Signature Process
    • 2. Account
      • 2.1 Check Account Balance
        GET
      • 2.2 Payment Statement
        POST
      • 2.3 Payout Statement
        POST
    • 3. Payout
      • Payout Product Flow Chart
      • Open API Channel List
      • 3.1 Create Payout
        POST
      • 3.3 Payout Callback Notification
        POST
      • 3.2 Check Payout Status
        GET
    • 4. Bills Payment
      • Bills Payment Product Flow Chart
      • Bills Payment ChannelCode List
      • 4.1 Create Static Virtual Account
        POST
      • 4.2 Batch Create Static Virtual Account
        POST
      • 4.3 Update Static Virtual Account
        POST
      • 4.4 Get Virtual Account Cashier Short Url
        POST
      • 4.5 Get Virtual Account's Payments
        GET
      • 4.6 Repayment verification API
        POST
      • 4.7 Cancel Static Virtual Account
        POST
      • 4.8 Virtual Account Callback Notification
        POST
    • 5. QrCode
      • QrCode Product Flow Chart
      • QrCode ChannelCode List
      • 5.1 Create QR Code
        POST
      • 5.2 Get QR Code Detail
        GET
      • 5.3 Get QR Code Payments
        GET
      • 5.4 Cancel QR Code
        POST
      • 5.6 Update QR Code
        POST
      • 5.5 QR Code Callback Notification
        POST
    • 6. Bank Transfer
      • Bank Transfer Product Flow Chart
      • Bank Transfer ChannelCode List
      • 6.1 Batch Create Bank Transfer Account
      • 6.2 Batch Update Bank Transfer Account
      • 6.3 Bank Transfer Account Payments
      • 6.4 Bank Transfer Callback Notification
    • 7. Web payment
      • Web Payment Product Flow Chart
      • Web Payment ChannelCode List
      • 7.1 Create Web Payment
      • 7.2 Check Web Payment Status
      • 7.3 Web Payment Channels
      • 7.4 Web Payment Callback Notification
    • 8. Refund
      • Refund Support Channel List
      • 8.1 Create Refund
      • 8.2 Get Refund Payments
      • 8.3 Refund Callback Notification
    • 9. Checkout
      • 9.1 Query the channels supported by the cashier counter
      • 9.2 Create the checkout counter
      • 9.3 Check the cashier counter
      • 9.4 Close the cashier counter
      • 9.5 Checkout Payment Notification
    • 10. Direct Debit
      • Direct Debit Channel Code List
      • Authorization
        • 10.1 Create Authorization Link
        • 10.2 Check Authorization Status
        • 10.3 Cancel Authorization
        • 10.4 Authorization Notification
      • Orders
        • 10.5 Create Payment
        • 10.6 Check Payment Status
        • 10.7 Payment Notification
    • 11. Ekyc
      • Ekyc Channel Code List
      • 11.1 Ekyc Init
      • 11.2 Ekyc Check Result
      • 11.3 Ekyc Notification
    • Schemas
      • Response body

    API General Code

    API Common Code List (real time return of error code)
    response example
    {
        "code":1002,
        "message":"merchant white ip forbidden",
    }
    Error CodeError message
    1001merchant appid is invalid
    1002merchant white ip forbidden
    1003request sign is invalid
    1004merchant unavailable
    1005merchant institute unavailable
    1006merchant balance insufficient
    1007transaction exceed limit
    1008transaction not found
    1009request params invalid(pls refer to the specific return message)
    1010request bank name invalid
    1011merchant channel unavailable
    1012merchant order id is repeat
    1013merchant access frequency limit
    1014merchant payout idempoteny repeat
    1015request email invalid
    1016request ewallet name invalid
    1017the static virtual account exist
    1018network failed, please retry
    1019the bank transfer account exist
    1020dynamic qrcode amount is null
    Open API Error Code List#
    Error CodeError message
    1501The original transaction Id not exist
    1502Refund is processing
    1503System error, please contract Paycools
    1504AppId is not match
    1505Refund is not allow
    1506The refund amount is greater than the amount that can be refunded
    1507The original transaction channel does not support refunds
    1508The original transaction channel only allows one refund to be initiated
    1509Transactions 60 days ago cannot initiate refunds
    1510The original transaction channel not support refund
    1511The original transaction channel not support partial refund
    1512The full refund transaction amount must be the same as the original transaction
    1513Refund amount invalid
    1515Merchant refund order id is repeat
    1516The 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"
    }
    failedCodefailedMessage
    -10000Transaction Service Error
    -10001Transaction Exceed Limit
    -10002Transaction Params Error
    -10003Transaction Insufficient Balance
    -10004Transaction Channel Rejected
    -10005Transaction Destination Account Error
    -10006Transaction Network Reject
    -10007Transaction Channel Temporarily Close
    -10008Merchant Unavailable Error
    -10009Recipient Account Blocked
    -10010Channel Refund Failed
    Open API Transaction Status List#
    Both of Collection and Disburse
    transaction statusdescription
    PENDINGtransaction pending
    COMPLETEtransaction successful
    FAILEDtransaction failed
    CLOSEDtransaction closed
    Previous
    API Signature Process
    Next
    Merchant Subscription Event Notification - Signature Process
    Built with