Paycools API Docs
Version
Version
  • v1
  • v2
Languages
Languages
  • English
  • 简体中文
Version
Version
  • v1
  • v2
Languages
Languages
  • English
  • 简体中文
  1. 3. Payout
  • 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. Payment
    • Payment Channel List
    • Wechat Webpage Authorization Reference
    • Wechat Calls Payment Reference
    • 2.1 Create Payment
      POST
    • 2.2 Check Payment Status
      POST
    • 2.3 Close Payment
      POST
    • 2.5 Payment Void
      POST
    • 2.4 Asynchronous Notification Of Payment Results
      POST
  • 3. Payout
    • Payout Channel List
    • 3.1 Create Payout
      POST
    • 3.2 Check Payout Status
      POST
    • 3.7 payout Batch Call Back
      POST
    • 3.4 Create Payout Batch
      POST
    • 3.5 Payout Batch Query
      POST
    • 3.6 Payout Batch Query Detail
      POST
    • 3.3 Asynchronous Notification Of Payout Results
      POST
  • 4. Checkout
    • Checkout Payment Channel Code List
    • 4.1 Create Checkout Order
      POST
    • 6.4 Asynchronous Notification Of Authorization Results
      POST
    • 4.2 Check Checkout Order status
      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 Asynchronous Notification Of Refund Results
  • 6. Direct Debit
    • Direct Debit Channel List
    • 6.1 Create Authorization Url
    • 6.2 Check Authorization Status
    • 6.3 Cancel Authorization
    • 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. 3. Payout

3.4 Create Payout Batch

POST
/open-api/disbursement/batch

Request

Body Params application/jsonRequired

Example
{
    "appId": "733bxxxxxx6ded",
    "sign": "Platform",
    "param": "{\"merchantBatchNo\":\"B2026060119\",\"notifyUrl\":\"https://merchant.com/callback/disbursement\",\"countryCode\":\"ID\",\"timestamp\": 1717205130000,\"items\":[{\"mchOrderId\":\"OR8999456419\",\"payMethodCode\":\"EWALLET\",\"amount\":10000,\"accountNo\":\"0822111111\",\"accountName\":\"pp\",\"bankCode\":\"SHOPEEPAY\",\"purpose\":\"purp\"}]}"
}

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 '/open-api/disbursement/batch' \
--header 'Content-Type: application/json' \
--data '{
    "appId": "733bxxxxxx6ded",
    "sign": "Platform",
    "param": "{\"merchantBatchNo\":\"B2026060119\",\"notifyUrl\":\"https://merchant.com/callback/disbursement\",\"countryCode\":\"ID\",\"timestamp\": 1717205130000,\"items\":[{\"mchOrderId\":\"OR8999456419\",\"payMethodCode\":\"EWALLET\",\"amount\":10000,\"accountNo\":\"0822111111\",\"accountName\":\"pp\",\"bankCode\":\"SHOPEEPAY\",\"purpose\":\"purp\"}]}"
}'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
    "code": 10000,
    "message": "success",
    "data": {
        "batchNo": "BU5Q2451029676392448",
        "merchantBatchNo": "B20260601019",
        "status": "PENDING",
        "notifyStatus": "SUCCESS",
        "totalCount": 1,
        "totalAmount": 1000000,
        "acceptTime": "2026-06-04 16:26:58"
    }
}
Previous
3.7 payout Batch Call Back
Next
3.5 Payout Batch Query
Built with