API ReferencePayments

List Payments

List payments

Required OAuth 2.0 scope: business/orders:read

Headers

AuthorizationstringRequired

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

Query parameters

cursorstring or nullOptional>=1 character<=255 characters
A pagination cursor from where results should start being fetched.
limitintegerOptional>=1<=100Defaults to 50
The maximum number of results to return.
created_at__gtestring or nullOptionalformat: "date-time"
The min payment created date and time in ISO 8601 format.
created_at__ltestring or nullOptionalformat: "date-time"
The max payment created date and time in ISO 8601 format.
updated_at__gtestring or nullOptionalformat: "date-time"
The min payment updated date and time in ISO 8601 format.
updated_at__ltestring or nullOptionalformat: "date-time"
The max payment updated date and time in ISO 8601 format.
statuslist of enums or nullOptional
A list of statuses to filter on.
Allowed values:

Response

Successful Response
datalist of objects
A list of paginated entities.
next_cursorstring or null
A pagination cursor that can be used to retrieve the next set of results.

Errors