Skip to main content
GET
List of all payments

Authorizations

Authorization
string
header
required

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

Query Parameters

created_at__gte
string<date>

This is a filter for the payment creation date, use it to get the list of payments where creation date >= created_at__gte. ISO 8601 date time format (greater than or equal to). No time should be provided, it starts at 00:00:00 be default. For example 2020-01-23 -> 2020-01-23T00:00:00Z.

created_at__lte
string<date-time>

This is a filter for the payment creation date, use it to get the list of payments where creation date <= created_at__lte. ISO 8601 date time format (less than or equal to). No time should be provided, it starts at 00:00:00 be default. For example 2020-01-23 -> 2020-01-23T00:00:00Z.

limit
integer

Limits the number of returned results.

Required range: x <= 20
status
enum<string>

Filter the orders by specific statuses:

  • authorized, closed and rejected belong to the API payment statuses;
  • new, captured, refunded and `cancelled`` refer to the statuses on Tabby Merchant Dashboard;
  • If absent, all AUTHORIZED and CLOSED payments are returned.
Available options:
authorized,
closed,
rejected,
new,
captured,
refunded,
cancelled
Example:

"authorized"

offset
integer

The number of records into a dataset that you want to start, indexed at 0.

Response

Success. Returns a list of payments.

payments
object[] | null
pagination
object