API Doc
Languages
Languages
  • English
  • 简体中文
Languages
Languages
  • English
  • 简体中文
    • Merchant Unified API Param
    • API Code Collection
    • Unified API Param
    • 1. Account
      • 1.1 Balance Inquiry
        POST
    • 2. Disburse
      • Payout Channel List
      • 2.1 Create Payout
        POST
      • 2.2 Check Payout Status
        POST
    • 3. QR Code
      • QR Code Channel Code List
      • 3.1 QR Code Create
        POST
      • 3.2 QR Code Detail
        POST
      • 3.3 QR Code Payment List
        POST
      • 3.4 QR Code Payment Notification
        POST
      • 3.5 QR Code Cancel
        POST
    • 4. WebPay
      • WebPay Channel Code List
      • Wechat Webpage Authorization Reference
      • Wechat Calls Payment Reference
      • 4.1 WebPay Create
        POST
      • 4.2 Retrieve WebPay Status
        POST
      • 4.3 WebPay Payment Notification
        POST
    • 5. Refund
      • Refund Support Channel List
      • Refund Status Enum
      • 5.1 Refund
        POST
      • 5.2 Get Refund Payments
        POST
      • 5.3 Refund Notification
        POST
    • 6. Void
      • Payment Void Channel List
      • 6.1 Payment Void
    • 7. Direct Debit
      • Direct Debit Channel List
      • 6.4 Authorization Notification
      • 6.3 Cancel Authorization
      • 6.1 Create Authorization Url
      • 6.2 Check Authorization Status
      • 6.5 Direct Debit Pay
      • 6.6 Direct Debit Pay Detail
      • 6.7 Direct Debit Notification

    API Code Collection

    API Code Collection#

    Descrption#

    A collection of response codes returned by the BluePay Open API interface.

    Example#

    {
    "code": 21000,
    "message": "Server error, Please try again later."
}

    Collection#

    Error CodeInner Error CodeMessage
    10000SUCCESSSuccess
    21000OPI_GENERAL_ERRORServer error, Please try again later.
    21001OPI_SIGN_ERRORRequest sign error
    21002OPI_PARAM_ERRORRequest param error
    21003OPI_APPID_ERRORRequest appId error
    21004OPI_MCH_ERRORMerchant is unavailable
    21005OPI_MCH_CHANNEL_UNAVAILABLE_ERRORMerchant channel is unavailable
    21006OPI_MCH_TX_NOT_FOUNDMerchant transaction not found
    21007OPI_DUPLICATE_MCH_ORDER_IDDuplicate merchant order id
    21008OPI_TIMESTAMP_ERRORRequest timestamp error
    21009OPI_TIMESTAMP_EXPIRED_ERRORRequest timestamp expired error
    21010OPI_AMOUNT_EXCEED_ERRORThe amount exceeds the limit
    21011OPI_NETWORK_ERRORNetwork error
    21012OPI_BANK_CODE_ERRORRequest bank code error
    21013OPI_EWALLET_CODE_ERRORRequest wallet code error
    21014OPI_BALANCE_ERRORMerchant balance insufficient
    21015OPI_DUPLICATE_IDEMPOTENCY_IDDuplicate idempotencyId
    21016OPI_MCH_IP_ERRORMerchant ip forbidden

    Refund Response Failed Code#

    responseCoderesponseMessage
    21401Refund is processing
    21402Not allowed to refund
    21403Transactions 60 days ago cannot initiate refunds
    21404The original transaction channel not support full refund
    21405The original transaction channel not support partial refund
    21406Refund amount invalid
    21407MchRefundOrderId is repeat
    21408The original transaction is not completed
    21409The original transaction already exist pending refund

    Void Response Failed Code#

    responseCoderesponseMessage
    21500Original transaction status is not success
    21501Cannot reverse
    21502Original transaction has been settled
    21503Cannot void over the day
    21504Original transaction has been already voided
    21505Duplicate mchVoidOrderID detected. Please provide a unique mchvoidOrderID and retry.

    Open API Transaction Failed Code List#

    Used for transaction queries or callback results
    Response Example
    {
	"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"
}
    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#

    Used for both payment and disbursement
    transactionStatusdescription
    PENDINGpending
    COMPLETEDtransaction completed
    FAILEDtransaction failed

    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

    Open API 交易状态枚举列表#

    同用于代收和代付
    transactionStatus 交易状态说明
    PENDING交易中
    COMPLETED交易完成
    FAILED交易失败
    Previous
    Merchant Unified API Param
    Next
    Unified API Param
    Built with