openapi: 3.1.1
info:
  title: NackTooManyRequests
  version: 2.0.0
  description: Container schemas fetched from beckn.yaml. This cannot be extended as it is a reserved
    schema in beckn protocol. Any additional properties added to this schema can only be made using its
    *Attributes property
  license:
    name: CC-BY-NC-SA 4.0 International
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    NackTooManyRequests:
      x-iri: https://schema.nfh.global/NackTooManyRequests/v2.0
      description: 'The synchronous rejection body returned when the responding NP has exceeded a request
        rate limit (AUT_RATE_LIMITED) or a policy-governed engagement capacity limit (POL_NP_CAPACITY_EXCEEDED).
        The caller MUST apply back-off before retrying. Implementations SHOULD include a Retry-After header
        on 429 responses.


        NackTooManyRequests appears as the response body for 429 responses on all endpoints.


        Relationship: Extends the Ack schema with status constrained to NACK and an error code constrained
        to the two retryable capacity/rate-limit codes.'
      type: object
      required:
      - message
      properties:
        message:
          type: object
          required:
          - status
          - messageId
          - error
          properties:
            status:
              type: string
              const: NACK
            messageId:
              type: string
              format: uuid
            error:
              $ref: https://schema.nfh.global/Error/v2.0/attributes.yaml#/components/schemas/Error
