List Payouts

GET

payouts

List Payouts for the current Business and environment

curl --request GET \
  --url https://api.example.com/v1/payouts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.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.example.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.example.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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.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",
      "beneficiary_id": "<string>",
      "bank_account_id": "<string>",
      "amount_minor": 123,
      "purpose_of_payment": "advertising",
      "currency": "<string>",
      "external_ref": {},
      "idempotency_key": "<string>",
      "validator_strategy": "manual",
      "environment": "sandbox",
      "provider": {},
      "provider_payout_id": {},
      "rail_ref": {},
      "replaces_payout_id": {},
      "created_at": "2023-11-07T05:31:56Z",
      "beneficiary_name": {},
      "beneficiary_type": "person",
      "via": {}
    }
  ],
  "next_cursor": {}
}

Authorizations

Authorization

string

header

required

Cleff API key issued to a Business that self-registers via POST /v1/registration

Query Parameters

limit

number

cursor

string

status

enum<string>

Available options:

pending_approval,

approved,

rejected,

disbursed,

failed,

returned,

canceled,

settled,

compliance_hold

updatedSince

string

ISO-8601 timestamp; only Payouts with updated_at >= updatedSince are returned. Designed for polling clients.

Response

payouts

object[]

required

Show child attributes

next_cursor

object | null

required

⌘I

List Payouts for the current Business and environment

curl --request GET \
  --url https://api.example.com/v1/payouts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.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.example.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.example.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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.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",
      "beneficiary_id": "<string>",
      "bank_account_id": "<string>",
      "amount_minor": 123,
      "purpose_of_payment": "advertising",
      "currency": "<string>",
      "external_ref": {},
      "idempotency_key": "<string>",
      "validator_strategy": "manual",
      "environment": "sandbox",
      "provider": {},
      "provider_payout_id": {},
      "rail_ref": {},
      "replaces_payout_id": {},
      "created_at": "2023-11-07T05:31:56Z",
      "beneficiary_name": {},
      "beneficiary_type": "person",
      "via": {}
    }
  ],
  "next_cursor": {}
}

Basics

Reference

Authorizations

Query Parameters

Response