Skip to main content
GET
/
api
/
v1
/
invoices
List invoices (cursor pagination)
curl --request GET \
  --url https://api-beta.pepay.io/api/v1/invoices \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "object": "invoice",
      "id": "inv_123",
      "merchant_id": 42,
      "status": "paid",
      "invoice_type": "standard",
      "currency": "usd",
      "amount": 129900,
      "amount_decimal": "129.900",
      "amount_unit": "usd_millis",
      "environment": "mainnet",
      "created_at": "2025-01-01T12:00:00Z"
    }
  ],
  "has_more": false
}

Authorizations

​
Authorization
string
header
required

JWT token for wallet authentication

Query Parameters

​
limit
integer
default:10

Max number of invoices to return.

Required range: 1 <= x <= 100
​
starting_after
string<uuid>

Cursor (return invoices created before this ID).

​
ending_before
string<uuid>

Cursor (return invoices created after this ID).

​
status
string

Comma-separated invoice statuses.

​
invoice_type
string

Comma-separated invoice types.

​
customer_id
string

Filter by merchant customer ID.

​
environment
enum<string>

Filter by network environment.

Available options:
mainnet,
devnet
​
created_gte
string<date-time>

Return invoices created on/after this time.

​
created_lte
string<date-time>

Return invoices created on/before this time.

​
expand
string

Comma-separated expansions (latest_payment, payments).

​
payments_limit
integer
default:10

Max payments per invoice when expand includes payments.

Required range: 1 <= x <= 100

Response

Invoice list retrieved successfully

​
object
string
Example:

"list"

​
data
object[]
​
has_more
boolean