PayproPaypro
  • 🇮🇩 Indonesia
  • 🇵🇰 Pakistan
  • 🇵🇭 Philippines
  • 🇰🇪 Kenya
  • 🇪🇬 Egypt
  • 🇲🇽 Mexico
  • 🇧🇩 Bengal
  • 🇳🇬 Nigeria
  • 🇮🇩 Indonesia
  • 🇵🇰 Pakistan
  • 🇵🇭 Philippines
  • 🇰🇪 Kenya
  • 🇪🇬 Egypt
  • 🇲🇽 Mexico
  • 🇧🇩 Bengal
  • 🇳🇬 Nigeria
  • Bengal

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

Payout API

    Tips

    Payout API is used to initiate transfer requests to e-wallets or bank accounts.

    • All requests are Post requests, and the data format is json
    Brief Description

    (This section is intentionally left blank for brevity.)

    Request URL
    • /v1/paypro/payout
    Request Method
    • POST
    Header
    HeaderRequiredTypeDescription
    merchantNoYesstringN/A
    Request Body Parameters
    ParameterRequiredTypeDescription
    signYesstringCompose the remaining fields (excluding sign) in alphabetical order as key1=value1key2=value2, use the app secret as the salt for MD5 encryption, and the final sign should be in lowercase letters.
    timestampYesintegerTimestamp (e.g., 1715941383720)
    tradeNoYesstringUniqueness (recommended format: YYYYMMDDHHMMSS+random number)
    amountYesstringPayment amount (ecimals are not recommended)
    walletIdYesstringwalletId
    wayCodeYesstringEWALLET_BKASH、EWALLET_ROCKET、EWALLET_NAGAD
    notifyUrlYesstringAsynchronous callback URL
    remarkNostringRemarks, this field will be returned in the callback
    Request Parameter Example
    {
      "sign": "b39f64dc1586867b1966a569ba06e3a2",
      "timestamp": "1728611780130",
      "tradeNo": "test_00000001",
      "amount": "300",
      "notifyUrl": "https://google.com",
      "wayCode": "EWALLET_BKASH",
      "walletId": "01123456789",
       "remark": "test"
      
    }
    
    Response Result
    ParameterRequiredTypeDescription
    msgYesstringRequest result (when "success" is returned, it only indicates the success of this request and cannot be used for merchant-side logical judgment)
    codeYesstringRequest response code (when "0000" is returned, it only indicates the success of this request and cannot be used for merchant-side logical judgment). For specific error codes, please refer to the business error code enumeration.
    timestampYesstringTransaction timestamp
    successYesstringTransaction result
    dataYesObjectReturned object
    data.platFormTradeNoYesstringUnique platform order number
    data.statusYesstringRequest result, which merchants can use for logical processing. When the result is "0000", it indicates a successful transaction; "0015" indicates processing; other codes indicate errors and can be treated as failures.
    data.descYesstringError description
    data.remarkYesstringRemarks
    Success Response Example
    {
        "msg": "success",
        "code": "0000",
        "timestamp": 1729947461317,
        "success": true,
        "data": {
            "platFormTradeNo": "8rlfud1oh1ruceq7",
            "status": "0100119",
            "desc": "fail"
        }
    }
    
    Last Updated:
    Contributors: wsc
    Prev
    Payment API
    Next
    Payment Query API