ONLINE BANK / DESENVOLVEDORES
Documentação da API
de cobranças Online Bank
Crie cobranças a partir do seu sistema usando a API Online Bank.
Antes de começar
- Cadastre sua empresa e conclua a verificação cadastral.
- Após a aprovação, acesse Developers no painel.
- Gere sua chave e guarde-a exclusivamente no servidor. Ela é exibida uma única vez.
Criar uma cobrança
Use o endereço deste site seguido de /api/public/v1/charges. Envie a chave no cabeçalho de autorização.
POST /api/public/v1/charges
Authorization: Bearer SUA_CHAVE
Content-Type: application/json
{
"method": "pix",
"amount": 149.90,
"customer_name": "Cliente de exemplo",
"description": "Pedido de exemplo"
}| Campo | Formato | Descrição |
|---|---|---|
| method | pix | cartao | boleto | Método de pagamento |
| amount | Número positivo | Valor da cobrança em reais |
| customer_name | Texto | Nome do cliente |
| customer_email | E-mail opcional | E-mail do cliente |
| customer_document | Texto opcional | Documento do cliente |
| description | Texto opcional | Identificação da cobrança |
Resposta e processamento
A resposta traz os dados da cobrança criada, incluindo identificação, taxa e valor líquido. Chaves inválidas ou revogadas não têm acesso.
O processamento automático depende da integração com um processador de pagamentos. Criar uma cobrança não significa que ela foi paga.
Webhooks
A confirmação pelo processador usa verificação de assinatura. Não envie confirmações do navegador. A configuração depende do processador escolhido e ainda não há um serviço de notificações de saída para o seu sistema.