Skip to main content
GET
/
merchants

​
Endpoint

GET https://api.digitzs.com/merchants

​
Overview

Use this endpoint to retrieve a paginated list of all merchant accounts associated with your application.

​
Authentication

HeaderValueRequired
x-api-keyYour API keyYes
AuthorizationBearer {appToken}Yes
appIdYour application IDYes

​
Query Parameters

​
limit
integer
Number of results per page (default: 25, max: 100)
​
offset
integer
Number of results to skip for pagination (default: 0)
​
status
string
Filter by status: active, pending, suspended, closed

​
Response

​
Success Response (200 OK)

{
  "links": {
    "self": "https://api.digitzs.com/merchants?limit=25",
    "next": "https://api.digitzs.com/merchants?limit=25&offset=25"
  },
  "data": [
    {
      "type": "merchants",
      "id": "merchant_abc123",
      "attributes": {
        "accountName": "Acme Corporation",
        "accountType": "business",
        "status": "active",
        "createdAt": "2024-01-15T10:00:00Z",
        "email": "info@acme.com"
      }
    },
    {
      "type": "merchants",
      "id": "merchant_xyz789",
      "attributes": {
        "accountName": "Bob's Shop",
        "accountType": "personal",
        "status": "active",
        "createdAt": "2024-01-10T14:30:00Z",
        "email": "bob@shop.com"
      }
    }
  ],
  "meta": {
    "total": 156,
    "limit": 25,
    "offset": 0,
    "hasMore": true
  }
}

​
Code Examples

curl -X GET "https://api.digitzs.com/merchants?limit=25" \
  -H "x-api-key: your-api-key" \
  -H "Authorization: Bearer your-app-token" \
  -H "appId: your-app-id"

​
Next Steps

Create Merchant

Create a new merchant account