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

2.4 Asynchronous Notification Of Payment Results

POST
/xxx
This interface should be implemented by merchant. The function is that when a payment transaction has been completed, Platform will call this interface to notify the merchant of the payment transaction details.

Request

Body Params application/json

Example
{
    "sign": "V6HQvEZaLF5MSH8TcOVdqPj7fLyvdrAOPm74rW9svpclBIVPlokyiZqPXl09/yAOS8PNnganUtvRvie9MAxJwtYOkDMXxxi4gWjPl3D9L6W4fnVeC28HjhZhWrSgwlecJG6SuHM3odTHAxr5WQUuOxsYFtx+c74Ew+ZzuICCH3dA4+uzNEbDyB8QmBF94nM1LFhDId/VEMxdbj8xKJuOMiSBgwAWaFElm5YCfgmrZpU/qLnuGX2hNxQAMKY2GAw+4VpphYpHG8Xak5+PlqFWKp8mKJ9DgyphVf0ACGpcjOQp0S1V+S1HMMVU0AkW6c8n0weOMu3l6k6cPHsjEe/jSQ==",
    "param": "{\"eventName\":\"order.payment.success\",\"countryCode\":\"PH\",\"currency\":\"PHP\",\"amount\":50000,\"channelCode\":\"PH_GCASH_URL\",\"mchOrderId\":\"Platform653350151938813\",\"createTime\":\"2024-07-09T15:37:52+08:00\",\"remark\":\"test payment\",\"returnTime\":\"2024-07-09T16:20:23+08:00\",\"transactionId\":\"CU4Y9920490660433920\",\"transactionStatus\":\"COMPLETED\",\"cardNo\":\"628268******5161\",\"cardScheme\":\"Visa\",\"cardScheme\":\"visa\"}"
}

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 '/xxx' \
--header 'Content-Type: application/json' \
--data '{
    "sign": "V6HQvEZaLF5MSH8TcOVdqPj7fLyvdrAOPm74rW9svpclBIVPlokyiZqPXl09/yAOS8PNnganUtvRvie9MAxJwtYOkDMXxxi4gWjPl3D9L6W4fnVeC28HjhZhWrSgwlecJG6SuHM3odTHAxr5WQUuOxsYFtx+c74Ew+ZzuICCH3dA4+uzNEbDyB8QmBF94nM1LFhDId/VEMxdbj8xKJuOMiSBgwAWaFElm5YCfgmrZpU/qLnuGX2hNxQAMKY2GAw+4VpphYpHG8Xak5+PlqFWKp8mKJ9DgyphVf0ACGpcjOQp0S1V+S1HMMVU0AkW6c8n0weOMu3l6k6cPHsjEe/jSQ==",
    "param": "{\"eventName\":\"order.payment.success\",\"countryCode\":\"PH\",\"currency\":\"PHP\",\"amount\":50000,\"channelCode\":\"PH_GCASH_URL\",\"mchOrderId\":\"Platform653350151938813\",\"createTime\":\"2024-07-09T15:37:52+08:00\",\"remark\":\"test payment\",\"returnTime\":\"2024-07-09T16:20:23+08:00\",\"transactionId\":\"CU4Y9920490660433920\",\"transactionStatus\":\"COMPLETED\",\"cardNo\":\"628268******5161\",\"cardScheme\":\"Visa\",\"cardScheme\":\"visa\"}"
}'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
    "code": 10000,
    "message": "Success"
}
Previous
2.5 Payment Void
Next
Payout Channel List
Built with