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

# Documentação PurinCash

> Como integrar pagamentos PIX, cartão, cripto e assinatura na PurinCash: referência da API, webhooks e um sandbox pra testar o fluxo inteiro sem mover dinheiro.

A PurinCash é um gateway de pagamento. A API existe pra você cobrar sem construir a
parte difícil: integração bancária, conciliação, retentativa de webhook, controle de
saldo.

O ciclo é sempre o mesmo, e vale entender ele antes de escrever qualquer linha:

1. **Você cria a cobrança** com o valor e, se quiser, a URL que vai receber o aviso.
2. **A resposta traz o que o cliente precisa pra pagar.** O formato muda conforme o
   meio: PIX volta como código copia e cola, cartão como URL de checkout hospedado,
   cripto como endereço de carteira.
3. **O cliente paga.** Você não participa desse passo, e é de propósito: dado de
   cartão e chave PIX nunca passam pelo seu servidor.
4. **A gente avisa.** Um `POST` assinado na sua URL, o valor entra no seu saldo, e o
   status fica disponível por consulta pra você conferir quando quiser.

Do passo 2 em diante é igual nos quatro meios de pagamento, incluindo o formato do
webhook. Aprender um é aprender todos.

A API é REST sobre JSON e autentica com um header. Não existe SDK próprio pra instalar
nem biblioteca obrigatória: qualquer linguagem que faça requisição HTTP integra, e os
exemplos daqui vêm em cURL, JavaScript, Python e PHP.

<CardGroup cols={2}>
  <Card title="Sua primeira cobrança" icon="rocket" href="/guias/primeira-cobranca" horizontal>
    Do zero ao PIX pago, em sandbox, sem gastar um centavo.
  </Card>

  <Card title="Referência da API" icon="code" href="/api-reference/introducao" horizontal>
    Os 29 endpoints, com playground pra testar na hora.
  </Card>

  <Card title="Webhooks" icon="bell" href="/webhooks/visao-geral" horizontal>
    Como a gente te avisa, e como você confere que fomos nós.
  </Card>

  <Card title="Antes de ir pra produção" icon="circle-check" href="/guias/producao" horizontal>
    A lista curta do que costuma quebrar no primeiro dia.
  </Card>
</CardGroup>

## O caminho mais curto

<Steps>
  <Step title="Pegue uma chave de teste">
    No painel, em [API e Desenvolvedores](https://purincash.com/dashboard/api), gere uma
    chave `ps_test_`. Ela é mostrada uma vez só.
  </Step>

  <Step title="Crie a cobrança">
    ```bash theme={null}
    curl -X POST https://api.purincash.com/v1/charges \
      -H "Authorization: Bearer ps_test_sua_chave" \
      -H "Content-Type: application/json" \
      -d '{ "valueCents": 1990, "description": "Plano Pro" }'
    ```
  </Step>

  <Step title="Mostre o brCode pro cliente">
    A resposta traz `pix.brCode`, que é o copia e cola, e `pix.qrCodeImage`, que é a
    imagem do QR.

    Com chave `ps_test_` esse código é falso de propósito (vem como
    `SANDBOX_PIX_...`). Ninguém consegue pagar, e é isso que você quer enquanto testa.
  </Step>

  <Step title="Marque como pago você mesmo">
    Como ninguém vai pagar um PIX de teste, quem confirma é você. Não tem fila nem
    aprovação de ninguém:

    ```bash theme={null}
    curl -X POST https://api.purincash.com/v1/sandbox/charges/psc_a1b2c3d4/simulate-paid \
      -H "Authorization: Bearer ps_test_sua_chave"
    ```
  </Step>

  <Step title="O webhook chega">
    A cobrança vira `paid` e a gente faz `POST` na sua `callbackUrl` com o evento, igual
    ao que acontece em produção. Em produção esse passo acontece sozinho quando o PIX
    cai de verdade.
  </Step>
</Steps>

## O que dá pra cobrar

<Columns cols={2}>
  <Card title="PIX" icon="bolt" href="/guias/pix">
    Copia e cola ou QR, confirmação em segundos. É o caminho padrão.
  </Card>

  <Card title="Cartão de crédito" icon="credit-card" href="/guias/cartao">
    Checkout hospedado. Você redireciona e recebe o resultado.
  </Card>

  <Card title="Assinatura" icon="repeat" href="/guias/assinaturas">
    PIX recorrente, semanal a anual, cobrança gerada sozinha.
  </Card>

  <Card title="Litecoin" icon="bitcoin" href="/guias/cripto">
    Endereço LTC com o valor convertido na cotação do momento.
  </Card>

  <Card title="Split" icon="chart-pie" href="/guias/splits">
    Divide o valor entre até 10 contas no momento em que o dinheiro entra.
  </Card>

  <Card title="Saque" icon="arrow-up-from-bracket" href="/guias/saques">
    Tira o saldo por PIX, LTC ou USDT sem sair do código.
  </Card>
</Columns>

## Dois detalhes que economizam uma tarde

<AccordionGroup>
  <Accordion title="O ambiente vem do prefixo da chave, não de um parâmetro" icon="key">
    `ps_live_` opera em produção e `ps_test_` em sandbox. Não existe campo de ambiente no
    body nem na URL. Os dados são isolados: chave de teste nunca enxerga cobrança real, e
    o contrário também vale. Detalhes em [Ambientes](/guias/ambientes).
  </Accordion>

  <Accordion title="Existem dois tipos de produto com o mesmo nome" icon="box">
    `GET /v1/products` lista os produtos de cobrança criados pela API.
    `GET /v1/store/products` lista os produtos da sua loja do Discord. São coleções
    separadas, então a primeira pode devolver lista vazia com a loja cheia. O
    [guia de produtos](/guias/produtos) explica quando usar cada uma.
  </Accordion>
</AccordionGroup>

<Note>
  Integrando com ajuda de IA? Esta documentação inteira existe em texto puro em
  [docs.purincash.com/llms-full.txt](https://docs.purincash.com/llms-full.txt), gerado a
  partir destas páginas. Cole no seu assistente e ele responde sobre a API sem inventar
  endpoint.
</Note>

<Card title="Dúvida no meio da integração?" icon="discord" href="https://discord.gg/8eyQQFZZxY" horizontal>
  O suporte fica no Discord, com gente que mexe na API. Traga o código HTTP, o corpo do
  erro e o `paymentId`.
</Card>