Versão 1.0.0-draft.1
Referência da API
Cobranças por Pix, boleto e link de pagamento para ERPs e empresas. Gerada do contrato OpenAPI 3.1, que você pode importar no Postman, Insomnia ou no gerador de código da sua linguagem.
Conexões
Vínculo entre a conta digital de um cliente e um ERP parceiro.
Contas
Dados e capacidades da conta digital conectada.
Cobranças
Pix e boleto com baixa automática.
- GET/v1/chargesListar cobranças
- POST/v1/chargesCriar cobrança Pix ou boleto
- GET/v1/charges/{charge_id}Consultar cobrança
- POST/v1/charges/{charge_id}/cancelCancelar cobrança pendente
- POST/v1/charges/{charge_id}/refundsEstornar cobrança paga no cartão
- GET/v1/dunning-policyConsultar a régua de cobrança automática
- PUT/v1/dunning-policyConfigurar a régua de cobrança automática
Links de pagamento
Página hospedada com cartão em até 12x, Pix, boleto e carteiras digitais.
Webhooks
Endpoints que recebem eventos do gateway.
- GET/v1/webhook-endpointsListar endpoints de webhook
- POST/v1/webhook-endpointsCadastrar endpoint de webhook
- PATCH/v1/webhook-endpoints/{webhook_endpoint_id}Alterar endpoint de webhook
- DELETE/v1/webhook-endpoints/{webhook_endpoint_id}Remover endpoint de webhook
- POST/v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secretTrocar o segredo do endpoint
- POST/v1/webhook-endpoints/{webhook_endpoint_id}/testEnviar evento de teste
Eventos
Histórico de eventos, para auditoria e reenvio.
Parceiro
Repasse de 50% da margem ao ERP parceiro.
Sandbox
Simulação de pagamentos, só com chaves sk_test_.
- POST/v1/test-helpers/charges/{charge_id}/paySimular o pagamento de uma cobrança
- POST/v1/test-helpers/in-person-salesSimular uma venda na maquininha ou no Tap
- POST/v1/test-helpers/charges/{charge_id}/nullifySimular o estorno de uma venda presencial no aparelho
- POST/v1/test-helpers/payment-links/{payment_link_id}/paySimular um pagador concluindo o link de pagamento
Primeira vez? Comece pelo guia rápido e veja os termos no glossário.