Skip to main content
GET
Settlements (withdrawals), 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

status
string

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

q
string

Part of the id, reference, phone or receipt.

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

Settlements.

status
object
required
data
object[]