Sign in
PaymentRequests

Gets a list of all payment requests.

Changed on

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

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

get/api/v1/paymentrequests

Request

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

Query parameters

merchantIDstring uuid

The merchant ID to get he list of payment requests for. This field is ignored for merchant tokens and required for user tokens.

pageinteger

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.

sizeinteger

The number of records to be retrieved from a page.

fromDatestring date-time

The date filter to apply to retrieve payment requests created after this date.

toDatestring date-time

The date filter to apply to retrieve payment requests created up until this date.

status'All' | 'None' | 'FullyPaid' | 'PartiallyPaid' | 'OverPaid' | 'Voided' | 'Authorized'

The status filter to apply to retrieve payment requests with this status

searchstring

The text filter to apply to retrieve payment requests 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 payment requests with this currency.

minAmountnumber double

The amount filter to apply to retrieve payment requests that exceed this amount.

maxAmountnumber double

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

tagsstring[]

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

paymentMethodsstring[]

The payment method filter to apply to retrieve payment requests with any of these payment methods.

sortstring

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

includeArchivedboolean

Flag that indicates whether to include archived payment requests or not.

onlyArchivedboolean

When true, only archived payment requests are returned.

Response

Returns the list of payment requests.

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