v1

latestOpenAPI 3.1.02026-07-26290731.0 KB

Get Invoice Details

get/paymentgateway/api/v1/merchant/invoice/{reference}

Path parameters

referencestring required

Headers

Authorizationstring required

Content-Typestring required

Response

200

idinteger

amountinteger

customerNamestring

customerEmailstring

descriptionstring

merchantCodestring

payableCodestring

payableIdinteger

referencestring

invoiceLinkstring

invoiceStatusstring

{"stackTrail":"paths:/paymentgateway/api/v1/merchant/invoice/{reference}:get:responses:200:content:application/json:schema:properties:responseCode","oasType":"schema","type":"unknown"}

taxnumber

discountPercentnumber

addressstring

shippingFeeinteger

dueDateinteger

createdDateinteger

lastUpdatedinteger

currencyCodestring

Example response

{
  "id": 30494,
  "amount": 250000,
  "customerName": "Uat tax Name email",
  "customerEmail": "test@test.com",
  "description": "Ok Shaa test an invoice dddhdhddiiidd   dfhffuff",
  "merchantCode": "MX6072",
  "payableCode": "9405967",
  "payableId": 33597,
  "reference": "INVCK02JBWWC",
  "invoiceLink": "https://qa.interswitchng.com/paymentgateway/invoice/pay/INVCK02JBWWC",
  "lineItems": [
    {
      "itemName": "Uat Ba New",
      "quantity": 2,
      "itemAmount": 25000
    }
  ],
  "invoiceStatus": "CANCELED",
  "tax": 12.5,
  "discountPercent": 5.5,
  "address": "This is a string adress dddrrrur JKkdkd",
  "shippingFee": 70000,
  "dueDate": 2604188800000,
  "createdDate": 1627131989680,
  "lastUpdated": 1627132206383,
  "currencyCode": "566"
}