List payouts by aggregator

get

https://mo-services-zero-production.moprestamo.com/api/payouts/{aggregator_id}

Returns payouts for the aggregator identified by aggregator_id, scoped to the requester's ownership tree.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

aggregator_id

uuid

required

Aggregator identifier whose payouts are being listed (must be the caller or a descendant).

Query Params

string

Exact match on payout id.

reference

string

Exact match on payout reference.

date

Filter by the date the payout was settled.

date__gte

date

Include payouts paid out on or after this date.

date__gt

date

Include payouts paid out after this date.

date__lte

date

Include payouts paid out on or before this date.

date__lt

date

Include payouts paid out before this date.

product_id

uuid

Filter by product.

currency_id

uuid

Filter by currency.

group_id

uuid

Exact match on the payout group id.

group_reference

string

Filter by the payout group's reference.

string

Free-text match on aggregator reference (exact), display name (partial, case-insensitive), external id (partial, case-insensitive), or an exact id/aggregator_id when the value is a valid UUID.

ordering

string

Sort the results by any field present in the response. Prefix the name with - for descending order, for example -created_at. Defaults to newest first.

limit

int32

Maximum number of items to return.

offset

int32

Pagination offset.

Headers

x-api-key

string

required

API key generated for client authentication.

x-aggregator-id

string

required

Aggregator identifier for request ownership.

Responses

500

Internal server error

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400400

401401

403403

404404

423423