Cookie Consent by Free Privacy Policy Generator Update cookies preferences

This endpoint retrieves a collection of payments along with their order details.

Successful Response (200)

Returns the matching Payment objects, enclosed in a Pagination object.

Connection Timeouts

TimeoutTime (Seconds)


In addition to the GET Errors applicable to all GET endpoints, the following errors are specific to List Payments:

HTTP Status CodeerrorCodeDescription
Unprocessable Entity
errorAn invalid query param was provided.

For example, a value for limit was provided, but was less than 1 or more than 250.
Internal Server Error
errorThis is usually caused by sending a fromCreatedDate or toCreatedDate in an invalid format. Please ensure the dash and colon characters are included, and any plus characters are URL-encoded. See Example Request 1.

Also, for the array parameters (ids, tokens, merchantReferences and statuses), do not use comma-separated values or square brackets. Instead, include each parameter multiple times, as needed. See Example Request 2.

Example Request 1

The following example searches for all Clearpay Orders placed within two timestamps, using a local timezone. Note that the plus character must be URL-encoded.



The request that is automatically generated by Readme appears as though it URL-encodes the Query Params. However, the request that is actually delivered to Clearpay when clicking the "Try It" button does not include any URL-encoding.

Please specifically replace "+" characters with "%2b" when testing a fromCreatedDate or toCreatedDate with a timezone ahead of UTC.

curl \
  -H 'Authorization: Basic <Base64EncodedCredentials>' \
  -H 'User-Agent: <MyUserAgent>' \
  -H 'Accept: application/json'

Example Request 2

The following example searches for all Clearpay Orders matching a list of tokens. Note that the tokens parameter is included several times, once for each token.

curl \
  -H 'Authorization: Basic <Base64EncodedCredentials>' \
  -H 'User-Agent: <MyUserAgent>' \
  -H 'Accept: application/json'
Click Try It! to start a request and see the response here!