List Payouts for the current Business and environment
curl --request GET \
--url https://api.usecleff.com/v1/payouts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.usecleff.com/v1/payouts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.usecleff.com/v1/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.usecleff.com/v1/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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.usecleff.com/v1/payouts"
req, _ := http.NewRequest("GET", 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.get("https://api.usecleff.com/v1/payouts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecleff.com/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"payouts": [
{
"id": "<string>",
"state": "pending_approval",
"status": "needs_approval",
"delivered_at": "2023-11-07T05:31:56Z",
"beneficiary_id": "<string>",
"destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_kind": "bank",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_minor": 123,
"purpose_of_payment": "advertising",
"currency": "<string>",
"external_ref": "<string>",
"idempotency_key": "<string>",
"validator_strategy": "manual",
"environment": "sandbox",
"provider": "<string>",
"provider_payout_id": "<string>",
"rail": "ach",
"rail_ref": "<string>",
"replaces_payout_id": "<string>",
"failure_code": "insufficient_funds",
"failure_detail": "<string>",
"fault": "business",
"replaceable": true,
"created_at": "2023-11-07T05:31:56Z",
"beneficiary_name": {},
"beneficiary_type": "person",
"via": {}
}
],
"next_cursor": {}
}{
"error": {
"code": "bad_request",
"message": "updatedSince must be a valid ISO-8601 timestamp",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "sandbox"
},
"docs_url": "https://docs.usecleff.com/errors#bad_request"
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#unauthorized"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Slow down and retry after the window.",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#rate_limited"
}
}Payouts
List Payouts
GET
/
v1
/
payouts
List Payouts for the current Business and environment
curl --request GET \
--url https://api.usecleff.com/v1/payouts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.usecleff.com/v1/payouts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.usecleff.com/v1/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.usecleff.com/v1/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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.usecleff.com/v1/payouts"
req, _ := http.NewRequest("GET", 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.get("https://api.usecleff.com/v1/payouts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecleff.com/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"payouts": [
{
"id": "<string>",
"state": "pending_approval",
"status": "needs_approval",
"delivered_at": "2023-11-07T05:31:56Z",
"beneficiary_id": "<string>",
"destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_kind": "bank",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_minor": 123,
"purpose_of_payment": "advertising",
"currency": "<string>",
"external_ref": "<string>",
"idempotency_key": "<string>",
"validator_strategy": "manual",
"environment": "sandbox",
"provider": "<string>",
"provider_payout_id": "<string>",
"rail": "ach",
"rail_ref": "<string>",
"replaces_payout_id": "<string>",
"failure_code": "insufficient_funds",
"failure_detail": "<string>",
"fault": "business",
"replaceable": true,
"created_at": "2023-11-07T05:31:56Z",
"beneficiary_name": {},
"beneficiary_type": "person",
"via": {}
}
],
"next_cursor": {}
}{
"error": {
"code": "bad_request",
"message": "updatedSince must be a valid ISO-8601 timestamp",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "sandbox"
},
"docs_url": "https://docs.usecleff.com/errors#bad_request"
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#unauthorized"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Slow down and retry after the window.",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#rate_limited"
}
}Agents: fetch this page as plain markdown at
https://docs.usecleff.com/api-reference/payouts-list.md.Authorizations
Cleff API key, created in the dashboard under Settings → API keys
Query Parameters
Only Payouts in this lifecycle state. It filters on state, not on the status field a Payout carries: settled is accepted, in_transit is not.
Available options:
pending_approval, approved, rejected, disbursed, failed, returned, canceled, settled, compliance_hold ISO-8601 timestamp; only Payouts with updated_at >= updatedSince are returned. Designed for polling clients.