Introduction

Backend NodeJs SDK to integrate PhonePe PG APIs.

Installation

Minimum supported versions

• Node Version: v14

Install the dependency using npm

npm i https://phonepe.mycloudrepo.io/public/repositories/phonepe-pg-sdk-node/releases/v2/phonepe-pg-sdk-node.tgz

Onboarding

To get your client ID and secret, refer to the PhonePe business dashboard in Production. For UAT, you can reach out to the Integration team.

String clientId = "<clientId>";
String clientSecret = "<clientSecret>";
Integer clientVersion = "<clientVersion>"; 

Quick start:

Class Initialisation

To create an instance of the StandardCheckoutClient class, you need to provide the keys received at the time of onboarding.

Example usage:

import { StandardCheckoutClient, Env } from 'pg-sdk-node';
 
const clientId = "<clientId>";
const clientSecret = "<clientSecret>";
const clientVersion = 1;  //insert your client version here
const env = Env.SANDBOX;      //change to Env.PRODUCTION when you go live
 
const client = StandardCheckoutClient.getInstance(clientId, clientSecret, clientVersion, env);

For detailed information on Class Initialisation – Refer here

Initiate an order using Checkout Page

To use the PhonePe Payment Gateway, create the request using the StandardCheckoutPayRequest.Builder() and then send this request to the pay() function.

You will get to initiate the order using the pay function :

Code :

import { StandardCheckoutPayRequest } from 'pg-sdk-node';
import { randomUUID } from 'crypto';
  
const merchantOrderId = randomUUID();
const amount = 100;
const redirectUrl = "https://www.merchant.com/redirect";
  
const request = StandardCheckoutPayRequest.builder()
        .merchantOrderId(merchantOrderId)
        .amount(amount)
        .redirectUrl(redirectUrl)
        .build();
  
client.pay(request).then((response)=> {
    const checkoutPageUrl = response.redirectUrl;
    console.log(checkoutPageUrl);
})

The data will be in a StandardCheckoutPayResponse object.
User should be redirected to the checkoutPageUrl received in the response.

For detailed information on Initiate Payment – Refer here

Check Status of an order

To check the status of the order.

import { OrderStatusResponse } from 'pg-sdk-node';
 
const merchantOrderId = '<merchantOrderId>'; //created at the time of order creation
 
client.getOrderStatus(merchantOrderId).then((response) => {
  const state = response.state;
});

Returns an OrderStatusResponse Object

For detailed information on Check Order Status – Refer here

Order Callback Handling

You will receive a callback if you have configured URL in the dashboard

Verify the validity of the callback received from PhonePe using validateCallback() function. You need to pass four parameters to the function

1. username 
2. password
3. authorization (received in callback headers)
4. responseBody (received in the callback payload)

code :

const authorizationHeaderData = "ef4c914c591698b268db3c64163eafda7209a630f236ebf0eebf045460df723a" // received in the response headers
const phonepeS2SCallbackResponseBodyString = "{\"type\": \"PG_ORDER_COMPLETED\",\"payload\": {}}"  // callback body as string
  
const usernameConfigured = "<MERCHANT_USERNAME>"
const passwordConfigured = "<MERCHANT_PASSWORD>" 
 
const callbackResponse = client.validateCallback(
    usernameConfigured,
    passwordConfigured,
    authorizationHeaderData,
    phonepeS2SCallbackResponseBodyString );
 
const orderId = callbackResponse.payload.orderId;
const state = callbackResponse.payload.state;

The validateCallback will throw PhonePeException, if the callback is invalid.

Possible order callback states:

1. checkout.order.completed
2. checkout.order.failed
3. checkout.transaction.attempt.failed

For detailed information on Order Callback Handling – Refer here

Create Order SDK Integration

This function is used when the merchant is using the Frontend SDK and backend is in Nodejs. Merchant can call the function to get the token which can be used by the frontend to initiate an order

Use case – When your backend is in NodeJs and you are using a Frontend SDK as well

The createSdkOrder() function is used to create an order.

import { StandardCheckoutClient, Env, CreateSdkOrderRequest } from 'pg-sdk-node';
import { randomUUID } from 'crypto';
 
const clientId = "<clientId>";
const clientSecret = "<clientSecret>";
const clientVersion = 1;  //insert your client version here
const env = Env.SANDBOX;      //change to Env.PRODUCTION when you go live
 
const client = StandardCheckoutClient.getInstance(clientId, clientSecret, clientVersion, env);
 
const merchantOrderId = randomUUID();
const amount = 1000;
const redirectUrl = "https://redirectUrl.com";
 
const request = CreateSdkOrderRequest.StandardCheckoutBuilder()
        .merchantOrderId(merchantOrderId)
        .amount(amount)
        .redirectUrl(redirectUrl)
        .build();
 
client.createSdkOrder(request).then((response) => {
    const token = response.token
})

The function returns a CreateSdkOrderResponse object from which merchant should retrieve the Order Token.

For detailed information on Created Order SDK – Refer here