PayproPaypro
  • 🇮🇩 Indonesia
  • 🇵🇰 Pakistan
  • 🇵🇭 Philippines
  • 🇮🇳 India
  • 🇰🇪 Kenya
  • 🇪🇬 Egypt
  • 🇲🇽 Mexico
  • 🇧🇩 Bangladesh
  • 🇧🇷 brazil
  • 🇳🇬 Nigeria
  • 🇮🇩 Indonesia
  • 🇵🇰 Pakistan
  • 🇵🇭 Philippines
  • 🇮🇳 India
  • 🇰🇪 Kenya
  • 🇪🇬 Egypt
  • 🇲🇽 Mexico
  • 🇧🇩 Bangladesh
  • 🇧🇷 brazil
  • 🇳🇬 Nigeria
  • Brazil

    • Overview
    • Error Code
    • Payment API
    • Payout API
    • Payment Query API
    • Payout Query API
    • Balance Inquiry API
    • Payment Notify API

Payout Query API

    Tips

    • All requests are Post requests, and the data format is json
    • API Documentation for Querying Payment Results

    Brief Description

    • The business party can actively query the payment results.

    Request URL

    • /v1/paypro/queryPayOutResult

    Request Method

    • POST

    Header

    NameRequiredTypeDescription
    merchantNoYesstring-
    signYesstringEncrypted value

    Request Body Parameters

    NameRequiredTypeDescription
    tradeNoYesstringTransaction number passed by the merchant during the payout
    timestampYesstringTimestamp

    Request Example

    {
        "tradeNo": "1000002",
        "timestamp": "1724142308374"
    }
    

    Successful Response Example

    Parameter NameRequiredTypeDescription
    msgYesstringRequest result (Returning "success" only indicates the request was successful; it should not be used for merchant-side logic)
    codeYesstringRequest response code (Returning "0000" only indicates the request was successful; it should not be used for merchant-side logic)
    timestampYesstringTimestamp (e.g., 1715941383720)
    successYesstringTransaction result
    dataYesObjectResponse object
    data.platFormTradeNoYesstringPayPro transaction number
    data.tradeNoYesstringMerchant transaction number returned
    data.amountYesstringTransaction amount
    data.statusYesstringRequest result. The merchant can use this for logical processing. "0000" indicates transaction success, "0015" indicates processing, and other codes are error codes that can be treated as failures.
    data.messageYesstringStatus description
    data.successTimeYesstringTransaction success time (local time)

    Successful Response Example

    {
        "msg": "success",
        "code": "0000",
        "timestamp": 1719830071094,
        "success": true,
        "data": {
            "platFormTradeNo": "5286e98841194687a95d25b5f3be346d",
            "tradeNo": "00000020",
            "amount": "30000",
            "status": "00029",
            "message": "REJECTED_TRANSACTION",
            "successTime": "2024-07-01 18:34:31"
        }
    }
    
    Last Updated:
    Contributors: wsc
    Prev
    Payment Query API
    Next
    Balance Inquiry API