Add a publisher payout

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/site/{siteId}/payouts.do

Books a payout to the site's publisher, exactly as the Add payment row of Network Finances → Publishers Payments does: the payout is stored with the year and month of its date, and every publisher balance record from that month to the current one is adjusted by the amount. 'amount' must be greater than 0; 'date' is yyyy-MM-dd (today when omitted, between 2010 and 2050); 'comment' is optional, up to 200 characters. Payouts are in the network's currency. Requires the NETWORK_BILLING_MANAGEMENT and PUBLISHERS_PAYMENTS permissions; without inventory VIEW at ALL level the site must be shared with the caller.

Path Params

siteId integer required

Site ID

2001

Form Params

amount number required

Amount paid, in the network's currency; greater than 0 and at most 9999999.999999

1500.00

comment string

Optional memo, up to 200 characters

September invoice #2231

date string

Payment date, yyyy-MM-dd between 2010 and 2050. Today when omitted.

2026-09-15

Responses

200

Payout booked: {success, siteId, payout:{paymentId, date, year, month, amount, comment}}

400

Field errors under 'errors' (amount, date, comment)

401

Authentication error

403

The caller lacks one of the required permissions

404

No such site, or it is not shared with the caller

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/site/2001/payouts.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'amount=1500.00' \
  --data-urlencode 'comment=September invoice #2231' \
  --data-urlencode 'date=2026-09-15'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/site/2001/payouts.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"amount": "1500.00", "comment": "September invoice #2231", "date": "2026-09-15"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/site/2001/payouts.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"amount":"1500.00","comment":"September invoice #2231","date":"2026-09-15"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/site/2001/payouts.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("amount=1500.00&comment=September%20invoice%20%232231&date=2026-09-15"))
    .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("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/site/2001/payouts.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["amount"] = "1500.00", ["comment"] = "September invoice #2231", ["date"] = "2026-09-15" });

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

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/site/2001/payouts.do", strings.NewReader(`amount=1500.00&comment=September%20invoice%20%232231&date=2026-09-15`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	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/site/2001/payouts.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'amount=1500.00&comment=September%20invoice%20%232231&date=2026-09-15');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/site/2001/payouts.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('amount' => "1500.00", 'comment' => "September invoice #2231", 'date' => "2026-09-15")

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