API Doc
选择语言
选择语言
  • English
  • 简体中文
选择语言
选择语言
  • English
  • 简体中文
    • 接口签名流程
    • API通用提示码
    • 1. 商户回调接口
      • 商户订阅事件通知 - 签名流程
    • 2. 账号查询
      • 2.1 查询账户余额
        GET
      • 2.2 代收对账单
        POST
      • 2.3 代付对账单
        POST
    • 3. 代付接口
      • 代付产品流程图
      • Open API 代付渠道列表
      • 3.1 代付下单接口
        POST
      • 3.2 查询代付状态接口
        GET
      • 3.3 代付回调通知接口
        POST
    • 4. Bills Payment 接口
      • Bills Payment产品流程图
      • BillsPayment ChannelCode列表
      • 4.1 Virtual Account 创建接口
        POST
      • 4.2 Virtual Account 批量创建接口
        POST
      • 4.3 Virtual Account 批量更新接口
        POST
      • 4.4 Virtual Account 获取短链接口 - 非推荐接口
        POST
      • 4.5 Virtual Account 还款列表
        GET
      • 4.6 收单校验接口
        POST
      • 4.7 取消Virtual Account接口
        POST
      • 4.8 Virtual Account 回调通知接口
        POST
    • 5. QrCode 接口
      • QrCode产品流程图
      • QrCode ChannelCode 列表
      • 5.1 QRCODE创建接口
        POST
      • 5.2 QRCODE详情查询
        GET
      • 5.3 QRCODE还款列表接口
        GET
      • 5.4 QRCODE取消接口
        POST
      • 5.5 QRCODE 还款回调接口
        POST
      • 5.6 QRCODE更新接口
        POST
    • 6. Bank Transfer 接口
      • Bank Transfer产品流程图
      • Bank Transfer ChannelCode 列表
      • 6.1 批量创建Bank Transfer Account
      • 6.2 批量更新Bank Transfer Account
      • 6.3 Bank Transfer Account还款列表
      • 6.4 Bank Transfer 还款回调通知接口
    • 7. Web 网页付款
      • Web Payment 产品流程图
      • Webpay ChannelCode 列表
      • 7.1 收款下单接口
      • 7.2 收款查询状态接口
      • 7.3 收款渠道列表接口
      • 7.4 收款回调接口
    • 8. 退款接口
      • 退款支持渠道列表
      • 退款枚举
      • 8.1 退款接口
      • 8.2 退款查询接口
      • 8.3 退款回调接口
    • 9. Checkout
      • 9.1 查询收银台支持的渠道
      • 9.2 创建收银台
      • 9.3 查询收银台
      • 9.4 关闭收银台
      • 9.5 收银台还款通知
    • 10. 授权代扣
      • 授权代扣渠道列表
      • 授权
        • 10.1 获取授权链接接口
        • 10.2 查询token状态接口
        • 10.3 取消token
        • 10.4 授权回调接口
      • 下单
        • 10.5 代扣下单接口
        • 10.6 代扣订单查询接口
        • 10.7 代扣下单回调接口
    • 11. Ekyc
      • Ekyc Channel Code List
      • 11.1 身份验证初始化
      • 11.2 身份验证查询状态
      • 11.3 身份验证回调

    API通用提示码

    Open API Code 提示码列表#

    通用Open API 通用提示码(当次交易实时返回)
    响应示例
    {
        "code":1002,
        "message":"merchant white ip forbidden",
    }
    错误Code错误提示语
    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(参数不合规,请参考具体返回的错误提示信息)
    1010request bank name invalid
    1011merchant channel is 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 退款通用错误码列表#
    错误Code错误提示语
    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 交易Failed Code 错误码列表#
    用于交易查询或者回调结果
    响应示例
    {
    	"amount":5735,
    	"createTime":"2022-01-10 17:55:45",
    	"eventName":"disbursement.failed",
    	"failedCode":-10001,
    	"failedMessage":"Transaction Exceed Limit",
    	"mchOrderId":"CCP16418085446081",
    	"remark":"cash credit",
    	"returnTime":"2022-01-10 18:33:37",
    	"sign":"5a9dd499ddf1c2a4dcf054aceafe409b45f37ca6",
    	"transactionId":"d149b0a575e5344740b2d9698babcede1f68",
    	"transactionStatus":"FAILED"
    }
    错误failedCode错误提示语
    -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 交易状态枚举列表#
    同用于代收和代付
    transactionStatus 交易状态说明
    PENDING交易中
    COMPLETE交易完成
    FAILED交易失败
    CLOSED交易关闭
    上一页
    接口签名流程
    下一页
    商户订阅事件通知 - 签名流程
    Built with