Starts background generation of partner payouts for the networks/partners in the request.

post

https://platform.routy.app/api/v1/partners/payouts/generate

Runs asynchronously: the response payload carries a TaskId that can be polled for progress.
Unlike the per-network variant, this overload does not enforce the same-month period check.
Requires the ListNetworks policy and the partners feature.

🔐 Required permission: networks.read

🚩 Requires feature: partners

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The generation request (period plus optional network and partner ids).

Request to generate partner payouts for a period.

networkId

array of int32s | null

Optional network ids to generate payouts for.

networkId

partnerId

array of int32s | null

Optional partner ids to restrict generation to.

partnerId

periodStart

date-time

Inclusive start of the payout period (UTC).

periodEnd

date-time

Inclusive end of the payout period (UTC).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Generation was started; the payload contains the background task id.

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error