Sign in
Payouts

Gets a list of all payouts for a specific merchant.

Changed on

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

get/api/v1/payouts

Request

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

Query parameters

merchantIDstring uuid

Required. The ID of the merchant to get the payouts for.

pageNumberinteger

The page number from where records are retrieved.

pageSizeinteger

The number of records to be retrieved from a page.

statusesstring[]

An optional status filter for the payout records.

fromDatestring date-time

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

toDatestring date-time

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

searchstring

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

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.

minAmountnumber double

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

maxAmountnumber double

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

tagsstring[]

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

sortstring

Optional expression to sort the order of the payouts.

includeArchivedboolean

Flag that indicates whether to include archived payouts.

onlyArchivedboolean

When true, only archived payouts are returned.

Response

Returns a list of payout records.

pageNumberinteger

Current page number. Its 1 based. i.e firstpage is 1, secondpage is 2

pageSizeinteger

Page size

totalPagesinteger

Total pages

totalSizeinteger

Total count

Changes