Sign in
Payruns

Gets all payruns for a merchant.

<b>Authorization</b>: End user or Merchant token is required.

<b>User permissions required</b>: CanViewPayruns

get/api/v1/payruns

Request

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

Query parameters

merchantIDstring uuid

The merchant ID to get the payruns for

pageNumberinteger

The page number from where records are retrieved.

pageSizeinteger

The number of records to be retrieved from a page.

fromDatestring date-time

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

toDatestring date-time

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

sortstring

Optional expression to sort the order of the payruns.

statusesstring[]

An optional status filter list

searchstring

The text filter to apply to retrieve payruns

onlyArchivedboolean

Flag that indicates whether to fetch only archived payruns or not

Response

OK

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

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