> ## Documentation Index
> Fetch the complete documentation index at: https://docs.purin.cash/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.

> [card] [Sua primeira cobrança](https://docs.purin.cash/guias/primeira-cobranca.md)
>
> Do zero ao PIX pago, em sandbox, sem gastar um centavo.

> [card] [Referência da API](https://docs.purin.cash/api-reference/introducao.md)
>
> Os 35 endpoints, com playground pra testar na hora.

> [card] [Webhooks](https://docs.purin.cash/webhooks/visao-geral.md)
>
> Como a gente te avisa, e como você confere que fomos nós.

> [card] [Antes de ir pra produção](https://docs.purin.cash/guias/producao.md)
>
> A lista curta do que costuma quebrar no primeiro dia.

## O caminho mais curto

**1. Pegue uma chave de teste**

No painel, em [Equipe & API → Developer API](https://purin.cash/dashboard/api), gere uma
chave `ps_test_`. Ela é mostrada uma vez só.

**2. Crie a cobrança**

```bash theme={null}
curl -X POST https://api.purin.cash/v1/charges \
  -H "Authorization: Bearer ps_test_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{ "valueCents": 1990, "description": "Plano Pro" }'
```

**3. 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.

**4. 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.purin.cash/v1/sandbox/charges/psc_a1b2c3d4/simulate-paid \
  -H "Authorization: Bearer ps_test_sua_chave"
```

**5. 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.

## O que dá pra cobrar

> [card] [PIX](https://docs.purin.cash/guias/pix.md)
>
> Copia e cola ou QR, confirmação em segundos. É o caminho padrão.

> [card] [Cartão de crédito](https://docs.purin.cash/guias/cartao.md)
>
> Checkout hospedado. Você redireciona e recebe o resultado.

> [card] [Assinatura](https://docs.purin.cash/guias/assinaturas.md)
>
> PIX recorrente, semanal a anual, cobrança gerada sozinha.

> [card] [Litecoin](https://docs.purin.cash/guias/cripto.md)
>
> Endereço LTC com o valor convertido na cotação do momento.

> [card] [Split](https://docs.purin.cash/guias/splits.md)
>
> Divide o valor entre até 10 contas no momento em que o dinheiro entra.

> [card] [Subcontas](https://docs.purin.cash/guias/subcontas.md)
>
> Um saldo por cliente seu, creditado a cada venda, com extrato.

> [card] [Saque](https://docs.purin.cash/guias/saques.md)
>
> Tira o saldo por PIX, LTC ou USDT sem sair do código.

## Dois detalhes que economizam uma tarde

> [accordion] O ambiente vem do prefixo da chave, não de um parâmetro
>
> `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](https://docs.purin.cash/guias/ambientes.md).

> [accordion] Existem dois tipos de produto com o mesmo nome
>
> `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](https://docs.purin.cash/guias/produtos.md) explica quando usar cada uma.

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

> [card] [Dúvida no meio da integração?](https://discord.gg/8eyQQFZZxY)
>
> O suporte fica no Discord, com gente que mexe na API. Traga o código HTTP, o corpo do
> erro e o `paymentId`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.