Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,35 @@
}
]
},
{
"tab": "Para Lojistas",
"groups": [
{
"group": "Entenda o Produto",
"pages": [
"pages/concepts/overview",
"pages/concepts/checkout",
"pages/concepts/pix",
"pages/concepts/subscriptions",
"pages/concepts/saques",
"pages/concepts/taxas"
]
},
{
"group": "Guias Rápidos",
"pages": [
"pages/guides/primeiro-pagamento"
]
},
{
"group": "Ajuda",
"pages": [
"pages/faq/index",
"pages/glossario"
]
}
]
},
{
"tab": "Guias",
"groups": [
Expand Down
29 changes: 29 additions & 0 deletions pages/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ icon: 'key'
A **chave de API** é sua credencial de acesso à AbacatePay. Ela identifica sua conta e autoriza cada requisição enviada para a nossa API. **Sem uma chave válida, nenhum pedido será aceito.**
</Tip>

Toda requisição para a API da AbacatePay deve incluir sua chave no header `Authorization`. A chave também define o ambiente — uma chave de Dev mode simula transações, uma chave de Produção processa valores reais. Você não muda de URL para mudar de ambiente; muda a chave.

{/* <div style={{
position: "relative",
paddingBottom: "56.25%",
Expand Down Expand Up @@ -80,6 +82,33 @@ Ao criar ou gerenciar chaves no dashboard, você pode atribuir apenas as permiss

Cada endpoint da documentação indica qual permissão é necessária no topo da página.

## Troubleshooting

<AccordionGroup>
<Accordion title="401 Unauthorized — o que verificar">
Causas mais comuns, em ordem de frequência:

1. O header `Authorization: Bearer SUA_CHAVE` não está sendo enviado
2. A chave foi copiada com espaços extras ou caracteres invisíveis
3. A chave foi revogada no dashboard
4. Você está usando uma chave de Dev mode em uma URL que exige produção (ou vice-versa)

Para confirmar que a chave está funcionando, teste diretamente:
```bash
curl https://api.abacatepay.com/v2/stores/get \
-H "Authorization: Bearer SUA_CHAVE"
```
</Accordion>

<Accordion title="403 Forbidden — permissão ausente">
A chave existe e é válida, mas não tem a permissão para o recurso solicitado. Acesse o dashboard, edite a chave e adicione a permissão necessária. Consulte a tabela de permissões acima para saber qual adicionar.
</Accordion>

<Accordion title="Chave de Dev mode vs Produção — qual estou usando?">
No dashboard, as chaves de Dev mode têm um indicador visual. Se você não tem certeza, verifique o campo `devMode` em qualquer resposta da API — `true` significa Dev mode, `false` significa Produção.
</Accordion>
</AccordionGroup>

## Boas práticas de segurança

<Card horizontal>
Expand Down
94 changes: 94 additions & 0 deletions pages/concepts/checkout.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
title: 'O que é o Checkout?'
description: 'Entenda como funciona a cobrança por link e tela de pagamento da AbacatePay'
icon: 'cart-shopping'
---

## A ideia simples

Um **checkout** é a tela onde seu cliente finaliza o pagamento. É aquela página que aparece quando você clica em "Comprar" em uma loja online — com o resumo do pedido e as opções de pagamento.

Na AbacatePay, você não precisa construir essa tela. A gente gera ela automaticamente. Você só precisa dizer **o que está sendo vendido** e **qual o valor**.

---

## Como funciona na prática

<Steps>
<Step title="Você cria uma cobrança">
Pode ser pelo dashboard ou pela API. Você informa o produto e o valor.
</Step>
<Step title="A AbacatePay gera um link">
Um link único e seguro é criado. Ex: `https://app.abacatepay.com/pay/bill_abc123`
</Step>
<Step title="Você envia o link para o cliente">
Por WhatsApp, e-mail, Instagram — qualquer canal.
</Step>
<Step title="O cliente paga">
Ele escolhe PIX ou cartão e conclui o pagamento na tela da AbacatePay.
</Step>
<Step title="Você é notificado">
Recebe uma notificação imediata de que o pagamento foi confirmado.
</Step>
</Steps>

---

## Dois tipos de checkout

<CardGroup cols={2}>
<Card icon="arrow-up-right-from-square" title="Checkout Hospedado">
A tela de pagamento fica **no site da AbacatePay**. Você redireciona o cliente para lá e pronto. É o jeito mais rápido — zero configuração de interface.

**Ideal para:** quem quer começar rápido sem precisar de designer ou desenvolvedor.
</Card>

<Card icon="code" title="Checkout Transparente">
A tela de pagamento fica **dentro do seu site**. A AbacatePay processa nos bastidores, mas o cliente nunca sai da sua página.

**Ideal para:** quem quer uma experiência de compra mais profissional e integrada ao próprio site. Requer desenvolvimento.
</Card>
</CardGroup>

<Tip>
Se você está começando agora, use o **Checkout Hospedado**. É mais rápido e já funciona sem precisar de um desenvolvedor.
</Tip>

---

## Formas de pagamento aceitas

| Forma de pagamento | Disponível? |
|--------------------|-------------|
| PIX | ✅ Sim |
| Cartão de crédito | ✅ Sim |
| Boleto | ✅ Sim |
| Parcelamento (até 12x) | ✅ Sim, no cartão |

---

## Perguntas comuns

<AccordionGroup>
<Accordion title="O link de pagamento tem prazo de validade?">
Por padrão, o link não expira. Você pode configurar uma data de expiração ao criar a cobrança.
</Accordion>

<Accordion title="Meu cliente pode pagar mais de uma vez pelo mesmo link?">
Depende. Um link de pagamento comum (`ONE_TIME`) aceita apenas um pagamento. Se você quiser um link reutilizável, use um **Link de Pagamento** com `MULTIPLE_PAYMENTS` — ideal para doações ou pedidos avulsos.
</Accordion>

<Accordion title="Consigo personalizar a tela de pagamento com minha marca?">
Sim. Você pode configurar o nome, logo e cores da sua loja no dashboard, e eles aparecem automaticamente na tela de checkout.
</Accordion>

<Accordion title="O que acontece se o cliente não pagar?">
A cobrança fica com status `PENDING`. Você pode reenviar o link para o cliente a qualquer momento.
</Accordion>
</AccordionGroup>

---

<Card icon="rocket" title="Pronto para receber seu primeiro pagamento?" href="/pages/guides/primeiro-pagamento">
Siga o guia passo a passo e receba um pagamento real em minutos.
</Card>
94 changes: 94 additions & 0 deletions pages/concepts/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
title: 'O que é a AbacatePay?'
description: 'Entenda o que a AbacatePay faz pelo seu negócio — sem precisar ser desenvolvedor'
icon: 'store'
---

<Tip>
Esta seção é para quem quer **entender o produto** antes de integrar. Se você já é desenvolvedor e quer ir direto ao código, vá para [Guias → Autenticação](/pages/authentication).
</Tip>

## Em uma frase

A AbacatePay é uma plataforma que permite ao seu negócio **cobrar clientes pela internet** — via PIX, cartão de crédito ou boleto — e **receber esse dinheiro na sua conta**.

---

## O problema que a AbacatePay resolve

Imagine que você tem uma loja online, um serviço de assinatura ou vende infoprodutos. Para cobrar seus clientes, você precisaria:

- Contratar um banco ou adquirente (processo longo e burocrático)
- Lidar com dezenas de regras técnicas de cada meio de pagamento
- Construir toda a tela de pagamento do zero
- Gerenciar estornos, inadimplência, notificações...

A AbacatePay cuida de tudo isso por você. Você foca no seu produto; a gente cuida do dinheiro.

---

## O que você pode fazer com a AbacatePay

<CardGroup cols={2}>
<Card icon="link" title="Cobrar com um link">
Crie um link de pagamento em segundos e compartilhe com seu cliente — pelo WhatsApp, e-mail ou Instagram. Funciona como um carrinho de compras, sem precisar de site.
</Card>

<Card icon="qrcode" title="Cobrar via PIX">
Gere um QR Code PIX na hora. O cliente escaneia e o dinheiro cai em segundos, qualquer dia, qualquer hora.
</Card>

<Card icon="credit-card" title="Cobrar no cartão">
Aceite cartão de crédito com parcelamento em até 12x. Tudo em uma tela de pagamento pronta, sem precisar construir nada.
</Card>

<Card icon="rotate" title="Cobrar todo mês (assinaturas)">
Configure uma cobrança recorrente e a AbacatePay cobra seu cliente automaticamente todo mês — ideal para cursos, mentorias ou serviços com mensalidade.
</Card>

<Card icon="money-bill-transfer" title="Sacar seu dinheiro">
Quando quiser, transfira o saldo acumulado para sua conta bancária de forma simples e rápida.
</Card>

<Card icon="tag" title="Criar cupons de desconto">
Crie promoções com desconto percentual ou fixo e distribua para seus clientes.
</Card>
</CardGroup>

---

## Como funciona o fluxo de um pagamento

```
Seu cliente → Tela de pagamento → AbacatePay → Você recebe a confirmação → Saldo disponível
```

1. Você cria uma cobrança (via dashboard ou API)
2. A AbacatePay gera uma tela de pagamento segura
3. Seu cliente paga (PIX, cartão ou boleto)
4. Você recebe uma notificação automática
5. O valor entra no seu saldo na AbacatePay
6. Você saca para sua conta quando quiser

---

## Quem usa a AbacatePay?

- **Infoprodutores** que vendem cursos e mentorias
- **SaaS e startups** que cobram assinatura mensal
- **E-commerces** que precisam de checkout rápido
- **Freelancers** que querem um jeito simples de cobrar clientes
- **Lojas físicas** que querem aceitar pagamento online

---

## Próximos passos

<CardGroup cols={2}>
<Card icon="rocket" title="Receba seu primeiro pagamento" href="/pages/guides/primeiro-pagamento">
Um guia passo a passo para você receber um pagamento real sem escrever código.
</Card>
<Card icon="book-open-cover" title="Entenda cada produto" href="/pages/concepts/checkout">
Saiba mais sobre Checkout, PIX, Assinaturas e Saques em linguagem simples.
</Card>
</CardGroup>
80 changes: 80 additions & 0 deletions pages/concepts/pix.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: 'O que é o PIX?'
description: 'Como usar o PIX para receber pagamentos instantâneos pelo seu negócio'
icon: 'qrcode'
---

## PIX: o que todo mundo já sabe

O PIX é o sistema de pagamento instantâneo do Banco Central do Brasil. Funciona 24 horas por dia, 7 dias por semana, e o dinheiro cai na conta em segundos.

Você já usa PIX no dia a dia. Na AbacatePay, a gente traz isso para o seu negócio de forma profissional.

---

## Como a AbacatePay usa o PIX

A AbacatePay gera para você um **QR Code** ou um **código copia-e-cola** único para cada cobrança. Seu cliente escaneia ou cola no banco dele e o pagamento é confirmado em segundos.

<CardGroup cols={2}>
<Card icon="qrcode" title="QR Code">
Uma imagem que o cliente escaneia com o aplicativo do banco. Ideal para cobranças em sites, landing pages ou imagens no WhatsApp.
</Card>
<Card icon="copy" title="Copia-e-cola">
Um código de texto que o cliente cola no app do banco. Funciona em qualquer canal de texto — SMS, e-mail, chat.
</Card>
</CardGroup>

---

## Quando usar PIX vs outras formas de pagamento?

| | PIX | Cartão | Boleto |
|---|---|---|---|
| **Confirmação** | Segundos | Minutos a horas | 1-3 dias úteis |
| **Disponível** | 24/7 | 24/7 | Dias úteis |
| **Parcelamento** | Não | Sim (até 12x) | Não |
| **Taxa** | Menor | Maior | Média |
| **Cancelamento fácil** | Sim | Sim | Sim |

**Regra prática:**
- Produto de baixo valor ou urgente → PIX
- Produto de alto valor → cartão com parcelamento
- Cliente sem cartão → boleto

---

## O que acontece depois que o cliente paga?

1. O pagamento é confirmado em segundos
2. O valor entra no seu **saldo na AbacatePay**
3. Você recebe uma **notificação automática** (se tiver webhook configurado)
4. Quando quiser, você **saca** o valor para sua conta bancária

---

## Perguntas comuns

<AccordionGroup>
<Accordion title="O QR Code tem prazo de validade?">
Sim. Por padrão, o QR Code PIX expira em 30 minutos após a criação. Você pode configurar um prazo diferente ao criar a cobrança.
</Accordion>

<Accordion title="Posso cobrar qualquer valor via PIX?">
Sim, não há valor mínimo ou máximo definido pela AbacatePay. Limitações de valor do Banco Central podem se aplicar dependendo do banco do seu cliente.
</Accordion>

<Accordion title="Como sei se o pagamento foi confirmado?">
Você pode verificar o status da cobrança no dashboard. Se configurou webhooks, receberá uma notificação automática assim que o pagamento for confirmado.
</Accordion>

<Accordion title="E se o cliente errar o valor ao transferir?">
Se o cliente transferir um valor diferente do QR Code, o pagamento pode não ser confirmado automaticamente. Para evitar isso, sempre use o QR Code gerado pela AbacatePay — ele já tem o valor embutido.
</Accordion>
</AccordionGroup>

---

<Card icon="rocket" title="Quer gerar um PIX agora?" href="/pages/guides/primeiro-pagamento">
Siga o guia e gere seu primeiro QR Code em minutos.
</Card>
Loading