Developers

Search for documents

Dev

Stores

Operations related to stores

All endpoints require a JWT Bearer token in the Authorization header; most also require an API key in the X-API-KEY header.

GET `/v1/stores/{id}`

Get a specific store by ID

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	The storeId field
`enriched`	query	`boolean`	No	Include payment processor store info in the response
`selectFields`	query	`string`	No	Choose specific fields to include in the response (comma-separated). If provided, excludeFields will be ignored.
`excludeFields`	query	`string`	No	Exclude specific fields from the response (comma-separated).
`populateOptions`	query	`string`	No	Include related data in query results using a JSON object.

Responses

Status	Description
`200`	Store details retrieved successfully

GET `/v1/stores`

Get a list of stores with pagination

Parameters

Name	In	Type	Required	Description
`limit`	query	`integer`	Yes	Maximum number of records to return. Starts from 1 to 1000.
`page`	query	`integer`	Yes	Page number to retrieve, starting from 0.
`selectFields`	query	`string`	No	Choose specific fields to include in the response (comma-separated). If provided, excludeFields will be ignored.
`excludeFields`	query	`string`	No	Exclude specific fields from the response (comma-separated).
`filter`	query	`string`	No	JSON object representing filter criteria in MongoDB Query Language (MQL) format.
`sort`	query	`string`	No	JSON object representing sort criteria in MongoDB Query Language (MQL) format.
`populateOptions`	query	`string`	No	Include related data in query results using a JSON object.

Responses

Status	Description
`200`	Successfully retrieved a paginated list of stores.

Examples

GET `/v1/stores`

curl "https://api.valpay.com/v1/stores?limit=10&page=0&selectFields=name,address,merchantId" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

curl "https://api.valpay.com/v1/stores?limit=10&page=0&selectFields=name,address,merchantId" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

curl "https://api.valpay.com/v1/stores?limit=10&page=0&selectFields=name,address,merchantId" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

Response 200 (illustrative):

{
  "data": [
    {
      "_id": "665f1e2a9c8b4a0012d3e4b1",
      "name": "Main Street Store",
      "merchantId": "665f1e2a9c8b4a0012d3e4f5",
      "address": { "city": "Austin", "country": "US" }
    }
  ],
  "total": 23,
  "page": 0,
  "limit": 10
}

{
  "data": [
    {
      "_id": "665f1e2a9c8b4a0012d3e4b1",
      "name": "Main Street Store",
      "merchantId": "665f1e2a9c8b4a0012d3e4f5",
      "address": { "city": "Austin", "country": "US" }
    }
  ],
  "total": 23,
  "page": 0,
  "limit": 10
}

{
  "data": [
    {
      "_id": "665f1e2a9c8b4a0012d3e4b1",
      "name": "Main Street Store",
      "merchantId": "665f1e2a9c8b4a0012d3e4f5",
      "address": { "city": "Austin", "country": "US" }
    }
  ],
  "total": 23,
  "page": 0,
  "limit": 10
}

GET `/v1/stores/{id}`

curl "https://api.valpay.com/v1/stores/665f1e2a9c8b4a0012d3e4b1?enriched=true" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

curl "https://api.valpay.com/v1/stores/665f1e2a9c8b4a0012d3e4b1?enriched=true" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

curl "https://api.valpay.com/v1/stores/665f1e2a9c8b4a0012d3e4b1?enriched=true" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

Response 200: the store object, enriched with payment processor store info.

Try it out