SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Affiliates

List payout batches

Payout batches, newest first, up to 200.

GEThttps://app.softsolz.uk/api/v1/services/affiliates/affiliates/payouts

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Query Params

statusstring

Only batches in this status: draft, approved, processing, paid or failed.

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Number of batches to skip (default 0).

Response

Response Body · array of objects

idstringPayout batch id.
referencestringHuman-readable payout reference.
statusstringA new batch is a draft until it is approved and then paid.
methodstringHow the partners will be paid.
currencystringPayout currency.
total_centsintegerTotal to pay across every partner in the batch, in minor units.
commission_countintegerCommissions included in the batch.
approved_atstring | nullWhen the batch was approved, or null.
paid_atstring | nullWhen the batch was settled, or null.
external_referencestring | nullBank or provider reference recorded when the batch was paid, or null.
failure_reasonstring | nullWhy the payout failed, or null.
created_atstringWhen the batch was built.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/affiliates/affiliates/payouts \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": [
{
"id": "4",
"reference": "PAY-20261001-K3QZ",
"status": "draft",
"method": "manual",
"currency": "GBP",
"total_cents": 37500,
"commission_count": 1,
"approved_at": null,
"paid_at": null,
"external_reference": null,
"failure_reason": null,
"created_at": "2026-10-01T10:30:00.000Z"
}
],
"meta": {
"limit": 50,
"offset": 0,
"total": 1,
"has_more": false
}
}