v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Payments

List payments

Endpoint for retrieving a list of payments.

get/payments/

Query parameters

contactstring

The unique identifier of the contact.

created_ts_afterstring date-time

The timestamp in UTC when the payment was created

created_ts_beforestring date-time

The timestamp in UTC when the payment was created

datestring date

Date

external_idstring

External identifier

modified_ts_afterstring date-time

The timestamp in UTC when the payment was last modified

modified_ts_beforestring date-time

The timestamp in UTC when the payment was last modified

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

paid_through_accountstring

The unique identifier of the paid through account.

payment_fees_accountstring

The unique identifier of the payment fees account.

projectstring

The unique identifier of the project.

referencestring

Reference

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}