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

# Get OpenAPI spec

> Referencia detallada para GET /openapi.json.

## Uso

Descarga el contrato OpenAPI publico para generar clientes, validar tipos y darle contexto exacto a herramientas internas o agentes.

## Antes de llamar

| Tema             | Detalle                                                                            |
| ---------------- | ---------------------------------------------------------------------------------- |
| Metodo           | `GET`                                                                              |
| Ruta             | `/openapi.json`                                                                    |
| Auth             | Bearer API key del ambiente correcto.                                              |
| Scope            | No hay scope explicito en la spec publica; aplica el acceso del tenant y ambiente. |
| Idempotencia     | No aplica para lecturas.                                                           |
| Guia relacionada | [API Reference overview](/api-reference/overview)                                  |

## Patron recomendado

* Descarga la spec desde tu CI o tooling local.
* Genera tipos o clientes con tu herramienta OpenAPI preferida.
* Vuelve a generar clientes cuando cambie la version del contrato.

## Ejemplo minimo

```bash terminal theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -sS "https://api.simplepay.mx/openapi.json" \
  -H "Authorization: Bearer $SIMPLEPAY_API_KEY"
```

## Errores a manejar

* `400` indica payload, parametros o estado invalido.
* `401` o `403` indican API key, ambiente o scopes incorrectos.
* `429` y `5xx` se pueden reintentar con backoff; en writes conserva la misma idempotency key.

## Contrato OpenAPI

El playground, parametros, body y respuestas de abajo salen de `/openapi.json`. Si el contrato cambia, actualiza la spec y regenera esta pagina.


## OpenAPI

````yaml openapi.json GET /openapi.json
openapi: 3.1.0
info:
  title: SimplePay API
  version: '2026-06-13'
servers:
  - url: https://api.simplepay.mx
security:
  - SimplePayApiKey: []
paths:
  /openapi.json:
    get:
      summary: Get OpenAPI spec
      operationId: getOpenApiSpec
components:
  securitySchemes:
    SimplePayApiKey:
      type: http
      scheme: bearer

````