Skip to main content
Phone Pe Business Logo

NetBanking

This API allows you to accept payments using NetBanking from supported banks.

⚠️ Required Headers for Payment Initiation!

You must include all required HTTP headers in your payment initiation request. Omitting these headers will result in payment errors. For a complete list of mandatory headers, please refer to: HTTP HEADERS

EnvironmentHTTP MethodAPI
SandboxPOSThttps://api-preprod.phonepe.com/apis/pg-sandbox/payments/v2/pay
ProductionPOSThttps://api.phonepe.com/apis/pg/payments/v2/pay

⚠️ Setup Required to Avoid Errors!

Before initiating a payment, install the PhonePe Test App and configure the payment template. Skipping this step may result in HTTP 500 errors.

Request Headers
Header NameHeader Value
Content-Typeapplication/json
AuthorizationO-Bearer <partner-auth-token>
X-MERCHANT-IDMID
Request Parameters
Parameter NameData TypeMandatoryDescriptionConstraints
merchantOrderIdStringYesUnique merchant order id generated by merchant.Max Length = 63 charactersNo Special characters allowed except underscore “_” and hyphen “-“
merchantUserId
StringNoUnique merchant User Id generated by merchant.
amountLongYesOrder amount in paisa.Min Value = 100 (In paise)
expireAfterLongNoOrder expiry in seconds. If not passed default value will be used.Min Value = 300, Max Value = 5184000

Default Value (in Secs):
UPI QR: 480
UPI Intent : 600
UPI Collect: 480
Card : 720
NetBanking : 480
metaInfoObjectNoMerchant defined meta info to store additional information.same data will be returned in status and callback response.
paymentFlowObjectYesAdditional details required by this flow.
merchantUrls.redirectUrlStringYesUrl where user will be redirected after completing the payment. Mandatory only for [NET_BANKING, TOKEN, CARD] Payment Mode.Valid Http url. 

The metaInfo object contains additional parameters, which are explained in the table below.

Request Parameters of metoInfo Object:
Parameter NameData TypeDescriptionMandatory (Yes/No)Constraints
metaInfo.udf1-15StringOptional details you can add for more informationNo• Maximum length for Udf1-10 = 256 characters
• Maximum length for Udf11-15 = 50 characters

⚠️ Do Not Rename metainfo Parameters!

It is mandatory to keep the parameter names udf1, udf2, etc., exactly as they are in the metainfo block. Renaming these key values will result in a production error.

The paymentMode contains additional parameters, which are explained in the table below.

Request Parameters
Parameter NameData TypeMandatoryDescriptionConstraints
paymentMode.typeStringYesType of payment modeValues Allowed:
• UPI_INTENT
• UPI_COLLECT
• UPI_QR
• NET_BANKING
• TOKEN
• CARD
paymentMode.bankIdStringYesBank id from where payment will be completed.
Sample Request
{
    "merchantOrderId": "TX123456",
    "amount": 1000,
    "expireAfter": 1200,
    "metaInfo": {
        "udf1": "additional-information-1",
        "udf2": "additional-information-2",
        "udf3": "additional-information-3",
        "udf4": "additional-information-4",
        "udf5": "additional-information-5",
        "udf6": "additional-information-6",
        "udf7": "additional-information-7",
        "udf8": "additional-information-8",
        "udf9": "additional-information-9",
        "udf10": "additional-information-10",
        "udf11": "additional-information-11",
        "udf12": "additional-information-12",
        "udf13": "additional-information-13",
        "udf14": "additional-information-14",
        "udf15": "additional-information-15"
    },
    "paymentFlow": {
        "type": "PG",    
       "paymentMode" : {
            "type" : "NET_BANKING",
            "bankId" : "HDFC",
            "merchantUserId": ""
        },
        "merchantUrls": {
            "redirectUrl": "<redirectUrl>"
        } 
    }
}
Sample Response
{
"orderId": "OMO123456789",
"state": "PENDING",
"expireAt": 1703756259307,
"redirectUrl": "https://netpe.phonepe.com/v1/redirect?id=5b998b72-ca84-475b-9f06-4ecf3828f6ed"
}
Field NameData TypeDescription
orderIdStringPG generated internal order id.
stateStringState of the order created, Expected value is CREATED.
expiryAtLongOrder expiry date in epoch (in milliseconds).
redirectUrlStringUrl where merchant is supposed to redirect user to complete payment.
Is this article helpful?