API RecebeAqui
Checkout
POST Criar Checkout GET Consultar Checkout PUT Cancelar Checkout POST Criar Checkout transparenteGerenciamento de Pagamentos
Cancelar Pagamento RealizadoAssinaturas/Recorrências
POST Criar Recorrência GET Consultar Recorrências GET Pagamentos da RecorrênciaComece por aqui
Bem-vindo à documentação da API da RecebeAqui. Esta API permite que você integre facilmente nossa solução de pagamentos em seu sistema, criando checkouts personalizados e gerenciando assinaturas.
URL Base
https://api.recebeaqui.com/v2Atenção: O ambiente é definido pelo TOKEN de API
O ambiente de execução depende do Token de API usado na autenticação:
• Token Sandbox: ambiente de testes com dados fictícios.
• Token Produção: ambiente real com transações reais.
Formato das Respostas
Todas as respostas da API são retornadas no formato JSON. Em caso de erro, será retornado um objeto com detalhes do problema:
{
"title": "Erro de validação",
"status": 400,
"detail": "Um ou mais campos possuem valores inválidos.",
"errors": {
"Value": ["O campo Value é obrigatório."],
"BillingType": ["O tipo da cobrança é inválido"]
}
}
Códigos de Status HTTP
| Código | Descrição |
|---|---|
| 200 | Sucesso - A requisição foi processada com sucesso |
| 400 | Erro de validação - Os dados enviados são inválidos |
| 401 | Não autorizado - Token de autenticação inválido, expirado ou ausente |
| 404 | Não encontrado - O item que você procurava não foi localizado |
| 500 | Erro interno - Erro no servidor |