Skip to main content
POST
Trigger a payout of the consumer's pool.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version
string
default:2.0.0
required

Path Parameters

consumer_id
string
required
Required string length: 2 - 100
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"consumer-12345"

Response

Successful Response

amount
string
required

Total amount paid out (sum of the settled rewards).

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"120.50"

payout_id
string<uuid>
required

Identifier of the payout created on PayLead's side.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

psp_payout_id
string
required

Identifier of the bank wire payout created on the PSP (Mangopay) side.

Example:

"mp-payout-987"

reward_count
integer
required

Number of rewards settled by this payout.

Example:

5

status
string
default:PENDING

Settlement status. The payout is initiated synchronously but the bank wire is settled asynchronously by the PSP, so it starts as PENDING.