Sign in
Payouts

Gets a list of all payout metrics for a specific merchant.

<b>Authorization</b>: End user or Merchant token (IP address whitelisted) is required.

get/api/v1/payouts/metrics

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/payouts/metrics
  • Auth: API key in header Authorization

Query parameters

merchantIDstring uuid

Required. The ID of the merchant to get the payout metrics for.

fromDatestring date-time

The date filter to apply to retrieve payouts created after this date as metrics.

toDatestring date-time

The date filter to apply to retrieve payouts created up until this date as metrics.

searchstring

The text filter to apply to retrieve payouts with a similar title, description, merchant name or contact information as metrics.

currency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC'

The currency filter to apply to retrieve payouts with this currency as metrics.

minAmountnumber double

The amount filter to apply to retrieve payouts that exceed this amount as metrics.

maxAmountnumber double

The amount filter to apply to retrieve payouts that don't exceed this amount as metrics.

tagsstring[]

The tag filter to apply to retrieve payouts with at least one of these tags as metrics.

includeArchivedboolean

Flag that indicates whether to include archived payouts in the metrics.

Response

OK

allnumber double

Total payout count.

inProgressnumber double

Payouts with Pending, Queued or QueuedUpstream status.

pendingApprovalnumber double

Payouts with PendingApproval or PendingInput status.

failednumber double

Payouts with Failed, Rejected or Unknown status.

paidnumber double

Payouts with Processed status.

schedulednumber double

Payouts with Scheduled status.

totalAmountsByCurrencyobject nullable

The total amounts by status and currency.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.