Skip to main content
GET
List the approval rate of each payment account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

period
enum<string>
required

Reporting period to count over. last_24_hours runs from the start of the hour 24 hours ago to the end of the current hour; last_7_days and last_30_days from the start of the day that many days ago to the end of today; last_month and last_year are the previous calendar month and year. Use custom with start_date and end_date for any other window.

Available options:
last_24_hours,
last_7_days,
last_30_days,
last_month,
last_year,
custom
start_date
string<date-time>

ISO 8601 start of a custom period. Required when period is custom; must be before end_date.

end_date
string<date-time>

ISO 8601 end of a custom period. Required when period is custom.

Response

The approved and declined counts of each payment account that made a gateway decision in the period.

payment_accounts
object[]
required

One entry per payment account with at least one approved or declined payment in the period, ordered by payment_account_id.

period
object
required

The window that was counted.

meta
object