Trigger a payout of the consumer's pool.
Pays out the consumer’s PAID_IN rewards: reserves the funds in the ledger, moves the money on the PSP (working capital to the program’s UPM wallet, then a bank wire to the consumer’s recipient), and marks the rewards PAID_OUT. Returns 202 Accepted: the payout is initiated synchronously but the bank wire is settled asynchronously by the PSP.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
- Token URL
- /tokens
Headers
Path Parameters
2 - 100^[a-zA-Z0-9_-]+$"consumer-12345"
Response
Successful Response
Total amount paid out (sum of the settled rewards).
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"120.50"
Identifier of the payout created on PayLead's side.
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Identifier of the bank wire payout created on the PSP (Mangopay) side.
"mp-payout-987"
Number of rewards settled by this payout.
5
Settlement status. The payout is initiated synchronously but the bank wire is settled asynchronously by the PSP, so it starts as PENDING.