Skip to main content
GET
How payouts went over a window

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

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

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

from
string<date-time>

created_at >= from.

to
string<date-time>

created_at < to.

Response

The report.

status
object
required
data
object