> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyparrow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get payroll limits

> Returns the caps in force for this merchant and how much of today's allowance is used.



## OpenAPI

````yaml /openapi.json get /payroll/limits
openapi: 3.0.0
info:
  description: |-
    Hyparrow payment gateway API. Authenticate server-to-server
    requests with your API key credentials.
  title: Hyparrow API
  termsOfService: https://hyparrow.cloud/terms
  contact:
    name: Hyparrow Support
    email: support@hyparrow.com
  version: '1.0'
servers:
  - url: https://api.hyparrow.cloud/api/v1
    description: Production
  - url: https://sandbox.hyparrow.cloud/api/v1
    description: Sandbox - simulated providers, test keys only, no real money
security: []
paths:
  /payroll/limits:
    get:
      tags:
        - Payroll
      summary: Get payroll limits
      description: >-
        Returns the caps in force for this merchant and how much of today's
        allowance is used.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
      security:
        - ApiKeyAuth: []
          ApiSecretAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Your API key, sent in the "X-API-Key" header. Every endpoint needs the
        key and the secret together; a request carrying only one of the pair is
        rejected with 401.
      type: apiKey
      name: X-API-Key
      in: header
    ApiSecretAuth:
      description: >-
        Your API secret, sent in the "X-API-Secret" header alongside the API key
        on every request.
      type: apiKey
      name: X-API-Secret
      in: header

````