Contrato público da Nash

Base URL e respostas

Todas as rotas partem de https://app.nash.lat/api/v1. Sucessos usam data e listagens incluem pagination. As respostas não são armazenadas em cache.

{
  "data": [],
  "pagination": { "hasMore": false, "nextCursor": null }
}

GET /gateways

Retorna o gateway associado à chave, incluindo domínio, status, plano, marca e estado sanitizado das adquirentes. Não expõe credenciais, billing ou segredos.

curl https://app.nash.lat/api/v1/gateways \
  -H "Authorization: Bearer $NASH_API_KEY"

GET /checkout-links

Lista links em ordem decrescente. limit aceita de 1 a 100 e usa 25 por padrão. Passe nextCursor como cursor na próxima página.

POST /checkout-links

Cria uma oferta ativa em BRL. price é um inteiro positivo em centavos, limitado a 100.000.000. merchantId é opcional e deve pertencer ao mesmo tenant.

curl https://app.nash.lat/api/v1/checkout-links \
  -X POST \
  -H "Authorization: Bearer $NASH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Plano mensal","description":"Acesso por 30 dias","price":5999,"currency":"BRL"}'

GET, PATCH e DELETE /checkout-links/{id}

Consulte ou altere nome, descrição, preço e estado do link. DELETE desativa a oferta sem apagar transações ou histórico financeiro. Todas as respostas incluem a URL pública absoluta do gateway.

POST /pix

Cria uma cobrança usando checkoutLinkId ou um amount avulso em centavos. Informe exatamente um deles. couponCode é aceito somente com checkoutLinkId e participa do contrato idempotente. Reutilizar Idempotency-Key com valor-base, cupom, CPF ou externalReference diferentes retorna 409 IDEMPOTENCY_CONFLICT.

curl https://app.nash.lat/api/v1/pix \
  -X POST \
  -H "Authorization: Bearer $NASH_API_KEY" \
  -H "Idempotency-Key: pedido_2026_000001" \
  -H "Content-Type: application/json" \
  -d '{"amount":5999,"description":"Pedido 123","externalReference":"order_123","payer":{"name":"Cliente Exemplo","cpf":"CPF_VALIDO","email":"cliente@exemplo.com"}}'

GET /pix/{id}

Consulta a cobrança no mesmo gateway da API key e retorna estados da transação e do Pix, QR Code, expiração e data de pagamento. IDs de outro tenant respondem como não encontrados.

GET /transactions

Lista transações com limit, cursor e status opcional. Os status aceitos são pending, completed, failed, expired e refunded.

curl "https://app.nash.lat/api/v1/transactions?status=completed&limit=50" \
  -H "Authorization: Bearer $NASH_API_KEY"

GET /transactions/{id}

Consulta uma transação individual sem expor metadados internos do provedor. Use o evento assinado como gatilho e esta rota para reconciliação pelo ID retornado na criação.

OpenAPI executável

O documento oficial está em https://app.nash.lat/api/openapi. Use-o para gerar tipos, clientes e coleções de teste mantendo a versão v1 explícita.