Get Store ID
API ExplorerLists the ACTIVE stores in the token scope with their ACTIVE TPNs. Use store_id from here in the customer and invoice requests.
Query Parameters
page?integer
Page number. Whole number from 1 to 100000.
Default
1Range
1 <= value <= 100000size?integer
Number of stores per page. Whole number from 1 to 100.
Default
50Range
1 <= value <= 100Header Parameters
token*string
Authentication token generated using the API Key and Secret Key. Required for all API requests.
This API works exclusively with merchant API Key and Secret Key credentials and cannot be used with ISO credentials.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/?page=1&size=50" \ -H "token: your-access-token-here"{
"data": {
"stores": [
{
"store_id": "2ea4ed13b8fc",
"dba": "PAYARC EMV Debit",
"address1": "103 MASON ST",
"address2": null,
"city": "Greenwich",
"state": "CT",
"zip_code": "06830",
"tpns": []
},
{
"store_id": "05cbaac8502f",
"dba": "SAIK",
"address1": "test",
"address2": null,
"city": "che",
"state": "TN",
"zip_code": "62171",
"tpns": [
"247525547632",
"247525766573",
"247525973625"
]
}
],
"pagination": {
"page": 1,
"size": 50,
"total": 2
}
},
"message": "Stores retrieved successfully",
"response_code": "SUCCESS",
"status_code": 200,
"request_id": "TEST-20261008184025-PPUUVT",
"timestamp": "2026-10-08T13:10:25.681Z"
}{
"data": null,
"message": "Validation failed",
"response_code": "VALIDATION_ERROR",
"status_code": 400,
"request_id": "TEST-20261008184027-VJZVKM",
"timestamp": "2026-10-08T13:10:27.915Z",
"errors": [
{
"field": "size",
"messages": [
"size must be at most 100"
]
}
]
}{
"data": null,
"message": "Authentication failed",
"response_code": "UNAUTHORIZED",
"status_code": 401,
"request_id": "TEST-20261008131029-ZVCBLA",
"timestamp": "2026-10-08T13:10:29.405Z"
}{
"message": "Too many requests, please try again in a minute"
}{
"data": null,
"message": "Internal server error",
"response_code": "INTERNAL_SERVER_ERROR",
"status_code": 500,
"request_id": "<generated per request>",
"timestamp": "<ISO 8601 time>"
}