> ## 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.

# Quickstart

> Integracao rapida com a API AXNPAY (CASHIN e CASHOUT).

## 1. Gere suas chaves

No painel AXNPAY, gere um par de chaves:

* `pk_live_prod_*` (publica)
* `sk_live_prod_*` (secreta)

<Warning>
  Nunca exponha a `sk_live_prod_*` no frontend. Use apenas no backend.
</Warning>

## 2. Crie uma cobranca PIX

```bash cURL theme={null}
curl -X POST "https://api.axnpay.com.br/v1/integrations/create-transaction" \
  -H "Authorization: Bearer sk_live_prod_SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 20.00,
    "description": "Pedido #1234",
    "productName": "Plano Pro",
    "clientName": "Matteo Augusto",
    "clientEmail": "axonaxolote@gmail.com",
    "clientPhone": "11999999999",
    "clientCpf": "52998224725",
    "tracking_parameters": {
      "utm_source": "meta_ads",
      "utm_medium": "cpc",
      "utm_campaign": "black_friday"
    },
    "referenceId": "77823bb5-3d84-4cbf-a2a4-43230cc3b1d1"
  }'
```

Resposta esperada (resumo):

* `transactionId` (UUID publico)
* `status` inicial (`PENDING`)
* `pixCode` (codigo copia e cola)

<Info>
  No fluxo padrao, nao envie `acquirer`, `pixKey` ou `pixKeyType`.
  Se voce usa ferramentas de atribuicao, envie `tracking_parameters` para receber esses dados tambem no webhook.
</Info>

## 3. Consulte status da transacao

```bash cURL theme={null}
curl "https://api.axnpay.com.br/v1/integrations/list-transactions?transactionId=77823bb5-3d84-4cbf-a2a4-43230cc3b1d1" \
  -H "Authorization: Bearer sk_live_prod_SEU_TOKEN"
```

Considere pago apenas quando `status = COMPLETED`.

## 4. Crie um saque (cashout)

```bash cURL theme={null}
curl -X POST "https://api.axnpay.com.br/v1/integrations/create-cashout" \
  -H "Authorization: Bearer sk_live_prod_SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 20.00,
    "pixKey": "12281502902",
    "pixKeyType": "CPF",
    "idempotencyKey": "e1de94c1-5692-48e1-a334-24b367ad76ff"
  }'
```

Notas:

* Taxa fixa de saque: `R$ 5.00`
* Valor liquido enviado: `amount - 5.00`
* Minimo: `amount > 5.00`

## 5. Use idempotencia sempre

`create-transaction`:

* Campo: `referenceId`
* Escopo: unico por usuario + tipo `CASHIN`

`create-cashout`:

* Campo: `idempotencyKey`
* Escopo: unico por usuario + tipo `CASHOUT`

Se voce repetir a mesma chave, a API devolve a mesma transacao sem duplicar operacao.
