API Doc
Version
Version
  • v1
  • v2
Languages
Languages
  • English
  • 简体中文
Version
Version
  • v1
  • v2
Languages
Languages
  • English
  • 简体中文
  1. 2. Checkout
  • 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
  1. 2. Checkout

2.1 Create Checkout Order

POST
/open-api/payment/checkout/generate

Request

Body Params application/json

Example
{
    "appId": "733b887a4a784708bb369524db5b6ded",
    "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
    "param": "{\"timestamp\":1715595802,\"mchOrderId\":\"10e5595801938341100\",\"merchantLogo\":\"https://test.img\",\"currency\":\"PH\",\"settlementCurrency\":\"PHP\",\"countryCode\":\"PH\",\"channelTypeList\":null,\"channelCodeList\":null,\"customerName\":\"name\",\"email\":\"test@email.com\",\"mobile\":\"09123456789\",\"amount\":10000,\"expireSeconds\":3600,\"remark\":\"remark\",\"notifyUrl\":\"https://www.test.com\",\"redirectUrl\":\"https://www.test.com\"}"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/open-api/payment/checkout/generate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "733b887a4a784708bb369524db5b6ded",
    "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
    "param": "{\"timestamp\":1715595802,\"mchOrderId\":\"10e5595801938341100\",\"merchantLogo\":\"https://test.img\",\"currency\":\"PH\",\"settlementCurrency\":\"PHP\",\"countryCode\":\"PH\",\"channelTypeList\":null,\"channelCodeList\":null,\"customerName\":\"name\",\"email\":\"test@email.com\",\"mobile\":\"09123456789\",\"amount\":10000,\"expireSeconds\":3600,\"remark\":\"remark\",\"notifyUrl\":\"https://www.test.com\",\"redirectUrl\":\"https://www.test.com\"}"
}'

Responses

🟢200SUCCESS
application/json
Body

Example
{
    "code": 10000,
    "message": "Success",
    "data": {
        "checkoutId": "CH1789964654026559488",
        "checkoutUrl": "https://cashier.paycools.com/checkout/NzQxPl1wE-cdtloi1h0pTgc23ZcdGdXiGGZ2YvywJ-o=",
        "status": "PENDING",
        "expiresTime": "2024-05-14 15:27:00"
    }
}
Previous
Checkout Payment Channel Code List
Next
2.2 Check Checkout Order status
Built with