Skip to main content
POST
/
perks
/
consumers
/
{consumer_id}
/
pools
/
me
/
payouts
Trigger a payout of the consumer's pool.
curl --request POST \
  --url https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/pools/me/payouts \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/pools/me/payouts"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/pools/me/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/pools/me/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/pools/me/payouts"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/pools/me/payouts")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/pools/me/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "amount": "<string>",
  "payout_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "psp_payout_id": "<string>",
  "reward_count": 123,
  "status": "PENDING"
}

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
​
Authorization
string | null

Path Parameters

​
consumer_id
string
required
Required string length: 2 - 100
Pattern: ^[a-zA-Z0-9_.-]*$

Response

Successful Response

​
amount
string
required

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

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
payout_id
string<uuid>
required

Identifier of the payout created on PayLead's side.

​
psp_payout_id
string
required

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

​
reward_count
integer
required

Number of rewards settled by this payout.

​
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.