UPI INTENT

Request Details

Parameter NameData TypeMandatoryDescription
merchantOrderIdStringYesUnique order ID generated by merchant
amountlongYesAmount of order in Paisa
contraintsList<InstrumentConstraint>NoDifferent type of constraints that must be applied to the payment
deviceOSStringNoOperating system of the device. Allowed values are:
1. IOS
2. ANDROID
merchantCallbackSchemeStringNoRequired only in case targetApp = PHONEPE and deviceOS = IOS
targetAppStringNoThe target app identifier for the UPI Intent flow.
For IOS:
PHONEPE,
GPAY,
PAYTM.
For Android: com.phonepe.app, net.one97.paytm

Example

import {CustomCheckoutClient, Env} 
from 'pg-sdk-node';
import { PgPaymentRequest, PgPaymentResponse } 
from 'pg-sdk-node';
import { v4 
as uuid } 
from 'uuid';
 

const clientId:
string = "<clientId>";

const clientSecret:
string = "<clientSecret>";

const clientVersion:
string = 1;  //insert your client version here

const env:Env = Env.SANDBOX;      //change to Env.PRODUCTION when you go live
 

const client = CustomCheckoutClient.
getInstance(clientId, clientSecret, clientVersion, env);
  

const merchantOrderId = 
uuid();

const amount = 100;

const deviceOS = 'IOS';

const targetApp = 'PHONEPE';
  

const request = PgPaymentRequest.
UpiIntentPayRequestBuilder()
  .
merchantOrderId(merchantOrderId)
  .
amount(amount)
  .
targetApp(targetApp)
  .
deviceOS(deviceOS)
  .
build();
  
cliet.
pay(request).
then((response) => {
  
const intentUrl = response.intentUrl;
});

Extract the intentUrl from the response received.

Response Details

PropertyTypeDescription
orderIdStringOrder Id created by PhonePe
stateStringState of the order. Initially it will be PENDING.
expireAtLongOrder expire date in epoch
IntentUrlStringIntent url according to the targetApp mentioned in the request
Is this article helpful?