GOgovernment-digital-service
Reports

Get transaction summary by hour

Changed on
get/v1/report/transactions-by-hour

Request

  • Base URL
    http://ledger_url
  • URL
    http://ledger_url/v1/report/transactions-by-hour
  • 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

all_paymentsinteger
amountinteger
completed_paymentsinteger
errored_paymentsinteger
feeinteger
net_amountinteger
timestampstring date-time
total_amountinteger

Example response

[
  {
    "all_payments": 10,
    "amount": 70,
    "completed_payments": 7,
    "errored_payments": 3
  }
]

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_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

    • 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

    • 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

    • warning

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