PhonePe API Documentation

1. Send OTP

URL https://upikaro.in/phonepe/send-otp
Method POST

Required Parameters

Headers : Form-Encoded Payload (application/x-www-form-urlencoded)

Parameter Required Description
mobile Yes Contact Us Developer
key Yes Contact Us Developer
number Yes Phone number to send OTP
website-url Yes Your website URL

Response

Success Response
Success Response:
{
    "status": true,
    "message": "OTP Send Successfully."
}

                        
Failed Response
Failed Response:
{
    "status": false,
    "error": "OTP Not Send."
}

2. Verify OTP

URL https://upikaro.in/phonepe/verify-otp
Method POST

Required Parameters

Headers : Form-Encoded Payload (application/x-www-form-urlencoded)

Parameter Required Description
mobile Yes Contact Us Developer
key Yes Contact Us Developer
number Yes PhonePe Mobile Number
otp Yes Received PhonePe Mobile Number
website-url Yes Your website URL

Response

Success Response
Success Response:
{
    "status": true,
    "message": "Verification complete",
    "stores": [
        {
            "merchant": "Durga Electricals",
            "role": "Admin",
            "group_id": 9116424
        }
    ]
}
                        
Failed Response
Failed Response:
{
    "status": false,
    "error": "Incorrect OTP, Please Re-enter OTP"
}
                        

3. Set Store

URL https://upikaro.in/phonepe/set-store
Method POST

Required Parameters

Headers : Form-Encoded Payload (application/x-www-form-urlencoded)

Parameter Required Description
mobile Yes Contact Us Developer
key Yes Contact Us Developer
number Yes PhonePe Mobile Number
groupId Yes Find Verify OTP API
website-url Yes Your website URL

Response

Success Response
Success Response:
{
    "status": true,
    "message": "Verification Complete."
}
                  
Failed Response
Failed Response:
{
    "status": false,
    "error": "Invalid Data."
}
                        

4. Transactions History & Details

URL https://upikaro.in/phonepe/merchant-details
Method POST

Required Parameters

Headers : Form-Encoded Payload (application/x-www-form-urlencoded)

Parameter Required Description
mobile Yes Contact Us Developer
key Yes Contact Us Developer
number Yes PhonePe Mobile Number
day Yes Optional (1 - 100)
website-url Yes Your website URL

Response

Success Response
Success Response:
{
    "status": true,
    "mapped_qr": [
        {
            "merchantId": "M11XGJY5OKHD",
            "terminalId": "MST2312051045062065559342",
            "qrCodeId": "Q067538055@ybl"
        }
    ],
    "transactions": [
        {
            "payment": "SUCCESS",
            "transactionId": "T2408121238145541632137",
            "orderId": "2BanSHDZHQ1723446479",
            "utr": "459117428889",
            "note": "",
            "amount": 99,
            "date": "2024-08-12 12:38:18"
        }
    ]
}
                
Failed Response
Failed Response:
{
    "status": false,
    "error": "Invalid Data."
}
                        
Back