Skip to main content
GET
List disbursements, newest first

Authorizations

Authorization
string
header
required

A merchant-scoped API key, issued by CloudPay staff or the merchant's owner. Acts with exactly its scopes.

Path Parameters

merchantID
string<uuid>
required

Query Parameters

batch_id
string<uuid>
status
string

One status or a comma list, e.g. failed,review.

q
string

Part of the id, reference, phone or receipt.

provider
enum<string>
Available options:
mpesa,
sasapay,
paystack
method
string

Collections: stk, charge, checkout. Disbursements: the payee type (mobile, bank, till, paybill).

category
enum<string>

Why an attempt failed, worked out from what the provider said. Empty unless the attempt is failed (or review, which reads review).

Available options:
review,
test_mode,
cancelled,
insufficient_funds,
wrong_pin,
busy,
timeout,
limit,
invalid_account,
declined,
provider_error,
other
before
string<date-time>

created_at cursor (exclusive).

from
string<date-time>

created_at >= from.

to
string<date-time>

created_at < to.

limit
integer

Default 50.

Required range: x <= 200
format
enum<string>

csv answers text/csv (not JSON) with every match, up to 50,000 rows newest first, ignoring before and limit.

Available options:
csv

Response

Disbursements.

status
object
required
data
object[]