API Reference

Starts background generation of partner payouts for a specific network.

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

Runs asynchronously: the response payload carries a TaskId that can be polled for progress.
The supplied periodStart and periodEnd must fall within the same calendar month,
otherwise 400 is returned. Requires the ListNetworks policy and the partners feature.

🔐 Required permission: networks.read

🚩 Requires feature: partners

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The unique identifier of the network for which payouts are to be generated.

Body Params

The generation request (period and optional 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
date-time

Inclusive start of the payout period (UTC).

date-time

Inclusive end of the payout period (UTC).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago