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

Payment API

    Tips

    • All requests are Post requests, and the data format is json
    Brief Description
    • None
    Request URL
    • /v1/paypro/payIn
    Request Method
    • POST
    Header
    HeaderRequiredTypeDescription
    merchantNoYesstring-
    Body
    Parameter NameRequiredTypeDescription
    signYesstringExcept for the sign, concatenate the remaining fields in alphabetical order to form key1=value1key2=value2, then use the app secret as salt to perform MD5 encryption. The sign should be in lowercase letters. Use the new field name name (not username) when generating the signature.
    timestampYeslongTimestamp (e.g., 1715941383720)
    amountYesstringPayment amount
    nameyesstringUser Name
    mobileyesstringUser's mobile phone number
    emailyesstringemail account
    channelCodeyesstringchannelCode๏ผˆEWALLETใ€VA๏ผ‰
    wayCodenostringwayCode
    โ€ข channelCode๏ผšEWALLET๏ผŒwayCode๏ผšPALMPAY
    โ€ข channelCode๏ผšVA๏ผŒwayCode๏ผšVA
    tradeNoYesstringTransaction number (should be unique; suggested format: YYYYMMDDHHMMSS + random number)
    remarkYesstringRemarks; this field will be returned as is
    notifyUrlYesstringAsynchronous callback URL (e.g., https://www.abc.com/); if not provided, the system will redirect to the default success page
    returnUrlNostringRedirect page after successful payment
    Request Parameter Example
    {
        "sign": "f5b02d1e945897f194b32d9ef9773a6e",
        "timestamp": 1748247671673,
        "tradeNo": "pSPqrzJJ3MHkdyzS",
        "amount": "500",
        "mobile": "15875595997",
        "email": "kevin@gmail.com",
        "name": "kevin",
        "channelCode": "EWALLET",
        "wayCode": "PALMPAY",
        "notifyUrl": "http://www.google.com",
        "returnUrl": "http://www.google.com",
        "remark": "test"
    }
    
    Response Result
    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)
    timestampYesstringTransaction time
    successYesstringTransaction result
    dataYesObjectResponse object
    data.tradeNoYesstringMerchant transaction number returned
    data.platFormTradeNoYesstringUnique paypro transaction number
    data.payInfoYesObjectPayment information. For VA (Virtual Account) payments, returns bankName, virtualAccountNumber, virtualAccountHolder, and expirationTimestamp; for wallet payments such as OPay/PalmPay, returns paymentUrl. The actual fields depend on the payment method.
    data.payInfo.bankNameConditionalStringBank associated with the VA. Returned only for VA payments.
    data.payInfo.virtualAccountNumberConditionalStringVA account number. Returned only for VA payments.
    data.payInfo.virtualAccountHolderConditionalStringVA account holder name. Returned only for VA payments.
    data.payInfo.expirationTimestampConditionalStringVA expiration time. Returned only for VA payments.
    data.payInfo.paymentUrlConditionalStringPayment redirect URL. Returned only for wallet payments such as OPay/PalmPay.
    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.remarkYesStringThe remark value from the request, returned unchanged.
    Successful Response Example
    {
        "msg": "success",
        "code": "0000",
        "timestamp": 1748247675703,
        "success": true,
        "data": {
            "tradeNo": "pSPqrzJJ3MHkdyzS",
            "platFormTradeNo": "7gwtljttc64lu4e2",
            "status": "0015",
            "message": "PAYING",
            "payInfo": {
                "paymentUrl": "https://checkout-daily.palmpay.com/h5-checkout/"
            },
            "remark": "test"
        }
    }
    
    Last Updated:
    Contributors: gxwu
    Prev
    Payment Cashier
    Next
    Payout API