v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-01-20203250.6 KB
Reports

Get number of payments by transaction (payment) state

get/v1/report/payments_by_state

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
}