Get Payouts

Facades: payout

Overview

Get a list of payouts filtered by query parameters.

Parameters

ParameterDescription
startDateThe start date for the query.
endDateThe end date for the query.
statusThe status to filter (optional).
referenceThe optional reference specified at payout request creation.
limitMaximum results that the query will return (useful for paging results)
offsetOffset for paging.

Example

const payouts = await client.getPayouts({ status: PayoutStatus.New });