Understanding Responses and Errors

Inkress speaks JSON fluently. Each response has a simple format to tell you if everything went well.

Success responses

{
  "state": "ok",
  "data": {
    "id": 101,
    "name": "Success!"
  }
}

Error responses

{
  "state": "error",
  "data": {
    "reason": "Invalid credentials"
  }
}

Or field-level errors:

{
  "state": "error",
  "data": {
    "email": ["is required"]
  }
}

Pagination

If you’re listing lots of things, Inkress paginates:

{
  "page_info": {
    "current_page": 1,
    "total_pages": 3,
    "total_entries": 45,
    "page_size": 20
  }
}

➡️ Use ?page=2&limit=20 to move between pages.

Quick fixes

• 401: Check your JWT or Client-Id.

• 404: The item doesn’t exist (or belongs to another merchant).

• 422: Validation failed — read data for clues.

• 429: Too many requests — wait a bit.