Skip to main content

Get Invoices

Retrieves a paginated list of invoices. Supports filtering by store, status, and date range.

When to Use

Use this endpoint when:

  • Listing invoices in a dashboard
  • Reconciling paid vs pending invoices
  • Searching invoices within a date range
info

Invoice status values: PENDING, PAID, EXPIRED, DELETED.

How to Use

Endpoint
GET/api/v3/invoices?limit=10&status=PENDING&status=PAID
  1. Send the request with optional filters (storeId, status, start, end, limit)
  2. Read items for the invoice list
  3. If cursor is non-empty, pass it on the next request to fetch the next page

Request Parameters

storeIdSTRING

Filter by store ID

Example: 1608714483132458121

statusARRAY

Filter by invoice status. Repeat the param for multiple statuses.

Example: ["PENDING", "PAID"]

limitNUMBER

Number of records per page

Example: 10

cursorSTRING

Pagination cursor from the previous response

Example: EgdpbnZvaWNlGKrg...

startSTRING

Filter invoices created from this date time (RFC3339)

Example: 2026-05-18T09:21:19Z

endSTRING

Filter invoices created up to this date time (RFC3339)

Example: 2026-05-19T09:21:19Z

Response Parameters

cursorSTRING

Cursor for the next page (empty when there are no more results).

itemsARRAY

List of invoice objects.

idSTRING

Invoice ID.

referenceIdSTRING

Merchant-defined reference ID.

recurringInvoiceIdSTRING

Recurring invoice ID (empty if not recurring).

invoiceGroupIdSTRING

Invoice group ID (empty if standalone).

merchantIdSTRING

Merchant ID.

merchantNameSTRING

Merchant name.

merchantLogoUrlSTRING

Merchant logo URL.

merchantEmailSTRING

Merchant notification email.

storeIdSTRING

Store ID.

payerEmailSTRING

Payer email address.

payerNameSTRING

Payer name.

payerPhoneNumberSTRING

Payer phone number.

payerCountryCodeSTRING

Payer country code.

currencySTRING

Currency code.

amountNUMBER

Invoice amount in cents (e.g. 100 = RM 1.00).

paidAmountNUMBER

Amount paid in cents.

feesPaidAmountNUMBER

Fees amount in cents.

netPaidAmountNUMBER

Net amount received in cents.

invoiceStatusSTRING

Invoice status (PENDING, PAID, EXPIRED, DELETED).

transactionIdSTRING

Transaction ID (populated when paid).

invoiceUrlSTRING

Shareable invoice payment URL.

redirectUrlSTRING

URL to redirect the payer after payment.

tncUrlSTRING

Terms and conditions URL.

remarksSTRING

Additional remarks.

shouldSendEmailBOOLEAN

Whether an email notification is sent to the payer.

emailSubjectSTRING

Email subject.

descriptionSTRING

Invoice description.

expiryAtSTRING

Invoice expiry date time (RFC3339).

paidAtSTRING

Payment date time (RFC3339, empty if unpaid).

createdDateTimeSTRING

Invoice creation date time (RFC3339).

updatedDateTimeSTRING

Last updated date time (RFC3339).

customFieldsOBJECT

Custom fields (null if not set; not in use at the moment).