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

# Introdução

> Guia principal da Integrations API da AXNPAY.

<Tip>
  Base URL de produção: <code>[https://api.axnpay.com.br/v1](https://api.axnpay.com.br/v1)</code>
</Tip>

## Guia de APIs

Use esta documentação para integrar:

* Geração de cobrança (CASHIN)
* Consulta de transações
* Transferências/saques (CASHOUT)
* Consulta de saldo
* Webhooks de atualização

## Fluxo recomendado

<AccordionGroup>
  <Accordion title="1. Autenticação" icon="key">
    Gere sua <code>sk\_live\_prod\_\*</code> no painel e use no header <code>Authorization: Bearer ...</code>.
  </Accordion>

  <Accordion title="2. Gerar transação PIX" icon="qrcode">
    Chame <code>POST /v1/integrations/create-transaction</code> e exiba o <code>pixCode</code> para pagamento.
  </Accordion>

  <Accordion title="3. Acompanhar status" icon="list-check">
    Consulte por <code>transactionId</code> no endpoint <code>GET /v1/integrations/list-transactions</code>.
  </Accordion>

  <Accordion title="4. Saques e comprovante" icon="arrow-right-arrow-left">
    Para saque, use <code>POST /v1/integrations/create-cashout</code>. Quando concluir, use o <code>receiptUrl</code> HTML.
  </Accordion>
</AccordionGroup>

## Acesso rápido

<CardGroup cols={2}>
  <Card title="Gerar transação PIX" icon="bolt" href="/api-reference/endpoint/create-transaction">
    Endpoint principal para criar cobranças.
  </Card>

  <Card title="Listar transações" icon="list" href="/api-reference/endpoint/list-transactions">
    Filtros, paginação e consulta pontual por UUID.
  </Card>

  <Card title="Solicitar transferência" icon="money-bills" href="/api-reference/endpoint/create-cashout">
    Crie saques com idempotência e validação de saldo.
  </Card>

  <Card title="Consultar saldo" icon="wallet" href="/api-reference/endpoint/get-balance">
    Retorna disponivel, reservas e total sacado.
  </Card>
</CardGroup>