Pular para o conteúdo
EntrarSolicitar acesso

Referência da API

Todas as rotas públicas, geradas do contrato OpenAPI da API.

MétodoCaminhoO que fazChave
POST/v1/credenciamentoCadastra a plataforma e libera uma chave de sandboxNão
GET/v1/plataformaStatus do credenciamento e ambiente da chave usadaSim
GET/v1/recebedoresLista os recebedores da conta (mais recentes primeiro)Sim
POST/v1/recebedoresCria um recebedorSim
GET/v1/recebedores/{id}Consulta um recebedorSim
POST/v1/recebedores/{id}/atualizarReconsulta o status do KYC no provedorSim
POST/v1/recebedores/{id}/kyc-linkGera um novo link de KYC (provedores que usam link)Sim
POST/v1/cobrancasCria uma cobrança Pix ou cartãoSim
GET/v1/cobrancasLista cobranças (mais recentes primeiro)Sim
GET/v1/cobrancas/{id}Consulta uma cobrançaSim
POST/v1/cobrancas/{id}/estornosEstorna a cobrança por inteiroSim
GET/v1/chavesLista as chaves de API da plataformaSim
POST/v1/chavesEmite uma nova chave de APISim
DELETE/v1/chaves/{id}Revoga uma chave de APISim
POST/v1/teste/cobrancas/{id}/simularSandbox, simula a mudança de status de uma cobrançaSim
GET/v1/plataforma/recebimentoConta de recebimento da plataformaSim
PUT/v1/plataforma/recebimentoCadastra ou troca a conta de recebimento da plataformaSim
PUT/v1/plataforma/dominiosDefine os domínios que podem mostrar os campos de cartãoSim
POST/v1/checkoutsCria um link de pagamento (checkout hospedado)Sim
GET/v1/checkoutsLista os links de pagamentoSim
GET/v1/checkouts/{id}Consulta um link de pagamentoSim
POST/v1/checkouts/{id}/cancelarCancela um link que ainda não foi pagoSim
POST/v1/tokensTokeniza um cartão (sandbox, só pelos campos hospedados)Não
GET/v1/publico/checkouts/{id}Dados públicos do link, para a página de pagamentoNão
POST/v1/publico/checkouts/{id}/pagarCria o pagamento de um link (Pix ou cartão com token)Não
POST/v1/publico/checkouts/{id}/simular-pagamentoSandbox, simula o pagamento do Pix de um linkNão
GET/v1/webhooksLista os endpoints de webhook do ambienteSim
POST/v1/webhooksCadastra um endpoint de webhookSim
GET/v1/webhooks/tiposTipos de evento disponíveisSim
PUT/v1/webhooks/{id}Atualiza URL, eventos, descrição ou pausa/reativa o endpointSim
DELETE/v1/webhooks/{id}Exclui o endpoint e o histórico de entregas deleSim
POST/v1/webhooks/{id}/rotacionarTroca o segredo; o antigo vale por mais 24 horasSim
POST/v1/webhooks/{id}/testeEnvia um evento webhook.teste só para este endpointSim
GET/v1/webhooks/entregasLista entregas de webhook, com histórico de tentativasSim
POST/v1/webhooks/entregas/{id}/reenviarRecoloca uma entrega na fila para tentar de novo agoraSim

O contrato completo, com todos os campos, está em openapi.yaml.