v1
latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MBList payments
Retrieve all payments created with the current website profile.
The results are paginated.
🔑 Access with
API key
Advanced access token with payments.read
OAuth access with payments.read
Query parameters
Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.
The maximum number of items to return. Defaults to 50 items.
Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.
Possible values: asc desc
The identifier referring to the profile this entity belongs to.
Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.
The identifier referring to the profile you wish to retrieve the resources for.
Most API credentials are linked to a single profile. In these cases the profileId must not be sent. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.
Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
Response
A list of payment objects.