Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

dateFromUTC
string

Start of the window. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and read as that day at 00:00:00Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window. Billing windows are whole UTC days, so a timestamp selects the day it falls on. Omit both bounds to read every document.

dateToUTC
string

End of the window, inclusive. Defaults to today. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and covers that whole day, through 23:59:59.999Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window. Billing windows are whole UTC days, so a timestamp selects the day it falls on.

scope
enum<string>
default:platform

Whose payments to list.

Available options:
platform,
sub_accounts
type
enum<string>
default:ALL

Only invoices or only receipts.

Available options:
ALL,
INVOICE,
RECEIPT
locationId
string

With scope=sub_accounts, only this sub-account's receipts. Refused with any other scope.

Minimum string length: 1
page
integer
default:1

Page number, from 1.

Required range: x >= 1
limit
integer
default:10

Rows per page, at most 100.

Required range: 1 <= x <= 100

Response

One page of documents.

success
boolean
required
Example:

true

data
object
required
pagination
object
required