API Reference

List payout groups

get
https://mo-services-zero-production.moprestamo.com/api/payouts/groups

A payout group represents one disbursement run bundling one or more individual payouts for a product; this lists those runs with their status and constituent payouts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date

Filter by payout calendar date (date lookup).

date

Include groups paid out on or after this date.

date

Include groups paid out after this date.

date

Include groups paid out on or before this date.

date

Include groups paid out before this date.

string
enum

Exact match on payout group status.

Allowed:
uuid

Exact match on aggregator id.

uuid

Exact match on product id.

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.

int32

Maximum number of items to return.

int32

Pagination offset.

Headers
string
required

API key generated for client authentication.

string
required

Aggregator identifier for request ownership.

Responses

500

Internal server error

Updated 19 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago

Did this page help you?