E-Commerce & tokenized transactionsInvoice Management

Get Invoice

API Explorer
https://api.ipospays.tech/invoice-service/v1/invoices/{invoiceNumber}
GET

Use this API to retrieve details for a specific invoice by providing the invoice number. Returns the invoice along with its linked transactions and payment link status.

Path Parameters

invoiceNumber*string

Invoice number returned by Create Invoice

Length5 <= length <= 100

Header Parameters

token*string

Authentication token generated using the API Key and Secret Key. Required for all API requests.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com" \  -H "token: your-access-token-here"

{
  "data": {
    "invoice_number": "261081836256kaMqjI5iP",
    "customer_id": "OGS1AN68JFR6H54",
    "amount": 1050,
    "status": "DRAFT",
    "store_id": "05cbaac8502f",
    "tpn": null,
    "invoice_url": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
    "payment_link_status": "NONE",
    "transactions": [],
    "created_at": "2026-10-08T13:06:26.000Z",
    "updated_at": "2026-10-08T13:06:26.000Z"
  },
  "message": "Invoice retrieved successfully",
  "response_code": "SUCCESS",
  "status_code": 200,
  "request_id": "TEST-20261008183713-IW_VLJ",
  "timestamp": "2026-10-08T13:07:13.720Z"
}

{
  "data": null,
  "message": "The request contains invalid input parameters.",
  "response_code": "BAD_REQUEST",
  "status_code": 400,
  "request_id": "TEST-20261008183716-EXAF_X",
  "timestamp": "2026-10-08T13:07:16.707Z",
  "errors": [
    {
      "field": "invoiceNumber",
      "messages": [
        "invoiceNumber must be at least 5 characters",
        "invoiceNumber may only contain letters and numbers"
      ]
    }
  ]
}

{
  "data": null,
  "message": "Missing authentication token. Please include a valid API token in your request.",
  "response_code": "TOKEN_MISSING",
  "status_code": 401,
  "request_id": "TEST-20261022075139-6GFCT2",
  "timestamp": "2026-10-22T07:51:39.713Z"
}

{
  "data": null,
  "message": "Invoice not found",
  "response_code": "NOT_FOUND",
  "status_code": 404,
  "request_id": "TEST-20261008183717-VCA_Z7",
  "timestamp": "2026-10-08T13:07:17.436Z"
}

{
  "data": null,
  "message": "Too many requests, please try again in a minute",
  "response_code": "RATE_LIMITED",
  "status_code": 429,
  "timestamp": "<ISO 8601 time>"
}

{
  "data": null,
  "message": "An error occurred while processing your request. Please try again later.",
  "response_code": "INTERNAL_ERROR",
  "status_code": 500,
  "request_id": "<generated per request>",
  "timestamp": "<ISO 8601 time>"
}

Create InvoiceUpdate Invoice