---
title: "Invoice Status check"
method: POST
path: "/tsp/pg/portal/pay/invoicelist"
---

# Invoice Status check

`POST /tsp/pg/portal/pay/invoicelist`

## Request

- Base URL: `https://uat.jiopay.co.in`
- URL: `https://uat.jiopay.co.in/tsp/pg/portal/pay/invoicelist`
- Auth: none declared

## Request body

- object
  - `merchantId` string, required: Merchant account ID. Size-12
  - `aggregatorId` string: Aggregator account ID. Size-12
  - `invoiceNo ` string, required: The invoiceNo sent in order/invoice creation
  - `reqType` string, required: The request type. only the following value is supported: status. Size-12
  - `secureHash` string, required: Hash value. Size- 64

## Response `200`

- object
  - `responseCode` string, required: Response code indicating success/failure. 0000 – Success, Any other value failure. Size-4
  - `respDescription` string, required: Description of failure. Ignore for success response. Size-45
  - `merchantId ` string: Merchant account ID. Echo of request field
  - `aggregatorId ` string: Merchant Aggregator ID. Echo of request field
  - `invoiceNo ` string: The Invoice number. Echo of request field
  - `referenceNo` string: The reference number sent in invoice creation request
  - `userID ` string: User ID. The value sent in original invoice creation request
  - `mobileNo` string: Mobile No. The value sent in original invoice creation request
  - `chargeAmount` string: The order amount. The actual Order amount sent in invoice creation request.
  - `addlParam1` string: User defined field 1. The value sent in in the original invoice creation request
  - `addlParam2` string: User defined field 2. The value sent in in the original invoice creation request
  - `invoiceStatus` string: The status of invoice/order. Possible value are 1) Paid 2) Open 3) Expired 4) Rejected 5) Closed
  - `paidAmount` number: The total paid amount in this order. Will have value in case of fully paid or partially paid orders.
  - `refundedAmount` number: Refunded amount. Amount indicating the refunded portion of the order.
  - `payments` object: List of payments. Each payment will have the following subfields. Available only for fully paid or partly paid orders. This is a list of objects.
    - `txnID` string: Unique Txn ID for the payment
    - `paymentMode` string: The mode of payment. e.g., Card, NB, UPI, etc.,
    - `paymentID` string: The Payment ID sent by the Bank partner
    - `authCode` string: The authorization code sent by the bank partner. Sent if available
    - `paymentDateTime ` string: Payment Date Time (if order is paid). In yyyyMMddHHmmss format e.g 20220131225959
    - `paymentInstId` string: Payment instrument using which the payment is made. This field is sent only for some paymentModes and depends on Bank partners.
    - `amount` string: The amount that is part of this payment

---

[API](https://skmtc.dev/jiopay/apis/invoice-api.md) - [All operations](https://skmtc.dev/jiopay/apis/invoice-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jiopay/apis/invoice-api/revisions/761ea052f840?raw)