---
title: "Get payin authorization limits"
method: GET
path: "/pay/limits"
tags: ["Payins"]
---

# Get payin authorization limits

`GET /pay/limits`

Retrieves the current authorization level, per-window limits, and volume totals for an
end-user participant on the authenticated platform. Optionally scoped to a specific
merchant when `merchant_participant_code` is supplied (the authenticated platform must
operate for that merchant).

## Query parameters

- `participant_code` string, required
- `merchant_participant_code` string

## Headers

- `X-SCX-SIGNED` string, required
- `X-SCX-TIMESTAMP` string, required

## Response `200`

Platform and (optionally) merchant payin limits.

- GetPayLimitsResponse
  - `message` object
    - `request_id` string — The unique identifier echoed from the request.
    - `participant_code` string — The shopper participant code.
    - `merchant_participant_code` string — The merchant participant code.
    - `merchant_classification` string — Classification of the merchant (e.g. NON-TRANSFERABLE-3).
    - `current_level` integer — Current authorization level for this participant (1–4).
    - `current_limits` PayCurrentLimit[] — Authorization limits for each time window at the current level.
      - `limit` string — The authorized limit for this window, expressed as a decimal string.
      - `spent` string — Amount spent within this window, expressed as a decimal string.
      - `remaining` string — Remaining capacity within this window, expressed as a decimal string.
      - `window` 'daily' | 'annual' | 'lifetime' — The time window this limit applies to.
    - `platform_totals` PayVolumeTotal[] — Aggregated transaction volume totals across the platform.
      - `window` 'daily' | 'annual' | 'lifetime' — The time window for this total.
      - `currency` string — Currency of the total amount.
      - `total_amount` string — Total transacted amount in this window, expressed as a decimal string.
      - `transaction_count` integer — Number of transactions in this window.
    - `merchant_totals` PayVolumeTotal[] — Aggregated transaction volume totals for the merchant.
      - `window` 'daily' | 'annual' | 'lifetime' — The time window for this total.
      - `currency` string — Currency of the total amount.
      - `total_amount` string — Total transacted amount in this window, expressed as a decimal string.
      - `transaction_count` integer — Number of transactions in this window.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/zerohash/apis/zerohash-api.md) · [All operations](https://skmtc.net/zerohash/apis/zerohash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zerohash/zerohash-api/revisions/8b647d934363/schema)