Skip to main content
A payout request asks you to pay a partner the commissions they’ve earned. Partners usually create them in the partner portal, and Partnero can create them automatically. The payout requests API lets you do the same from your own system, and move a request through review until it’s paid.
Affiliate programs only. Call these endpoints server-side, because they need your secret API key.

Key concepts

  • Payout request ID: a numeric id returned when the request is created. Use it to get, approve or mark the request as paid.
  • Gateway: how the partner is paid: paypal, wise, crypto or venmo.
  • Payout settings: the partner’s payment details for the gateway (for example their PayPal email). You can send them when creating a payout request.
  • Status: where the request is in its lifecycle (see Status values).

Available endpoints

List and search

Retrieve payout requests, filtered by partner, status or currency

Get payout request

Get a single payout request by ID

Create payout request

Request a payout on a partner’s behalf

Approve

Approve a payout request

Mark as paid

Record that the payout has been paid

Lifecycle

  1. Create: the request starts as requested. Partner portal requests and requests from automations appear here too.
  2. Approve: the status becomes approved and the partner gets the approval email. If automated payouts are enabled, the payout may then be scheduled, and the status changes to one of the *_scheduled values.
  3. Mark as paid: once you’ve paid the partner outside Partnero, the status becomes finished. The payout’s commissions are marked as paid and the partner gets the “payout sent” email.

The payout request object

Status values

Create, approve and mark as paid are safe to retry. Identical requests sent at the same time are processed one after another, so the same commissions can’t be paid out twice.