Skip to main content
GET
List payments

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

account_id
string<uuid>
required

Query Parameters

sort_by
enum<string>
default:date

Sort field of the returned page. Defaults to "date". Pages follow Stripe order, newest first; sorting orders the returned page only.

Available options:
date,
amount
sort_order
enum<string>
default:desc

Sort order of the returned page. Defaults to "desc".

Available options:
asc,
desc
limit
integer
default:20

Maximum number of payments to return, 1 to 100. Defaults to 20.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor pointing at the next page. Omit it to read the first page.

Minimum string length: 1

Response

One page of payments of the account, with receipt links.

data
object[]
required
page_info
object
required