PayproPaypro
  • 🇮🇩 Indonesia
  • 🇵🇰 Pakistan
  • 🇻🇳 Vietnam
  • 🇵🇭 Philippines
  • 🇰🇪 Kenya
  • 🇪🇬 Egypt
  • 🇧🇷 Brazil
  • 🇲🇽 Mexico
  • 🇮🇩 Indonesia
  • 🇵🇰 Pakistan
  • 🇻🇳 Vietnam
  • 🇵🇭 Philippines
  • 🇰🇪 Kenya
  • 🇪🇬 Egypt
  • 🇧🇷 Brazil
  • 🇲🇽 Mexico
  • Mexico

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

Payment API

  • Payment API utilizes JSON data and does not provide a payment page, requiring merchants to create and manage their own payment page.

    Tips

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

    Brief description

    Request URL

    • /v1/paypro/payInApi

    Request method

    • post

    Way Code

    wayCodeDescription
    storeconvenience store
    vaVa repayment

    Header

    headerrequiredtypedescription
    merchantNoyesstringno

    Body

    parameterNamerequiredtypedescription
    signYesstringExcept sign, initialise the remaining fields to form key1=value1key2=value2, use app secrect to do salt for md5 encryption, sign ends up being lowercase
    timestampYeslongtimestamp (1715941383720)
    tradeNoYesstringtradeNo (uniqueness (suggested year, month, day, hour, minute, second + random number) number)
    amountYesstringAmount (Decimal not supported)
    mobileNostringUser's mobile phone number
    emailNostringemail
    payerNostringPayer Name
    wayCodeYesstringcollection method code
    notifyUrlYesstringasynchronous callback address
    returnUrlNostringCheckout page jump address, remove the escape character ‘\’, refer to the format https://www.abc.com/ If not passed, jump to the default success page
    remarkNostringRemarks, this field will be brought back as is.

    Example of request parameters

    {
      "sign": "0be92a962072b1786a01a2cab4891a1d",
      "timestamp": "1728609257212",
      "tradeNo": "test_00000008",
      "amount": "300",
      "mobile": "15745896325",
      "email": "[email protected]",
      "payer": "kevin zhang",
      "notifyUrl": "https://google.com",
      "returnUrl": "http://abc.com/callback_page",
      "remark": "test",
      "wayCode": "va"
    }
    
    

    Response results

    parameter namerequiredtypedescription
    msgYesstringRequest result (when return success only means that the request is successful, can not do the merchant side of the logic judgement)
    codeYesstringRequest Response Code (when the return 0000 only indicates that the request is successful, can not do the merchant side of the logic judgement), the specific error code, please go to the business error code enumeration view
    timestampYesstringtrading hours
    successYesstringTransaction results
    dataYesObjectreturn object
    data.tradeNoYesstringMerchant Transaction Number
    data.platFormTradeNoYesstringPaypro transaction number, unique
    data.statusYesstringThe result of the request, merchants can use it as a logical processing, when the result is 0000 that the transaction is successful, 0001 that part of the payment, 0015 that processing, the other are error codes, can be treated as a failure.
    data.descYesstringmisdescription
    data.remarkYesstringReturn content of the request (brought back the way it was)
    data.paymentInfoYesstringPayment information

    Successful return example

    {
        "msg": "success",
        "code": "0000",
        "timestamp": 1728609277476,
        "success": true,
        "data": {
            "tradeNo": "test_00000008",
            "payproTradeNo": "68o0uwogz7mnzutt",
            "status": "0015",
            "desc": "Create",
            "remark": "test",
            "paymentInfo": "6841800930023213210"
        }
    }
    
    
    Last Updated:
    Contributors: wsc
    Prev
    Error Code
    Next
    PaymentPage API