API Doc
Version
Version
  • v1
  • v2
Languages
Languages
  • English
  • 简体中文
Version
Version
  • v1
  • v2
Languages
Languages
  • English
  • 简体中文
    • Unified API Request Param
    • Unified Async Notification Param
    • Open API Common Code List
    • 1. Account
      • Country Code
      • 1.1 Balance Inquiry
        POST
      • 1.2 Report Download
        POST
    • 2. Checkout
      • Checkout Payment Channel Code List
      • 2.1 Create Checkout Order
        POST
      • 2.2 Check Checkout Order status
        POST
      • 2.3 Get Checkout Order Available Channels
        POST
      • 2.4 Close Checkout Order
        POST
      • 2.5 Asynchronous Notification Of Checkout Payment Results
        POST
    • 3. Payment
      • Payment Channel List
      • Wechat Webpage Authorization Reference
      • Wechat Calls Payment Reference
      • 3.1 Create Payment
        POST
      • 3.2 Check Payment Status
        POST
      • 3.3 Close Payment
        POST
      • 3.4 Asynchronous Notification Of Payment Results
        POST
      • 3.5 Payment Void
        POST
    • 4. Payout
      • Payout Channel List
      • 4.1 Create Payout
        POST
      • 4.2 Check Payout Status
        POST
      • 4.3 Asynchronous Notification Of Payout Results
        POST
    • 5. Refund
      • Refund Support Channel List
      • Refund Status Enum
      • 5.1 Refund
        POST
      • 5.2 Get Refund Payments
        POST
      • 5.3 Asynchronous Notification Of Refund Results
        POST
    • 6. Direct Debit
      • Direct Debit Channel List
      • 6.3 Cancel Authorization
      • 6.1 Create Authorization Url
      • 6.2 Check Authorization Status
      • 6.4 Asynchronous Notification Of Authorization Results
    • 7. Split Payment
      • Split Payment Enumeration
      • 1. Relationship Proof File Upload
      • 2. Add Split Payment Receiver
      • 3. Query Split Payment Receiver
      • 4. Delete Split Payment Receiver
      • 5. Query Unsplit Amount
      • 6. Split Payment
      • 7. Query Split Payment Result
      • 8. Split Payment Return
      • 9. Query Split Payment Return Result API

    Open API Common Code List

    API Common Code List (real time return of error code)
    response example
    {
    "code":21016,
    "message":"Merchant ip forbidden",
}

    Common Response Code#

    responseCoderesponseMessage
    10000Success
    21000Server error, Please try again later.
    21001Request sign error
    21002Request param error
    21003Request appId error
    21004Merchant is unavailable
    21005Merchant channel is unavailable
    21006Merchant transaction not found
    21007Duplicate merchant order id
    21008Request timestamp error
    21009Request timestamp error
    21010The amount exceeds the limit
    21011Network error
    21012Request bank code error
    21013Request wallet code error
    21014Merchant balance insufficient
    21015Duplicate idempotencyId
    21016Merchant ip forbidden
    21017Merchant has not opened this national service
    21018Request transfer code error
    21019Request pay method code error
    21020Too many requests, please retry later.
    21021Transaction Amount Invalid
    21022Transaction Volume Limit
    21023Transaction create failed
    21024Invalid access token
    21025Not allowed to cancel
    21026Customer Balance not enough
    21027Transaction creation exceeds limit
    21028Transaction already paid or closed

    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 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
    COMPLETEDtransaction successful
    FAILEDtransaction failed
    VOIDEDtransaction voided
    Previous
    Unified Async Notification Param
    Next
    Country Code
    Built with