Paycools Partner API Docs
Languages
Languages
  • 中文
  • English
Languages
Languages
  • 中文
  • English
    • Unified API Request Param
    • Unified Async Notification Param
    • Open API Common Code List
    • 1. Merchant Onboarding
      • KYC Info Enum
      • Kyc bank List
      • 1.1 Merchant Register
        POST
      • 1.2 Commit KYC
        POST
      • 1.3 Get Merchant KYC Information
        POST
      • 1.4 Upload File - File
        POST
      • 1.5 Merchant Auth Status Search
        POST
      • 1.6 Merchant KYC Status Change Notice
        POST
      • 1.7 Resubmit KYC information
        POST
    • 2. Account
      • Country Code
      • 2.1 Balance Inquiry
        POST
      • 2.2 Report Download
        POST
    • 3. Payment
      • Payment Channel List
      • 3.1 Create Payment
        POST
      • 3.2 Check Payment Status
        POST
      • 3.3 Payment Notification
        POST
    • 4. Checkout
      • Checkout Payment Channel Code List
      • 4.1 Create Checkout Order
        POST
      • 4.2 Check Checkout Order status
        POST
      • 4..5 Payment Notification
        POST
      • 4.3 Get Checkout Order Available Channels
        POST
      • 4.4 Close Checkout Order
        POST
    • 5. Refund
      • Refund Support Channel List
      • Refund Status Enum
      • 5.1 Refund
      • 5.2 Get Refund Payments
      • 5.3 Refund Notification
    • 6. Split Payment
      • Split Payment Enumeration
      • 6.1 Relationship Proof File Upload
      • 6.2 Add Split Payment Receiver
      • 6.3 Query Split Payment Receiver
      • 6.4 Delete Split Payment Receiver
      • 6.5 Query Unsplit Amount
      • 6.6 Split Payment
      • 6.7 Query Split Payment Result
      • 6.8 Split Payment Return
      • 6.9 Query Split Payment Return Result API
    • 7. Direct Debit
      • Direct Debit Channel List
      • 7.1 Create Authorization Url
      • 7.2 Check Authorization Status
      • 7.3 Cancel Authorization
      • 7.4 Asynchronous Notification Of Authorization Results

    Unified API Request Param

    Content#

    paramter namerequiredtypedescription
    appIdYesstringmerchant APP ID, provided by Platform
    signYesstringRSA sign of param
    paramYesstringrequest param content string

    Example#

    {
    "appId": "123456",
    "sign": "abcdef",
    "param": "{}"
}

    Descrption#

    1.
    appId is a fixed string, provided by Platform;
    2.
    According to the specific API document, construct the request param, format the request param into JSON, used as the value of param;
    3.
    Use merchant RSA private key to sign param , the sign result used as the value of sign .

    Appendix RSA using case(in Java)#

    Generate RSA key pair:
    RSA public key should be provided to Platform, and do not disclose to any other.
    RSA private key is kept by merchant, and do not disclose to any other.
    When the merchant calls the Platform Open API, it uses the RSA private key to sign the request param, and the Platform server uses the RSA public key provided by the merchant to verify the signature. If the verification fails, it will refuse to process the request.

    key pair example#

    RSA public key:
    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAna4Dyz8nGJiAlc9jTGyRa+TtlZXYABTc+Xfb3T4NdDbnUO8vtNLHugwmqARp8kzEzsMRbmvKro4EpaXqANn7SAGo+YI6sVUDmX7ESk3P6j51PtTvWR6dikJN6qwtmV64ojEbxDnIBL3VKuctefL8uPcI7MZBUPBXg9l8CZmnn2cKqWjZ8MuEQr4G45IqmJ0tRsRmW9ofNnvI1MLPt7c/Z/D1E6HKVwjPcMZKMuF0HpIDqdQaPX83dlSzv9FF9jFR8HWfWW8Oz3jz+GtSLSdh2ERcyO56WHpWl1POV4o9jF+4R/oBgcH+0zA1Z2aFfQf/n9miMhacrioStBaHkh1f/QIDAQAB
    RSA private key:
    MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCdrgPLPycYmICVz2NMbJFr5O2VldgAFNz5d9vdPg10NudQ7y+00se6DCaoBGnyTMTOwxFua8qujgSlpeoA2ftIAaj5gjqxVQOZfsRKTc/qPnU+1O9ZHp2KQk3qrC2ZXriiMRvEOcgEvdUq5y158vy49wjsxkFQ8FeD2XwJmaefZwqpaNnwy4RCvgbjkiqYnS1GxGZb2h82e8jUws+3tz9n8PUTocpXCM9wxkoy4XQekgOp1Bo9fzd2VLO/0UX2MVHwdZ9Zbw7PePP4a1ItJ2HYRFzI7npYelaXU85Xij2MX7hH+gGBwf7TMDVnZoV9B/+f2aIyFpyuKhK0FoeSHV/9AgMBAAECggEAYyqq5iucqgJXdGCO4eSx/LpolZg81ahJZXf1RgqdqYZSKnuTdFTQGflEYo0MGMAhUqwqDVkrimZ1E7zqE4kEWT/6BpnZ0edWsTWhu91+MqL/V/nRYio4CFk06a9JqliBJDhgbyOr4ReGtknYNwcT3Dw5V7hEIeRWFe007lC9tCi7mlpzBNwEIf4itmnncuA70GlxcoMkoGzfYg79eUCfXorbfJcaamR2wXLSU6KoJ422UR3L0rgzmgXzVQw9rrlQ3h6viDykKfaPi/43MN2qb6Zu5isbJIzyz0kHrcE6KJMgJhBDkLIo0f0qE/rEl1Xp/qDwr4+3WBfCHeuTFsud/QKBgQDXmA3f0/ONPMgEGdJlwG20W+7jXHabnRPuUJyDQKbtP+vuaKrpzN+jC1rlxBfAJj2iAVXXXM/RFWWapBd16TqGI4P3RW8eocaxhyl8rWSvCOy/OueNI+fM8gX/IjsJc7VMmCEWHuLvXoM2ixXPWP3v0DEPPPDrCd5dnjR6+5oGgwKBgQC7O03ps4KzMUzEtJcrFFKV0C/m1X905OqQ3cKQnGqRzLp/7d9DQsv+oKzjlpz1xktdJmig7ABiL0+FqJHdcrNiVabI5c6oS2SZkToQFlKv2GYT2KikJ0L43xLfiDvB3tues//9OXuU0WzXZqq7CNAvcmAdPjlFi9RxHsRGABo3fwKBgEi2EJ/XpQGSaUbwyoPktVsp0lS9/4aWIH20lES0DlhfwZuDk3kMzrP3hW2OiBAXFZxI5QGgXLqAg+b2xq7OvR02ZzCDK2niV9fR5Q0Wkaly0h3gqO1yGaCGU71rdwvGCXROroH+Yr0mXAyONgnbUrGJvrIL9JjgmC1syPhdWOIvAoGBAJHJbbNpWX3aB2KrE4IxwtRwVLwyxZnpnVPLuPINOVXpydZPDCc9XcYYqkZUQkeFba1MeO/Ek8/f8tWqGloKM+9/reyENFQK0Hxa/pEEMMJHh8QwUa/v+k/6sqFnXNBqjSuYEN3F4ppQL6XRhWM5S5GGR5y9lK64YGTshfvTnJZVAoGBAJ3TmJcRJWfi7CA985VAnE+IQoQfKKz9NTT7hGBwWTVd7iUc0QCpgHNIixZnfVcjKxz7Hhq6Vy+cEbDBtwbSuDfuVf1spiiqOuYVIjFqq5AsuvpX1CJmm7V+LRtJO/NXmXQP5YfojzET9NqTZvGEVXuzPA0qp8JC7HKrCYykscqE

    RSA sign#

    the value of sign should be:
    PLw6eHk/7uDxxzhvLIUIunEeUcOTKHXqrLjTZgTUEfNv2br8xV9hGqd8YHcKKkgfoHYkI//VGeKDpQAMNwDAAiDcupJLI45bkB1sGd5evg9A1IguT2effam/wWIz8nPCsMxsoG2N+eVtm+kRJ4anL/A0nj3Z6PzPipUsff9K31KATGmiMvBiRSa977MdLgmyoTXPj0wxbZNDVqsWzSQowYb8h7/7fPQ62rBmsQTsf3TR80FQXTtKx0xhV88I0xGFQlNUcKv+HgqIEAunlQr2PoXjply4wlNwZLEeaAdMC+3gFgItj8yzLwJ1hlJEB8cCYuFtrH6wo/7C7S+7oxHHsQ==

    RSA verification#

    the value of result should be true
    下一页
    Unified Async Notification Param
    Built with