List payout batches
curl --request GET \
--url https://www.referly.so/api/v1/payout-batches \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.referly.so/api/v1/payout-batches"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.referly.so/api/v1/payout-batches', 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://www.referly.so/api/v1/payout-batches",
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://www.referly.so/api/v1/payout-batches"
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://www.referly.so/api/v1/payout-batches")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.referly.so/api/v1/payout-batches")
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{
"data": [
{
"id": "batch_2f88a163",
"createdAt": "2026-09-30T02:00:00.000Z",
"updatedAt": "2026-09-30T02:00:00.000Z",
"status": "READY",
"periodStart": "2026-09-01T00:00:00.000Z",
"periodEnd": "2026-09-30T23:59:59.000Z",
"affiliateProgramId": "prog_acme_partners",
"paidMethod": "INTEGRATION",
"payoutMethod": "WISE",
"rewardType": "CASH",
"externalBatchId": null,
"failedReason": null,
"manuallyPaidAt": null,
"isReferlyPayouts": false,
"payouts": [
{
"id": "pay_7c1e4b90",
"affiliateId": "aff_9f2c1e42",
"affiliateProgramId": "prog_acme_partners",
"amount": 342.75,
"currency": "USD",
"status": "PENDING",
"paymentMethod": "WISE",
"rewardType": "CASH",
"nonCashRewardType": null,
"periodStart": "2026-09-01T00:00:00.000Z",
"periodEnd": "2026-09-30T23:59:59.000Z",
"createdAt": "2026-09-30T02:00:00.000Z",
"payoutBatchId": "batch_2f88a163",
"failedReason": null,
"externalId": null,
"manuallyPaid": false,
"paidAt": null,
"vatRate": 0,
"vatAmount": 0,
"amountLockedAt": null,
"referlyChargeId": null,
"commissions": [
{
"id": 4821,
"commissionEarned": 42.5
},
{
"id": 4903,
"commissionEarned": -12.5
}
]
}
]
}
],
"nextCursor": null
}Payout Batch Endpoints
List payout batches
Requires payout-batches:read. See Payout batches behavior and common API rules. Pass pagination=cursor for ; omitting it returns the legacy latest-50 array. The legacy id query selects one batch. X-Program-Id selects the program in both cursor and legacy response modes.
GET
/
payout-batches
List payout batches
curl --request GET \
--url https://www.referly.so/api/v1/payout-batches \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.referly.so/api/v1/payout-batches"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.referly.so/api/v1/payout-batches', 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://www.referly.so/api/v1/payout-batches",
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://www.referly.so/api/v1/payout-batches"
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://www.referly.so/api/v1/payout-batches")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.referly.so/api/v1/payout-batches")
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{
"data": [
{
"id": "batch_2f88a163",
"createdAt": "2026-09-30T02:00:00.000Z",
"updatedAt": "2026-09-30T02:00:00.000Z",
"status": "READY",
"periodStart": "2026-09-01T00:00:00.000Z",
"periodEnd": "2026-09-30T23:59:59.000Z",
"affiliateProgramId": "prog_acme_partners",
"paidMethod": "INTEGRATION",
"payoutMethod": "WISE",
"rewardType": "CASH",
"externalBatchId": null,
"failedReason": null,
"manuallyPaidAt": null,
"isReferlyPayouts": false,
"payouts": [
{
"id": "pay_7c1e4b90",
"affiliateId": "aff_9f2c1e42",
"affiliateProgramId": "prog_acme_partners",
"amount": 342.75,
"currency": "USD",
"status": "PENDING",
"paymentMethod": "WISE",
"rewardType": "CASH",
"nonCashRewardType": null,
"periodStart": "2026-09-01T00:00:00.000Z",
"periodEnd": "2026-09-30T23:59:59.000Z",
"createdAt": "2026-09-30T02:00:00.000Z",
"payoutBatchId": "batch_2f88a163",
"failedReason": null,
"externalId": null,
"manuallyPaid": false,
"paidAt": null,
"vatRate": 0,
"vatAmount": 0,
"amountLockedAt": null,
"referlyChargeId": null,
"commissions": [
{
"id": 4821,
"commissionEarned": 42.5
},
{
"id": 4903,
"commissionEarned": -12.5
}
]
}
]
}
],
"nextCursor": null
}Requires
payout-batches:read. See the payout batches guide for behavior and examples.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Select the key's original program or a program provisioned by this exact key. Other owned programs remain inaccessible.
Query Parameters
Required range:
1 <= x <= 100Required to opt into paginated data/nextCursor; omit for legacy latest-50 array.
Available options:
cursor Response
Success. Monetary amounts use program currency; see companion documentation for resource fields.
- object[]
- object
The response is of type object.
Last modified on October 23, 2026
⌘I