API Doc
Languages
Languages
  • English
  • 简体中文
Languages
Languages
  • English
  • 简体中文
  1. 9. Checkout
  • API Signature Process
  • API General Code
  • 1. Callback
    • Merchant Subscription Event Notification - Signature Process
  • 2. Account
    • 2.1 Check Account Balance
      GET
    • 2.2 Payment Statement
      POST
    • 2.3 Payout Statement
      POST
  • 3. Payout
    • Payout Product Flow Chart
    • Open API Channel List
    • 3.1 Create Payout
      POST
    • 3.3 Payout Callback Notification
      POST
    • 3.2 Check Payout Status
      GET
  • 4. Bills Payment
    • Bills Payment Product Flow Chart
    • Bills Payment ChannelCode List
    • 4.1 Create Static Virtual Account
      POST
    • 4.2 Batch Create Static Virtual Account
      POST
    • 4.3 Update Static Virtual Account
      POST
    • 4.4 Get Virtual Account Cashier Short Url
      POST
    • 4.5 Get Virtual Account's Payments
      GET
    • 4.6 Repayment verification API
      POST
    • 4.7 Cancel Static Virtual Account
      POST
    • 4.8 Virtual Account Callback Notification
      POST
  • 5. QrCode
    • QrCode Product Flow Chart
    • QrCode ChannelCode List
    • 5.1 Create QR Code
    • 5.2 Get QR Code Detail
    • 5.3 Get QR Code Payments
    • 5.4 Cancel QR Code
    • 5.6 Update QR Code
    • 5.5 QR Code Callback Notification
  • 6. Bank Transfer
    • Bank Transfer Product Flow Chart
    • Bank Transfer ChannelCode List
    • 6.1 Batch Create Bank Transfer Account
    • 6.2 Batch Update Bank Transfer Account
    • 6.3 Bank Transfer Account Payments
    • 6.4 Bank Transfer Callback Notification
  • 7. Web payment
    • Web Payment Product Flow Chart
    • Web Payment ChannelCode List
    • 7.1 Create Web Payment
    • 7.2 Check Web Payment Status
    • 7.3 Web Payment Channels
    • 7.4 Web Payment Callback Notification
  • 8. Refund
    • Refund Support Channel List
    • 8.1 Create Refund
    • 8.2 Get Refund Payments
    • 8.3 Refund Callback Notification
  • 9. Checkout
    • 9.1 Query the channels supported by the cashier counter
      POST
    • 9.2 Create the checkout counter
      POST
    • 9.3 Check the cashier counter
      POST
    • 9.4 Close the cashier counter
      POST
    • 9.5 Checkout Payment Notification
      POST
  • 10. Direct Debit
    • Direct Debit Channel Code List
    • Authorization
      • 10.1 Create Authorization Link
      • 10.2 Check Authorization Status
      • 10.3 Cancel Authorization
      • 10.4 Authorization Notification
    • Orders
      • 10.5 Create Payment
      • 10.6 Check Payment Status
      • 10.7 Payment Notification
  • 11. Ekyc
    • Ekyc Channel Code List
    • 11.1 Ekyc Init
    • 11.2 Ekyc Check Result
    • 11.3 Ekyc Notification
  • Schemas
    • Response body
  1. 9. Checkout

9.2 Create the checkout counter

POST
/api/v2/checkout/generate

Request

Body Params application/jsonRequired

Example
{
    "appId": "53cbe10f8e904f74b6eba3f8458749b6",
    "sign": "QHkQ0kd2qoKbtWYIwQfn+fXLN8F9qeRdbtRWnwGdHQryq3ub9CM+JpYp56rl9g3dJ2nGROEstS6NFM59LzdCFO/lFC6f4EddpFJwg/X41A0gFzXWfMgJOKLJ/kuOs+UsQrE5g6b0z/aFz+VeAED86fbjn44deYdCrjOGJakkezb1rNB4qBjuUgWH7Rlfmp2gRnFtXLhh9n1b71eRhIiLLC38jmCnLcciXUJ5ZBS7G04BhqgUQBc7Q4gCmjhKlVxuMvfU+vzBJQDkJLEbkb046o6W/G9rD2zAuDau8V6FZLjHsEijJJ2KJc6Ho36asRqnICUwbBWxAhu/h9Kt8fii2LIRVX+xJ/An0PnSx6tuDxwcVjvgcpboWy8o+ZrOnZi2hJ7/1BVxadt+m/UuJGxkgeDzex4uf7z+aS7e56FK4AiRe8/MD2GBOenvdZnK9q64eV1G/43imzfV6+GENNBfVjiV4i+jWNM6gL+mOxnFoQv5J+N/E6CARQu1Wzt9ia/Mkj75fjZ4qoYuw7G/oGyx2y4UrAoA1S+o8XvxyVfeoI9n58Mc1ue3iajOK74LoWE8W33TC6hN0GFBMqO92xZlOtyqgccT26Bxxn8ww0/VPGuWwGgwi/sKTCsbrJb587bqbb0T6EmA2MKuEgKUb55XN0lRQfx5d6VBlijVXedGAgU=",
    "param": "{\"mchOrderId\":\"10fa511234543312998\",\"merchantLogo\":\"https://test.img\",\"currency\":\"PHP\",\"settlementCurrency\":\"PHP\",\"countryCode\":\"PH\",\"channelTypeList\":null,\"channelCodeList\":null,\"customerName\":\"name\",\"email\":\"test@email.com\",\"mobile\":\"09123456789\",\"amount\":30000,\"expireSeconds\":86400,\"remark\":\"remark\",\"notifyUrl\":\"https://webhook.site/7ec4ee85-e3a8-404d-9f36-7e7f4afe6275\",\"redirectUrl\":\"https://webhook.site/7ec4ee85-e3a8-404d-9f36-7e7f4afe6275\",\"userId\":\"12345\",\"goodsDetails\":[{\"name\":\"bbb\",\"price\":30000,\"quantity\":1,\"sku\":\"sku1\",\"url\":\"https://www.google.com\",\"category\":\"aaa\"}],\"billingAddress\":{\"customerName\":\"bbb\",\"addressLine1\":\"aaa\",\"addressLine2\":\"aaa\",\"city\":\"aaa\",\"province\":\"zhou\",\"postCode\":\"78654\",\"email\":\"test2@email.com\",\"mobile\":\"09123456229\",\"countryCode\":\"PH\",\"redirectUrl\":\"https://webhook.site/7ec4ee85-e3a8-404d-9f36-7e7f4afe6275\"},\"shippingAddress\":{\"customerName\":\"bbb\",\"addressLine1\":\"aaa\",\"addressLine2\":\"aaa\",\"city\":\"aaa\",\"province\":\"sheng\",\"postCode\":\"78654\",\"email\":\"test3@email.com\",\"mobile\":\"09123456229\",\"countryCode\":\"PH\"}}"
}

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 '/api/v2/checkout/generate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "53cbe10f8e904f74b6eba3f8458749b6",
    "sign": "QHkQ0kd2qoKbtWYIwQfn+fXLN8F9qeRdbtRWnwGdHQryq3ub9CM+JpYp56rl9g3dJ2nGROEstS6NFM59LzdCFO/lFC6f4EddpFJwg/X41A0gFzXWfMgJOKLJ/kuOs+UsQrE5g6b0z/aFz+VeAED86fbjn44deYdCrjOGJakkezb1rNB4qBjuUgWH7Rlfmp2gRnFtXLhh9n1b71eRhIiLLC38jmCnLcciXUJ5ZBS7G04BhqgUQBc7Q4gCmjhKlVxuMvfU+vzBJQDkJLEbkb046o6W/G9rD2zAuDau8V6FZLjHsEijJJ2KJc6Ho36asRqnICUwbBWxAhu/h9Kt8fii2LIRVX+xJ/An0PnSx6tuDxwcVjvgcpboWy8o+ZrOnZi2hJ7/1BVxadt+m/UuJGxkgeDzex4uf7z+aS7e56FK4AiRe8/MD2GBOenvdZnK9q64eV1G/43imzfV6+GENNBfVjiV4i+jWNM6gL+mOxnFoQv5J+N/E6CARQu1Wzt9ia/Mkj75fjZ4qoYuw7G/oGyx2y4UrAoA1S+o8XvxyVfeoI9n58Mc1ue3iajOK74LoWE8W33TC6hN0GFBMqO92xZlOtyqgccT26Bxxn8ww0/VPGuWwGgwi/sKTCsbrJb587bqbb0T6EmA2MKuEgKUb55XN0lRQfx5d6VBlijVXedGAgU=",
    "param": "{\"mchOrderId\":\"10fa511234543312998\",\"merchantLogo\":\"https://test.img\",\"currency\":\"PHP\",\"settlementCurrency\":\"PHP\",\"countryCode\":\"PH\",\"channelTypeList\":null,\"channelCodeList\":null,\"customerName\":\"name\",\"email\":\"test@email.com\",\"mobile\":\"09123456789\",\"amount\":30000,\"expireSeconds\":86400,\"remark\":\"remark\",\"notifyUrl\":\"https://webhook.site/7ec4ee85-e3a8-404d-9f36-7e7f4afe6275\",\"redirectUrl\":\"https://webhook.site/7ec4ee85-e3a8-404d-9f36-7e7f4afe6275\",\"userId\":\"12345\",\"goodsDetails\":[{\"name\":\"bbb\",\"price\":30000,\"quantity\":1,\"sku\":\"sku1\",\"url\":\"https://www.google.com\",\"category\":\"aaa\"}],\"billingAddress\":{\"customerName\":\"bbb\",\"addressLine1\":\"aaa\",\"addressLine2\":\"aaa\",\"city\":\"aaa\",\"province\":\"zhou\",\"postCode\":\"78654\",\"email\":\"test2@email.com\",\"mobile\":\"09123456229\",\"countryCode\":\"PH\",\"redirectUrl\":\"https://webhook.site/7ec4ee85-e3a8-404d-9f36-7e7f4afe6275\"},\"shippingAddress\":{\"customerName\":\"bbb\",\"addressLine1\":\"aaa\",\"addressLine2\":\"aaa\",\"city\":\"aaa\",\"province\":\"sheng\",\"postCode\":\"78654\",\"email\":\"test3@email.com\",\"mobile\":\"09123456229\",\"countryCode\":\"PH\"}}"
}'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
    "code": 1000,
    "message": "success",
    "data": {
        "checkoutId": "CH1991766800689266688",
        "checkoutUrl": "https://api-dev.paycools.com/cashier/payment/checkout/i5a9YRYvm4O-qH0GXWA69iqoK9fxdjdTH_krXbCS8AY=",
        "status": "PENDING",
        "expiresTime": "2025-11-21T08:13:05.198+00:00"
    }
}
Previous
9.1 Query the channels supported by the cashier counter
Next
9.3 Check the cashier counter
Built with