Browse the help center

Change a publisher payout

Changes the amount, date or comment of a payout of the site, as Edit on Network Finances → Publishers Payments and on the site's Payments card does; a field left out keeps its value.

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

Changes the amount, date or comment of a payout of the site, as Edit on Network Finances → Publishers Payments and on the site's Payments card does; a field left out keeps its value. The balance moves with the payout: the old amount is taken out from the old month on and the new amount added from the new month on, in one transaction. The payout stays with this site — to move it to another one, delete it and add a new payout there. The change is stamped with the caller and the time (updatedBy, updatedAt) and written to the action log. 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

paymentId integer required

Payout ID, as returned by the payout list

21

Form Params

amount number

New amount, in the network's currency; greater than 0 and at most 9999999.999999

1500.00

comment string

New memo, up to 200 characters; an empty value clears it

September invoice #2231

date string

New payment date, yyyy-MM-dd between 2010 and 2050

2026-09-15

Responses

200

Payout changed: {success, siteId, payout:{paymentId, date, year, month, amount, comment, createdAt, createdBy, updatedAt, updatedBy}}

400

Field errors under 'errors' (amount, date, comment); a date before the month the balances start from (GET /rest-api/network/management/balances-start.do) is refused under 'date'

401

Authentication error

403

The caller lacks one of the required permissions

404

No such site or payout, the payout belongs to another site, or the site is not shared with the caller

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.