PaymentRequests

Gets payment request metrics of a merchant.

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

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

get/api/v1/paymentrequests/metrics

Request

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

Query parameters

merchantIDstring uuid

The merchant ID to get the payment request metrics. This field is ignored for merchant tokens and required for user tokens.

fromDatestring date-time

The date filter to apply to retrieve payment request metrics created after this date.

toDatestring date-time

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

searchstring

The text filter to apply to retrieve payment requests with a similar title, description or contact information.k

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 request metrics with this currency.

minAmountnumber double

The amount filter to apply to retrieve payment request metrics that exceed this amount.

maxAmountnumber double

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

tagsstring[]

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

paymentMethodsstring[]

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

includeArchivedboolean

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

Response

OK

allinteger

Total payment request count.

unpaidinteger

Total payment request count with status None.

partiallyPaidinteger

Total payment request count with status PartiallyPaid.

paidinteger

Total payment request count with status FullyPaid.

authorizedinteger

Total payment request count with status Authorized.

totalAmountsByCurrencyobject nullable

The total amounts by status and currency.

Changes

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