Skip to main content
GET
/
api
/
v1
/
invoices
/
totals
Get invoice totals
curl --request GET \
  --url https://api-beta.pepay.io/api/v1/invoices/totals \
  --header 'x-api-key: <api-key>'
{
  "object": "invoice_totals",
  "currency": "usd",
  "amount_unit": "usd_millis",
  "totals": {
    "all": {
      "amount": 129900,
      "amount_decimal": "129.900",
      "count": 3
    },
    "paid": {
      "amount": 99900,
      "amount_decimal": "99.900",
      "count": 2
    },
    "unpaid": {
      "amount": 30000,
      "amount_decimal": "30.000",
      "count": 1
    },
    "underpaid": {
      "amount": 0,
      "amount_decimal": "0.000",
      "count": 0
    },
    "expired": {
      "amount": 0,
      "amount_decimal": "0.000",
      "count": 0
    },
    "canceled": {
      "amount": 0,
      "amount_decimal": "0.000",
      "count": 0
    }
  }
}

Authorizations

​
x-api-key
string
header
required

API key for server-to-server operations (scope=merchant or commerce)

Query Parameters

​
status
string

Comma-separated invoice statuses.

​
invoice_type
string

Comma-separated invoice types.

​
customer_id
string

Filter by merchant customer ID.

​
payer_wallet_address
string

Filter by payer wallet address (matches any invoice payment).

​
payer_wallet_network
enum<string>

Optional; requires payer_wallet_address.

Available options:
ethereum,
base,
solana,
avalanche,
ton,
bsc,
arbitrum,
optimism,
cardano,
sui
​
environment
enum<string>

Filter by network environment.

Available options:
mainnet,
devnet
​
created_gte
integer

Include invoices created on/after this time.

​
created_lte
integer

Include invoices created on/before this time.

Response

Invoice totals retrieved successfully

​
object
string
Example:

"invoice_totals"

​
currency
string
Example:

"usd"

​
amount_unit
string
Example:

"usd_millis"

​
totals
object