Transaction pagination
Pagination is supported for the transactions endpoint. If there are more results available than are returned initially, a pagination cursor is also returned in the response. Even if you request all the transactions, you might only receive a subset initially, because there is a limit of the data that will be returned with each call. If there are more results that the initial page can hold, you will get a pagination property back which you are expected to use in the subsequent call.
Request: GET https://api.cls.oob.ockto.cloud/enrichment/transactions
Response:
{
"data": [
{
"transactionId": "cecf47e8-5a33-5e6c-bdac-8a0749c09a9e",
...,
....
},
{
"transactionId": "7e845cfc-5457-48fd-b94f-515dfd2fb6e9",
...,
....
}
,
],
"pagination": {
"next": "eyJ2YWx1ZURhdGUiOiIyMDIyLTEwLTAzIiwidHJhbnNhY3Rpb25JZCI6ImNlY2Y0N2U4LTVhMzMtNWU2Yy1iZGFjLThhMDc0OWMwOWE5ZSIsInVzZXJJZCI6ImRlZmF1bHRfZGVmYXVsdF9wb3N0bWFuLXVzZXItMTY5NjMzMjQ0MDYwOCJ9"
}
}
The response consists of a 'data' part, i.e. the initial result set of transactions, and optionally a 'pagination/next' attribute. In case a pagination/next attribute is returned, its content can be used in the following call to retrieve the next page of transaction results. For example:
GET https://api.cls.oob.ockto.cloud/enrichment/transactions?offset=eyJ2YWx1ZURhdGUiOiIyMDIyLTEwLTAzIiwidHJhbnNhY3Rpb25JZCI6ImNlY2Y0N2U4LTVhMzMtNWU2Yy1iZGFjLThhMDc0OWMwOWE5ZSIsInVzZXJJZCI6ImRlZmF1bHRfZGVmYXVsdF9wb3N0bWFuLXVzZXItMTY5NjMzMjQ0MDYwOCJ9
This process should be repeated until the point where the response no longer contains a pagination/next property. This indicates that all the transaction data have been retrieved. For example:
{
"data": [
{
"transactionId": "cecf47e8-5a33-5e6c-bdac-8a0749c09a9e",
...,
....
},
{
"transactionId": "7e845cfc-5457-48fd-b94f-515dfd2fb6e9",
...,
....
}
,
],
"pagination": {
}
}