All GET
based endpoints that return a list of resources support pagination. The default limit
is 20 and maximum is 250. The results are in descending order by default, newest first.
Query Parameters
Parameter | Type | Description |
---|---|---|
| integer | The number of results to retrieve. Must be between 1 and 250 (inclusive). Default value is 20. |
| integer | The position to start the results at. The first result has a position of 0. Default value is 0. |
Response
Parameter | Type | Description |
---|---|---|
| integer | The number of results that this page was limited to. |
| integer | The position of the first result retrieved for this page. |
| integer | The total number of results matching the given criteria. If this number is greater than |
| array | A page of matching results. This may be a subset of the total. |
curl https://api-sandbox.afterpay.com/v2/payments \
-H 'Authorization: Basic <Base64EncodedCredentials>' \
-H 'User-Agent: <MyUserAgent>' \
-H 'Accept: application/json'
{
"totalResults": 213,
"offset": 0,
"limit": 20,
"results": [
...
]
}