Create Invoice

post

https://uat.jiopay.co.in/tsp/pg/portal/pay/paymentInvoiceService

This is your first endpoint! Edit this page to start documenting your API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Important Developer Note
The provided code examples are for reference and instructional purposes only. Please integrate and thoroughly test them within your own build to ensure proper functionality.

Production Environment Invoice creation URL: https://jiopay.co.in/pg/portal/pay/paymentInvoiceService

Body Params

merchantId

string

required

Defaults to JPMID0000001

Merchant Account ID

invoiceNo

string

required

Unique reference number of the merchant for the payment request

chargeAmount

string

required

Defaults to 0.0

Total transaction amount

currencyCode

string

required

Defaults to 356

Transaction Currency

desc

string

required

Note for the transaction

dueDate

string

required

Due date in the format DD/MM/YYYY

emailID

string

User's Email ID. this is a required field if user's mobile number isn't given

mobileNo

string

User's Mobile number. this is a required field if user's Email ID isn't given

chargeHead1

string

required

addlParam1

string

addlParam2

string

aggregatorId

string

The unique ID assigned if using an aggregator. (Conditional parameter)

serviceProviderSplit

array of objects

If the invoice is created with Split Settlement instruction, this parameter will hold details for the splits. Indicate the component that needs to be settled to each serviceProvider. This is mandatory Incase of split settlement

serviceProviderSplit

secureHash

string

required

Defaults to abcdjhciahduoo9dj2

The digital signature calculated as per the Secure Hash logic. This is mandatory Incase of split settlement

allowedPaymentType

string

Indicates whether payment can be split or not. This Parameter is Mandatory for Split Payment.

expiryPeriod

string

Indicates Invoice Expiry period in hours. The invoice expires after this time period (from its creation), and no new operations are allowed after this time. This Parameter is Mandatory for Split Payment and Split Settlement use case

Responses

Important Developer Note The provided code examples are for reference and instructional purposes only. Please integrate and thoroughly test them within your own build to ensure proper functionality.

200Successful response

4XXInvoice already exist

Important Developer Note
The provided code examples are for reference and instructional purposes only. Please integrate and thoroughly test them within your own build to ensure proper functionality.