Skip to main content

List Payouts

Lists payouts for your account, with optional filters.

GET/api/payout/list

Authentication​

Scope: payouts:read

Authorization: Bearer <YOUR_PAYOUT_KEY>

Query Parameters​

FieldTypeDescriptionRequired
merchant_referencestringFind a payout by your own id❌
customer_idstringPayouts bound to this customer (redirect delivery)❌
statusstringOne of the payout statuses❌
sincestringISO 8601 UTC, e.g. 2026-09-01T00:00:00Z. Created at or after❌
untilstringISO 8601 UTC. Created before (exclusive)❌
limitintegerPage size, default 50, maximum 200❌
offsetintegerNumber of results to skip❌

Response Fields​

{
"total": 132,
"limit": 50,
"offset": 0,
"data": [
{ "payout_id": "po_9f3c1d7b2a8e4c15d0b6a291", "status": "paid", "…": "…" }
]
}
FieldDescription
totalNumber of payouts matching the filters, across all pages
limit / offsetThe page actually returned (limit is capped at 200)
dataThe payouts, newest first. Each is a payout in the merchant view
tip

merchant_reference is permanently unique per account, so filtering on it is the reliable way to find a payout again — for example after an attempt_unresolved response.

Request Samples​

curl -s "https://luxfin.org/api/payout/list?merchant_reference=refund-ORD-10231" \
-H "Authorization: Bearer $PAYOUT_KEY"

curl -s "https://luxfin.org/api/payout/list?status=awaiting_choice&limit=20&offset=0" \
-H "Authorization: Bearer $PAYOUT_KEY"