List Payments | Clearpay Documentation

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

Timeout	Time (Seconds)
Open	10
Read	20

Errors

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

HTTP Status Code	errorCode	Description
422 Unprocessable Entity	`error`	An invalid query param was provided. For example, a value for `limit` was provided, but was less than 1 or more than 250.
500 Internal Server Error	`error`	This 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.

Warning

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

1 curl https://global-api.afterpay.com/v2/payments?fromCreatedDate=2019-01-01T09:00:00.000%2b01:00&toCreatedDate=2019-01-01T17:00:00.000%2b01:00 \
2   -H 'Authorization: Basic <Base64EncodedCredentials>' \
3   -H 'User-Agent: <MyUserAgent>' \
4   -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.

1 curl https://api.eu-sandbox.afterpay.com/v2/payments?tokens=abcdefgh&tokens=ijklmnop \
2   -H 'Authorization: Basic <Base64EncodedCredentials>' \
3   -H 'User-Agent: <MyUserAgent>' \
4   -H 'Accept: application/json'

This endpoint retrieves a collection of payments along with their order details. ## Successful Response (200) Returns the matching [Payment](/payment-object) objects, enclosed in a [Pagination](/pagination) object. ## Connection Timeouts | Timeout | Time (Seconds) | | :------ | :------------- | | Open | 10 | | Read | 20 | ## Errors In addition to the [GET Errors](/get-errors) applicable to all GET endpoints, the following errors are specific to List Payments: | HTTP Status Code | errorCode | Description | | :-- | :-- | :-- | | **422** Unprocessable Entity | `error` | An invalid query param was provided. For example, a value for `limit` was provided, but was less than 1 or more than 250. | | **500** Internal Server Error | `error` | This 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](#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-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. <Warning title="Warning"> 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. </Warning> ```curl cURL curl https://global-api.afterpay.com/v2/payments?fromCreatedDate=2019-01-01T09:00:00.000%2b01:00&toCreatedDate=2019-01-01T17:00:00.000%2b01:00 \ -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 curl https://api.eu-sandbox.afterpay.com/v2/payments?tokens=abcdefgh&tokens=ijklmnop \ -H 'Authorization: Basic <Base64EncodedCredentials>' \ -H 'User-Agent: <MyUserAgent>' \ -H 'Accept: application/json' ```

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Query parameters

toCreatedDatestringOptional

An inclusive end date and time to search, in ISO 8601 format.

An inclusive end date and time to search, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.

fromCreatedDatestringOptional

An inclusive start date and time to search, in ISO 8601 format.

An inclusive start date and time to search, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.

limitintegerOptionalDefaults to 20

The number of results to retrieve from a query. Must be between 1 and 250 (inclusive).

offsetintegerOptionalDefaults to 0

The position on the page to start the results. The first result has a position of 0.

includeNextLinkbooleanOptionalDefaults to false

Will return a modified pagination object which includes a url to return the next page. The default value is false

tokenslist of stringsOptional

One or more order tokens to search for.

idslist of stringsOptional

One or more Clearpay Order IDs to search for.

merchantReferenceslist of stringsOptional

One or more Merchant Reference IDs to search for.

statuseslist of stringsOptional

One or more Clearpay Order Statuses to search for. Possible values include "APPROVED" and "DECLINED".

orderBystringOptionalDefaults to createdAt

A field to order results by. If provided, must be one of "createdAt", "id", "totalAmount", "merchantReference" or "email".

ascendingbooleanOptionalDefaults to false

true to order results in ascending order, or false for descending order.

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

Timeout	Time (Seconds)
Open	10
Read	20

Errors

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

HTTP Status Code	errorCode	Description
422 Unprocessable Entity	`error`	An invalid query param was provided. For example, a value for `limit` was provided, but was less than 1 or more than 250.
500 Internal Server Error	`error`	This 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.

Warning

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

cURL

1 curl https://global-api.afterpay.com/v2/payments?fromCreatedDate=2019-01-01T09:00:00.000%2b01:00&toCreatedDate=2019-01-01T17:00:00.000%2b01:00 \
2   -H 'Authorization: Basic <Base64EncodedCredentials>' \
3   -H 'User-Agent: <MyUserAgent>' \
4   -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.

1 curl https://api.eu-sandbox.afterpay.com/v2/payments?tokens=abcdefgh&tokens=ijklmnop \
2   -H 'Authorization: Basic <Base64EncodedCredentials>' \
3   -H 'User-Agent: <MyUserAgent>' \
4   -H 'Accept: application/json'

1	import requests
2
3	url = "https://global-api-sandbox.afterpay.com/v2/payments"
4
5	headers = {
6	"User-Agent": "User-Agent",
7	"Authorization": "Basic <username>:<password>"
8	}
9
10	response = requests.get(url, headers=headers)
11
12	print(response.json())

1	curl https://global-api.afterpay.com/v2/payments?fromCreatedDate=2019-01-01T09:00:00.000%2b01:00&toCreatedDate=2019-01-01T17:00:00.000%2b01:00 \
2	-H 'Authorization: Basic <Base64EncodedCredentials>' \
3	-H 'User-Agent: <MyUserAgent>' \
4	-H 'Accept: application/json'

1	curl https://api.eu-sandbox.afterpay.com/v2/payments?tokens=abcdefgh&tokens=ijklmnop \
2	-H 'Authorization: Basic <Base64EncodedCredentials>' \
3	-H 'User-Agent: <MyUserAgent>' \
4	-H 'Accept: application/json'

Successful Response (200)

Connection Timeouts

Errors

Example Request 1

Warning

Example Request 2

Authentication

Headers

Query parameters

Successful Response (200)

Connection Timeouts

Errors

Example Request 1

Warning

Example Request 2