---
title: "List advertiser payments"
type: reference
method: GET
path: /rest-api/advertiser/{advertiserId}/payments.do
tag: "Network Finances"
---

# List advertiser payments

`GET https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/{advertiserId}/payments.do`

The payments booked against one advertiser — the Payments card of the advertiser and the Advertisers Funds grid of Network Finances — newest first, optionally narrowed to some years and months. 'totalAmount' is the sum of every payment the filters match (the card's Total), not only of the returned page. 'balance' is the advertiser's balance record for 'balanceMonth' (the current month by default) as the Advertiser balance grid shows it: start balance, charges, payments and end-of-month balance; it is null while no balance has been calculated for that month. Requires the NETWORK_BILLING_MANAGEMENT and ADVERTISERS_FUNDS permissions, or SHOW_ADVERTISERS_FUNDS, and campaign VIEW (SHARED or ALL); with SHARED the advertiser must be shared with the caller.

## Path params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `advertiserId` | integer | yes | `1001` | Advertiser ID |

## Query params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `balanceMonth` | string | no | `2026-08` | Month whose balance record 'balance' reports, yyyy-MM (2010-01 to 2050-12). The current month when omitted. |
| `limit` | integer | no | `50` | Page size, 1 to 1000 |
| `month` | array<integer> | no | `9` | Only payments of these months (1-12) |
| `start` | integer | no | `0` | 0-based offset of the first payment to return |
| `year` | array<integer> | no | `2026` | Only payments of these years |

## Responses

- `200` — {success, advertiserId, advertiserName, total, start, limit, totalAmount, payments:[{paymentId, date (yyyy-MM-dd), year, month, amount, comment}], balance:{year, month, startBalance, charges, payments, endOfMonthBalance}|null}
- `400` — 'start', 'limit' or 'balanceMonth' is out of range or malformed
- `401` — Authentication error
- `403` — The caller lacks one of the required permissions
- `404` — No such advertiser, or it is not shared with the caller

## Example request

```bash
curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/payments.do?balanceMonth=2026-08&limit=50&month=9' \
  --header 'X-Api-Key: YOUR_API_KEY'
```

Source: https://epom.com/ad-server/docs/api/network-finances/get-advertiser-payments