---
title: "Invoice refund"
method: POST
path: "/tsp/pg/portal/pay/paymentInvoice/refund"
---

# Invoice refund

`POST /tsp/pg/portal/pay/paymentInvoice/refund`

## Request body

- object
  - `merchantId ` string, required — Merchant account ID. Size- 12
  - `aggregatorId` string — Aggregator account ID. Required if request is initiated from aggregator. Size- 12
  - `invoiceNo` string, required — Unique Ref/Invoice number for the payment request. Should be same as sent in original request. Size- 32
  - `amount` string, required — The amount to be refunded, it cannot exceed the original order amount. Size- 12
  - `loyaltyBurnRefundId` string — The id given by loyalty system for the Burn refund. For LJI this will refer to burn_cancel_bit_reference. Size- 32
  - `loyaltyEarnRefundId` string — The id given by the loyalty system for the Earn refund. For LJI this will refer to earn_cancel_bit_reference. Size- 32
  - `subOrders` object — Is mandatory if the original order/invoice is for a marketplace and the refund amount does not match the original order amount (partial refund). Can contain one or more of following sub structure. The sum of the amount of suborders has to match the refund amount. Size- 12
    - `sellerID ` string, required — Seller/Vendor ID against whom the refund must be accounted. Size- 12
    - `subOrderID` string, required — ID to identify the suborder under the invoice.Should be same as what was sent in original sub order creation for this sellerID. Size- 32
    - `amount` string, required — The amount that must be refunded from this sub order. Cannot exceed the original sub orders amount.
    - `loyaltyAmount` number — The value that is to be refunded back to loyalty.This is applicable only if this suborder had a loyalty redemption component as part of payment. The equivalent digital amount that needs to be refunded is calculated after reducing this field (i.e., digital refund amount = amount - loyaltyAmount)
    - `loyaltyEarnValue` number — The earned amount that needs to be reduced from loyalty.The earned loyalty value that is reduced as part of this refund. Applicable only if the original suborder had a loyalty earn component.
  - `secureHash` string — Hash value. Size- 64

## Response `200`

- object
  - `responseCode` string, required — Response code indicating success/failure. R1000 / 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
  - `aggregagtorId ` string — Aggregator account ID. Echo of request field
  - `invoiceNo` string — Merchant Txn ref Number. Echo of request field
  - `secureHash ` string, required — Hash Value. Size- 64

---

[API](https://skmtc.net/jiopay/apis/jiopay-pg.md) · [All operations](https://skmtc.net/jiopay/apis/jiopay-pg/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jiopay/jiopay-pg/revisions/55aa41b8482f/schema)