Reports

Get platform performance report (total volume and total_amount) for the date range and transaction state. Queries transaction_summary table for stats

get/v1/report/performance-report

Query parameters

from_datestring

From date of the transaction summary to be searched (this date is inclusive). Required when to_date is provided

to_datestring

To date of the transaction summary to be searched (this date is inclusive). Required when from_date is provided

Transaction state

Response

average_amountnumber

total_amountnumber

total_volumeinteger

Example response

{
  "average_amount": 1000,
  "total_amount": 1000,
  "total_volume": 1
}

Changes

Changed in 9 of the 34 revisions of this API.195

Jan 16, 2025ef12d134c1151See the full diff
- ●
  added the new AMOUNT_BELOW_MINIMUM enum value to the response property for the response status
  response-property-enum-value-added
Nov 25, 20246a7b3b19bd401See the full diff
- ●
  added the new NON_HTTPS_RETURN_URL_NOT_ALLOWED_FOR_A_LIVE_ACCOUNT enum value to the response property for the response status
  response-property-enum-value-added
Jul 6, 20238563b7d75ea61See the full diff
- ●
  added the new CARD_NUMBER_IN_PAYMENT_LINK_REFERENCE_REJECTED enum value to the response property for the response status
  response-property-enum-value-added
Mar 15, 2023d06cd3b61b6c1See the full diff
- ●
  added the new IDEMPOTENCY_KEY_USED enum value to the response property for the response status
  response-property-enum-value-added
Jan 5, 2023fdbb87a0f0b31See the full diff
- ●
  added the new RECURRING_CARD_PAYMENTS_NOT_ALLOWED enum value to the response property for the response status
  response-property-enum-value-added
Jul 26, 20226ad00fd5c18a2See the full diff
- ●
  added the new INCORRECT_AUTHORISATION_MODE_FOR_SAVE_PAYMENT_INSTRUMENT_TO_AGREEMENT enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new REFUND_NOT_AVAILABLE_DUE_TO_DISPUTE enum value to the response property for the response status
  response-property-enum-value-added
Jul 20, 2022c567a4087099104See the full diff
- ●
  added the new ACCOUNT_DISABLED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new AGREEMENT_NOT_ACTIVE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new AUTHORISATION_API_NOT_ALLOWED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new AUTHORISATION_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new AUTHORISATION_REJECTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new AUTHORISATION_TIMEOUT enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new CARD_NUMBER_REJECTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new INVALID_ATTRIBUTE_VALUE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new MISSING_MANDATORY_ATTRIBUTE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new UNEXPECTED_ATTRIBUTE enum value to the response property for the response status
  response-property-enum-value-added
- ○
  added the new enum value LOST to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value NEEDS_RESPONSE to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value UNDER_REVIEW to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value WON to the query request parameter state
  request-parameter-enum-value-added
Apr 14, 2022fb0fe85883fd2See the full diff
- ●
  added the new ONE_TIME_TOKEN_ALREADY_USED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new ONE_TIME_TOKEN_INVALID enum value to the response property for the response status
  response-property-enum-value-added
Apr 3, 20224537560d10e81See the full diff
- ○
  endpoint added
  endpoint-added

Full history