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

# API MoneyDev

> Uma API REST para o Brasil: cadastre clientes, modele o que você vende como produtos e ofertas e receba pagamentos Pix por um checkout hospedado.

A MoneyDev é um gateway de pagamentos para o Brasil. A API REST permite cadastrar clientes, modelar o que você vende como **produtos** e **ofertas** e abrir sessões de **checkout** hospedadas onde o comprador paga com Pix. A comunicação é em JSON sobre HTTPS, com autenticação por tokens de acesso OAuth 2.0.

<CardGroup cols={2}>
  <Card title="Início rápido" icon="rocket" href="/quickstart">
    Do token ao checkout pago em alguns comandos `curl`.
  </Card>

  <Card title="Autenticação" icon="key" href="/authentication">
    Credenciais de cliente OAuth 2.0, escopos e validade do token.
  </Card>

  <Card title="Erros" icon="triangle-exclamation" href="/api-reference/errors">
    O objeto de erro, códigos de status e IDs de requisição.
  </Card>

  <Card title="Checkouts" icon="cart-shopping" href="/api-reference/checkouts/create">
    Abra um checkout e receba o pagamento.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/webhooks/overview">
    Seja avisado quando um pagamento é confirmado, recusado ou estornado.
  </Card>
</CardGroup>

## URL base

```text theme={null}
https://api.moneydev.com.br
```

Os endpoints de autenticação e de serviço ficam na raiz; todo recurso de negócio fica sob o prefixo `/v1`.

| Caminho | Função |
| - | - |
| `POST /oauth/token` | Troca as credenciais de cliente por um token de acesso |
| `GET /.well-known/oauth-authorization-server` | Metadados do servidor de autorização OAuth |
| `GET /.well-known/jwks.json` | Chaves públicas que assinam os tokens de acesso |
| `GET /health` | Verificação de saúde do serviço (sem autenticação) |
| `/v1/*` | Clientes, produtos, ofertas e checkouts |

## Requisições e respostas

A API é REST sobre HTTPS com corpos em JSON. Envie `Content-Type: application/json` em requisições `POST` e `PATCH` — a única exceção é `POST /oauth/token`, que usa `application/x-www-form-urlencoded` (veja [Autenticação](/authentication)). Campos desconhecidos no corpo são rejeitados com `400`, não ignorados.

| Verbo | Uso |
| - | - |
| `GET` | Consultar um recurso ou listar recursos |
| `POST` | Criar um recurso |
| `PATCH` | Atualizar um recurso |

Respostas de sucesso usam `2xx` (criações retornam `201`, o resto `200`); falhas retornam `4xx`/`5xx` com um [objeto de erro](/api-reference/errors) estruturado. Recursos individuais têm um campo `object` com o tipo; coleções retornam um [objeto de lista](/api-reference/pagination).

**Versionamento** — a versão atual é `v1`, no caminho da URL. Mudanças aditivas entram na `v1` sem aviso, então trate as respostas de forma tolerante.

## IDs de recurso

IDs são strings com um prefixo de tipo e um UUID, ex. `cus_9b2c4f1a-3d5e-4a7b-8c9d-1e2f3a4b5c6d`.

| Prefixo | Objeto |
| - | - |
| `cus_` | Cliente |
| `prod_` | Produto |
| `offer_` | Oferta |
| `checkout_` | Sessão de checkout |
| `item_` | Item de checkout |
| `seller_` | Seller (sua conta) |
| `client_` | Cliente de API |

## Valores monetários

Valores são inteiros na **unidade menor** da moeda (centavos para BRL). `R$ 49,90` é `4990`. Códigos de moeda seguem o ISO 4217 em maiúsculas — a MoneyDev liquida em `BRL`.

## IDs de requisição

Toda resposta traz o header `X-Request-Id`, e os corpos de erro repetem esse valor em `error.request_id`. Informe-o ao acionar o [suporte](mailto:support@moneydev.com.br).

## Uma integração típica

<Steps>
  <Step title="Obtenha um token de acesso">
    Troque suas credenciais de cliente em `POST /oauth/token`. Veja [Autenticação](/authentication).
  </Step>

  <Step title="Crie um produto e sua oferta">
    Um [produto](/api-reference/products/create) é o que você vende; uma [oferta](/api-reference/offers/create) é um preço específico dele.
  </Step>

  <Step title="Abra um checkout">
    [Crie um checkout](/api-reference/checkouts/create) para uma oferta. A resposta inclui uma `checkout_url`.
  </Step>

  <Step title="Envie o comprador para pagar">
    Redirecione-o para a `checkout_url`, a página hospedada onde ele paga com Pix. Consulte [o checkout](/api-reference/checkouts/retrieve) até o `status` ser `completed`, ou assine o webhook [`payment.succeeded`](/webhooks/overview) para ser avisado — mantendo a consulta como reconciliação.
  </Step>
</Steps>


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