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ênciaAutenticação
A API da RecebeAqui utiliza autenticação por Bearer Token. Você precisa incluir seu token de API no cabeçalho de todas as requisições.
Como obter seus Tokens de API
- Faça login em sua conta RecebeAqui
- Acesse a área de API no seu perfil
- Gere ou copie seus tokens de API
- Utilize tokens diferentes para produção e sandbox
Cabeçalho de Autenticação
Inclua o token no cabeçalho Authorization de todas as requisições:
Authorization: Bearer {seu_token_de_api}
⚠️ Importante
Mantenha seus tokens de API em segurança. Nunca os exponha em código frontend ou repositórios públicos.Exemplo de Requisição
Aqui está um exemplo de como fazer uma requisição autenticada:
curl -X GET "https://api.recebeaqui.com/v2/api/checkout?id=123e4567-e89b-12d3-a456-426614174000" \
-H "Authorization: Bearer {seu_token_de_api}" \
-H "Content-Type: application/json"
const response = await fetch('https://api.recebeaqui.com/v2/api/checkout?id=123e4567-e89b-12d3-a456-426614174000', {
method: 'GET',
headers: {
'Authorization': 'Bearer {seu_token_de_api}',
'Content-Type': 'application/json'
}
});
const data = await response.json();
using System.Net.Http.Headers;
var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "{seu_token_de_api}");
var response = await client.GetAsync("https://api.recebeaqui.com/v2/api/checkout?id=123e4567-e89b-12d3-a456-426614174000");
var content = await response.Content.ReadAsStringAsync();
Ambientes
| Ambiente | URL Base | Descrição |
|---|---|---|
| Produção | https://api.recebeaqui.com/v2 |
Ambiente para transações reais |
| Sandbox | https://api.recebeaqui.com/v2 |
Ambiente para testes (sem cobrança real) |
Atenção: O Ambiente é definido pelo TOKEN de API
O ambiente de execução depende do Token de API usado nas requisições:
• Token Sandbox: ambiente de testes com dados fictícios.
• Token Produção: ambiente real com transações reais.
O ambiente em que suas requisições são executadas seja de testes (Sandbox) ou real (Produção) é definido pelo Token de API que você utiliza em cada requisição.
Testando Pagamentos no Sandbox
Para realizar testes de pagamentos no ambiente sandbox, utilize os seguintes cartões de teste:
Cartões de Teste
Pagamentos com Sucesso
Pagamentos Negados
Dados Complementares para Teste
- Data de validade: Qualquer data futura mês/ano (ex: 01/2026)
- CVV: Qualquer número de 3 dígitos (ex: 123)
- Nome do portador: Qualquer nome
💡 Como testar
- Crie um checkout usando seu token sandbox
- Acesse o link de pagamento gerado
- Use o cartão
4242 4242 4242 4242para simular aprovação - Use qualquer outro número para simular recusa
Erros de Autenticação
Se o token estiver ausente, expirado ou inválido, você receberá um erro 401:
{
"title": "Unauthorized",
"status": 401,
"detail": "Token de autenticação inválido, expirado ou ausente."
"errors": {}
}