GOgovernment-digital-service
Reports

Get monthly performance report by gateway account. Queries transaction_summary table

Changed on
get/v1/report/gateway-performance-report

Request

  • Base URL
    http://ledger_url
  • URL
    http://ledger_url/v1/report/gateway-performance-report
  • Auth
    none declared

Query parameters

from_datestring required

From date of transaction summary to be searched (this date is inclusive).

to_datestring required

To date of transaction summary to be searched (this date is inclusive).

Response

OK

average_amountnumber
gateway_account_idinteger
monthinteger
total_amountnumber
total_volumeinteger
yearinteger

Example response

[
  {
    "average_amount": 1000,
    "gateway_account_id": 1,
    "month": 3,
    "total_amount": 1000,
    "total_volume": 1,
    "year": 2022
  }
]

Changes

  • 450e568b5b08Revision changes
    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_ADYEN enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_STRIPE enum value to the response property for the response status

    • info

      removed the AMOUNT_BELOW_MINIMUM enum value from the response property for the response status

  • ef12d134c115Revision changes
    • warning

      added the new AMOUNT_BELOW_MINIMUM enum value to the response property for the response status