Request Headers

Header Name	Header Value
`Content-Type`	application/json
`X-VERIFY`	SHA256(base64 encoded payload + "/v4/debit" + salt key) + ### + salt index
`X-REDIRECT-URL`	Dynamic redirect URI for UI callback
`X-REDIRECT-MODE`	HTTP mode to be used for UI callback
`X-CALLBACK-URL`	Dynamic callback URI for server to server callback
`X-CALL-MODE`	HTTP mode to be used for server to server callback
`X-PROVIDER-ID`	Used for the cases where the merchant has multiple merchant IDs

{
  "merchantId": "UATMERCHANT",
  "transactionId": "TX123456789",
  "merchantUserId": "U123456789",
  "amount": 100,
  "merchantOrderId": "OD1234",
  "mobileNumber": "9xxxxxxxxx",
  "message": "payment for order placed OD1234",
  "subMerchantId": "DemoMerchant"
}

{
  "merchantId": "UATMERCHANT",
  "transactionId": "TX123456789",
  "merchantUserId": "U123456789",
  "amount": 100,
  "merchantOrderId": "OD1234",
  "mobileNumber": "9xxxxxxxxx",
  "message": "payment for order placed OD1234",
  "subMerchantId": "DemoMerchant",
  "email": "amit***[email protected]",
  "shortName": "Amit",
  "gstBreakup": {
    "gst": 100,
    "cgst": 25,
    "cess": 25,
    "sgst": 25,
    "igst": 25,
    "gstIncentive": 100,
    "gstPercentage": 10
  },
  "invoiceDetails": {
    "invoiceNumber": "123456fffff##_##",
    "invoiceDate": "2021-06-29T10:13:54.022Z",
    "invoiceName": "bccbd_cjdcdjc******"
  }
}

{
  "request": "ewogICJtZXJjaGFudElkIjogIlVBVE1FUkNIQU5UIiwKICAidHJhbnNhY3Rpb25JZCI6ICJUWDEyMzQ1Njc4OSIsCiAgIm1lcmNoYW50VXNlcklkIjogIlUxMjM0NTY3ODkiLAogICJhbW91bnQiOiAxMDAsCiAgIm1lcmNoYW50T3JkZXJJZCI6ICJPRDEyMzQiLAogICJtb2JpbGVOdW1iZXIiOiAiOXh4eHh4eHh4eCIsCiAgIm1lc3NhZ2UiOiAicGF5bWVudCBmb3Igb3JkZXIgcGxhY2VkIE9EMTIzNCIsCiAgInN1Yk1lcmNoYW50SWQiOiAiRGVtb01lcmNoYW50Igp9"
}

Request Parameters

Parameter Name	Type	Description	Mandatory
`merchantId`	`STRING`	Unique `MerchantID` assigned to the merchant by PhonePe	`Yes`
`transactionId`	`STRING`	Unique `TransactionID` generated by the merchant to track request to PhonePe transactionId length should be less than 38 characters.	`Yes`
`merchantUserId`	`STRING`	Unique `UserID` generated by merchant. This is used to pre-login users authenticated on PhonePe. Un-authenticated users are redirected to PhonePe login page. Conversions are higher when this is provided. Avoid passing email/mobile number. Skip this for guest users. merchantUserId length should be less than 64 characters. `Note:`	`Yes`
`userAuthToken`	`STRING`	Unique `userAuthToken`given to merchant in OTP flow. This is used to pre-login users authenticated on PhonePe. If not passed users will be redirected to PhonePe login page. `Note`
`amount`	`LONG`	Transaction amount in Paise	`Yes`
`merchantOrderId`	`STRING`	`OrderID` generated by the merchant merchantOrderId length should be less than 48 characters.	`No`
`subMerchantId`	`STRING`	.Tag to categorize merchant transaction. Skip this field if you don't have multiple merchants tagged under one merchant id	`No`
`mobileNumber`	`STRING`	Mobile number of the user	`No`
`message`	`STRING`	Short message. This message is displayed to the user on completion of payment.	`No`
`email`	`STRING`	Email address of the user	`No`
`shortName`	`STRING`	User's name pre-filled for registration purpose.	`No`
`gstBreakup`	`OBJECT`	Refer below for gstBreakup details	`No`
`invoiceDetails`	`OBJECT`	Refer below for invoice details	`No`

Request Parameters - gstBreakup Details

Parameter Name	Type	Mandatory	Comments
`gst`	`LONG`	`No`	In Paise.Cannot be Negative.
`cgst`	`LONG`	`No`	In Paise.Cannot be Negative.
`cess`	`LONG`	`No`	In Paise.Cannot be Negative.
`sgst`	`LONG`	`No`	In Paise.Cannot be Negative.
`igst`	`LONG`	`No`	In Paise.Cannot be Negative.
`gstIncentive`	`LONG`	`No`	In Paise.Cannot be Negative.
`gstPercentage`	`DOUBLE`	`No`	Cannot be Negative.

Request Parameters - invoiceDetails

Parameter Name	Type	Mandatory	Comments
`invoiceNumber`	`String`	`No`
`invoiceDate`	`String`	`No`	Should be of the format 1970-01-01T05:30:00+05:30
`invoiceName`	`String`	`No`

{
  "code": "SUCCESS",
  "message": "Your request has been successfully completed.",
  "data": {
    "redirectType": "WEB",
    "redirectURL": "https://mercury-t2.phonepe.com/transaction?token=fkjsdfka9248jfksjdfkilfjksdk"
  }
}

Response Parameters

Parameter Name	Type	Description
`success`	`Boolean`	Success status of the request
`code`	`Enum`	See list of response codes below
`shortName`	`String`	Short message about code

Regular Debit Response Codes

Code	Description
`INVALID_TRANSACTION_ID`	Duplicate `TransactionID`
`INVALID_USER_AUTH_TOKEN`	The userAuthToken provided is either invalid or not mapped to merchant.
`BAD_REQUEST`	Invalid request payload
`AUTHORIZATION_FAILED`	Incorrect X-VERIFY header
`INTERNAL_SERVER_ERROR`	Something went wrong

🚧
1.Make sure that 'follow redirection' is disabled while calling this API.
2.This location endpoint should be appended to host to get the complete redirection URL.
3.It's recommended to have the server to server call back using x-callback-url header.

Once the transaction is complete, user will be redirected back to the merchant.