Sign in
Merchants

Gets a list of transactions for all a merchant's accounts.

Changed on

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

get/api/v1/merchants/{merchantID}/transactions

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/merchants/{merchantID}/transactions
  • Auth: API key in header Authorization

Path parameters

merchantIDstring uuid required

The ID of the merchant to get transactions for.

Query parameters

pageNumberinteger

The page number from where records are retrieved. Note that the paging starts from page 1. If a 0 is supplied it will be treated as a 1 and the first page is returned.

pageSizeinteger

The number of records to be retrieved from a page.

fromDatestring date-time

The date filter to apply to retrieve transactions added after this date.

toDatestring date-time

The date filter to apply to retrieve transactions added up until this date.

includeChildMerchantsboolean

Flag to indicate whether to include transactions from child merchants.

creditType'All' | 'Payin' | 'Payout'

A credit filter to apply to the transactions to retrieve.

searchstring

The text filter to apply to retrieve transactions with a similar account name, description, their reference, your reference, etc.

sortstring

Optional expression to sort the order of the transactions. Example "Amount desc,Inserted asc".

minAmountnumber double

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

maxAmountnumber double

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

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

  • c3bc202d31deRevision changes
    • ○

      added the new optional query request parameter creditType

    • ○

      added the new optional query request parameter maxAmount

    • ○

      added the new optional query request parameter minAmount

    • ○

      added the new optional query request parameter search

    • ○

      added the new optional query request parameter sort