const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.platform.getstell.com/v1/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://api.platform.getstell.com/v1/transactions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.platform.getstell.com/v1/transactions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"transactions": [
{
"passId": "<string>",
"type": "PURCHASE",
"transactionDate": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"tapMode": "SINGLE_TAP",
"pointsSpent": 123,
"channel": "IN_STORE",
"instrument": "APPLE_VAS",
"remainingUsesBefore": 123,
"terminalId": "<string>",
"storeId": "<string>",
"reference": "<string>",
"pointsEarned": 123,
"statusReason": "<string>",
"remainingUsesAfter": 123,
"payment": {
"reference": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"method": "APPLE_PAY",
"pspReference": "<string>"
},
"additionalData": {},
"status": "APPROVED"
}
],
"nextToken": "<string>"
},
"requestId": "<string>"
}{
"requestId": "<string>",
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request parameters",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "FORBIDDEN",
"message": "Access denied to this resource",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred",
"details": {}
}
}List transactions
List the company’s transactions. passId, storeId and terminalId each narrow the list to one record’s transactions; only one applies, with passId taking precedence over storeId and storeId over terminalId. A list narrowed that way reads oldest first; the company-wide list reads newest first. type, startDate and endDate combine with any of them.
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.platform.getstell.com/v1/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://api.platform.getstell.com/v1/transactions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.platform.getstell.com/v1/transactions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"transactions": [
{
"passId": "<string>",
"type": "PURCHASE",
"transactionDate": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"tapMode": "SINGLE_TAP",
"pointsSpent": 123,
"channel": "IN_STORE",
"instrument": "APPLE_VAS",
"remainingUsesBefore": 123,
"terminalId": "<string>",
"storeId": "<string>",
"reference": "<string>",
"pointsEarned": 123,
"statusReason": "<string>",
"remainingUsesAfter": 123,
"payment": {
"reference": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"method": "APPLE_PAY",
"pspReference": "<string>"
},
"additionalData": {},
"status": "APPROVED"
}
],
"nextToken": "<string>"
},
"requestId": "<string>"
}{
"requestId": "<string>",
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request parameters",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "FORBIDDEN",
"message": "Access denied to this resource",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred",
"details": {}
}
}Authorizations
API key authentication. Include your API key as a Bearer token.
Example: Bearer sk_prod_xxxxxx
Get your API key from the Stell Dashboard.
Query Parameters
Maximum number of items to return (1-100). Defaults to 100.
Token for pagination
Only transactions of this type: PURCHASE, REDEMPTION, POINTS_ADJUSTMENT, SCAN_ONLY, CHECK_IN, CHECK_OUT, UNKNOWN, ONLINE, PASS_AND_PAYMENT, PASS_ONLY, PAYMENT_ONLY. Applied to each page after it is read, so a page can hold fewer than limit items while nextToken is still set.
Only transactions on or before this UTC ISO 8601 date-time, written with a Z suffix. Must not be before startDate.
Only transactions at this store. Ignored when passId is set; takes precedence over terminalId.
Only transactions from this terminal. Ignored when passId or storeId is set.
Only transactions on this pass. Takes precedence over storeId and terminalId.
Only transactions on or after this UTC ISO 8601 date-time, written with a Z suffix (for example 2024-03-15T00:00:00Z). An offset such as +02:00 is not converted to UTC.
Was this page helpful?