GOgovernment-digital-service
Reports

Get number of payments by transaction (payment) state

Changed on
get/v1/report/payments_by_state

Request

  • Base URL
    http://ledger_url
  • URL
    http://ledger_url/v1/report/payments_by_state
  • Auth
    none declared

Query parameters

account_idstring

Gateway account ID. Required when override_account_id_restriction is 'false'

include_moto_statisticsboolean

Set to true to return statistics for moto transactions

from_datestring

From date of transactions to be searched (this date is exclusive).

to_datestring

To date of transactions to be searched (this date is exclusive).

override_account_id_restrictionboolean

Set to true to get counts for all gateway accounts.

Response

OK

object required

Example response

{
  "timedout": 0,
  "submitted": 0,
  "declined": 0,
  "created": 0,
  "success": 1,
  "cancelled": 0,
  "started": 0,
  "error": 0,
  "undefined": 0,
  "capturable": 0
}

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