PayproPaypro
  • ๐Ÿ‡ฎ๐Ÿ‡ฉ Indonesia
  • ๐Ÿ‡ต๐Ÿ‡ฐ Pakistan
  • ๐Ÿ‡ต๐Ÿ‡ญ Philippines
  • ๐Ÿ‡ฎ๐Ÿ‡ณ India
  • ๐Ÿ‡ฐ๐Ÿ‡ช Kenya
  • ๐Ÿ‡ช๐Ÿ‡ฌ Egypt
  • ๐Ÿ‡ฒ๐Ÿ‡ฝ Mexico
  • ๐Ÿ‡จ๐Ÿ‡ด Colombia
  • ๐Ÿ‡ง๐Ÿ‡ฉ Bangladesh
  • ๐Ÿ‡ง๐Ÿ‡ท Brazil
  • ๐Ÿ‡ฐ๐Ÿ‡ท SouthKorea
  • ๐Ÿ‡ณ๐Ÿ‡ฌ Nigeria
  • ๐Ÿ‡ฎ๐Ÿ‡ฉ Indonesia
  • ๐Ÿ‡ต๐Ÿ‡ฐ Pakistan
  • ๐Ÿ‡ต๐Ÿ‡ญ Philippines
  • ๐Ÿ‡ฎ๐Ÿ‡ณ India
  • ๐Ÿ‡ฐ๐Ÿ‡ช Kenya
  • ๐Ÿ‡ช๐Ÿ‡ฌ Egypt
  • ๐Ÿ‡ฒ๐Ÿ‡ฝ Mexico
  • ๐Ÿ‡จ๐Ÿ‡ด Colombia
  • ๐Ÿ‡ง๐Ÿ‡ฉ Bangladesh
  • ๐Ÿ‡ง๐Ÿ‡ท Brazil
  • ๐Ÿ‡ฐ๐Ÿ‡ท SouthKorea
  • ๐Ÿ‡ณ๐Ÿ‡ฌ Nigeria
  • Nigeria

    • Overview
    • Error Code
    • Payment Cashier
    • Payment API
    • Payout API
    • Payment Query API
    • Payout Query API
    • Balance Inquiry API
    • Payment Notify API
    • Bank List

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. Use the new field name name (not customerName) when generating the signature.
    timestampYesintegerTimestamp (e.g., 1715941383720)
    tradeNoYesstringUniqueness (recommended format: YYYYMMDDHHMMSS+random number)
    amountYesstringPayment amount (ecimals are not recommended)
    bankCodeyesstringBank code (use the latest Vexora Bank List; legacy bank codes are no longer valid)
    bankAccountNoyesstringBank Account Number
    nameyesstringUser Name
    mobileyesstringUserโ€™s mobile phone number
    emailyesstringemail account
    notifyUrlYesstringAsynchronous callback URL
    remarkYesstringRemarks, this field will be returned in the callback
    Request Parameter Example
    {
        "sign": "29604bf1662fd6acddfbd33eaee0179f",
        "timestamp": 1748248240605,
        "tradeNo": "rgB36f2n9AElhTeY",
        "amount": "500",
        "bankCode": "000001",
        "bankAccountNo": "123456789",
        "mobile": "15875595997",
        "email": "kevin@gmail.com",
        "name": "kevin",
        "notifyUrl": "http://www.google.com",
        "remark": "remark"
    }
    
    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.statusYesstringTransaction results. Merchants can process subsequent workflows based on the returned status in the transaction result. For details, please refer to the status code reference table.
    data.messageYesstringError description
    data.remarkYesstringRemarks
    Success Response Example
    {
        "msg": "success",
        "code": "0000",
        "timestamp": 1748248243683,
        "success": true,
        "data": {
            "tradeNo": "rgB36f2n9AElhTeY",
            "platFormTradeNo": "64qpx8yljs8beccd",
            "status": "0015",
            "message": "PAYING",
            "remark": "remark"
        }
    }
    
    Last Updated:
    Contributors: gxwu, wsc
    Prev
    Payment API
    Next
    Payment Query API