List advertiser payments

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.

Reference

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

advertiserId integer required

Advertiser ID

1001

Query Params

balanceMonth string

Month whose balance record 'balance' reports, yyyy-MM (2010-01 to 2050-12). The current month when omitted.

2026-08

limit integer

Page size, 1 to 1000

50

month array<integer>

Only payments of these months (1-12)

9

start integer

0-based offset of the first payment to return

0

year array<integer>

Only payments of these years

2026

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

Language

cURL Request

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'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/payments.do?balanceMonth=2026-08&limit=50&month=9", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/payments.do?balanceMonth=2026-08&limit=50&month=9', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/payments.do?balanceMonth=2026-08&limit=50&month=9"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/payments.do?balanceMonth=2026-08&limit=50&month=9");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/payments.do?balanceMonth=2026-08&limit=50&month=9", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/payments.do?balanceMonth=2026-08&limit=50&month=9");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/payments.do?balanceMonth=2026-08&limit=50&month=9")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body