Reenvia por e-mail o link de pagamento já associado a uma assinatura. Use quando o cliente precisar receber novamente o acesso ao checkout; a operação não cria outra assinatura.

Marca manualmente um carnê como pago. Use somente quando o recebimento tiver ocorrido por outro meio e precisar ser refletido na Efí, pois a operação altera o estado financeiro do carnê.

Reenvia por e-mail um link de pagamento já criado para uma cobrança. Use quando o pagador não recebeu ou perdeu a mensagem original; nenhum novo link ou cobrança é criado.

Cria, em uma única etapa, a cobrança e o link que leva o pagador ao checkout hospedado pela Efí. Use quando a aplicação quiser oferecer pagamento sem implementar um checkout próprio.

Cria a transação inicial de uma cobrança sem concluir a escolha da forma de pagamento. Use no fluxo em duas etapas, antes de associar boleto, cartão ou link à transação.

Consulta os dados atuais de uma cobrança, incluindo sua forma de pagamento e situação. Use para acompanhar processamento, pagamento ou cancelamento sem modificar a transação.

Atualiza os metadados de integração de uma cobrança existente, como referência própria e URL de notificação quando aceitas pelo contrato. Use para corrigir o vínculo com o sistema integrador.

Revisa os dados permitidos de um boleto já associado a uma cobrança. Use para ajustar o boleto enquanto seu estado admitir alteração; a operação modifica a cobrança apresentada ao pagador.

Associa uma forma de pagamento e os dados do pagador a uma transação previamente criada. Use para concluir a segunda etapa da cobrança e gerar o instrumento de pagamento correspondente.

Cancela uma cobrança existente que ainda possa ser cancelada. Use quando o débito não deve mais ser cobrado; a mudança de estado impede que o fluxo de pagamento prossiga normalmente.

Cria um carnê com várias parcelas e vencimentos para o mesmo pagador. Use quando a venda exigir cobranças periódicas já definidas em lote; cada parcela poderá ser acompanhada separadamente.

Consulta um carnê existente e a situação de suas parcelas. Use para acompanhar vencimentos, pagamentos, baixas e cancelamentos sem realizar qualquer alteração no carnê.

Atualiza os dados permitidos de uma parcela específica de carnê. Use quando somente um vencimento precisar de revisão; a alteração afeta a cobrança apresentada para aquela parcela.

Atualiza em conjunto os dados permitidos das parcelas de um carnê. Use para aplicar revisões coordenadas a vários vencimentos; as cobranças das parcelas informadas serão modificadas.

Atualiza os metadados de integração de um carnê existente. Use para corrigir referências ou informações de notificação sem recriar o carnê nem alterar diretamente o pagamento das parcelas.

Recupera, pelo token recebido no callback, os eventos e dados atualizados associados a uma notificação. Use após a Efí avisar uma mudança para confirmar o estado da transação correspondente.

Lista os planos de assinatura cadastrados e seus dados de recorrência. Use para localizar o plano adequado antes de criar uma assinatura ou para consultar a configuração vigente.

Cria um plano que define a periodicidade e a quantidade de cobranças recorrentes. Use antes de vincular clientes a assinaturas que deverão seguir a mesma programação.

Exclui um plano de assinatura existente quando a Efí permitir a remoção. Use apenas se o plano não deve mais receber novas assinaturas, pois a operação remove sua configuração.

Cria uma assinatura vinculada a um plano já existente, ainda sem concluir a forma de pagamento. Use no fluxo em duas etapas antes de associar os dados de cobrança do assinante.

Cria a assinatura e define sua forma de pagamento em uma única operação. Use quando plano, assinante e dados de pagamento já estiverem disponíveis para iniciar a recorrência.

Cria uma assinatura e seu link de pagamento em uma única etapa. Use para permitir que o assinante conclua a contratação no checkout hospedado pela Efí.

Consulta os dados e a situação atual de uma assinatura vinculada a um plano. Use para acompanhar cobranças recorrentes, pagamento ou cancelamento sem alterar a assinatura.

Associa a forma de pagamento e os dados do cliente a uma assinatura previamente criada. Use para concluir a segunda etapa e habilitar as cobranças recorrentes do plano.

Cancela uma assinatura ativa e interrompe seu fluxo normal de cobranças futuras. Use quando o cliente não deve mais permanecer vinculado à recorrência do plano.

Atualiza os metadados de integração de uma assinatura, como referências usadas pelo sistema chamador. Use para corrigir o vínculo externo sem recriar nem cobrar novamente o assinante.

Consulta as opções e valores de parcelamento disponíveis para uma bandeira de cartão. Use antes de apresentar as parcelas ao cliente ou de criar a cobrança por cartão.

Reenvia por e-mail o boleto já gerado para uma cobrança. Use quando o pagador precisar receber novamente o documento; a operação não emite uma cobrança diferente.

Acrescenta uma descrição ao histórico de uma cobrança existente. Use para registrar uma ocorrência operacional ou observação sem alterar valor, vencimento ou estado de pagamento.

Reenvia por e-mail um carnê já criado com suas parcelas. Use quando o pagador precisar receber novamente os documentos, sem gerar outro carnê ou novas cobranças.

Reenvia por e-mail uma parcela específica de um carnê existente. Use quando apenas aquele documento precisar ser entregue novamente; as demais parcelas permanecem inalteradas.

Acrescenta uma descrição ao histórico de um carnê existente. Use para registrar uma ocorrência operacional sem modificar vencimentos, valores ou situação das parcelas.

Cancela um carnê existente e as cobranças abrangidas pela operação conforme o estado aceito pela Efí. Use quando o conjunto de parcelas não deve mais ser cobrado.

Cancela uma parcela específica de um carnê sem cancelar necessariamente as demais. Use quando somente aquele vencimento não deve mais ser cobrado do pagador.

Cria e associa um link de pagamento a uma transação previamente criada. Use para concluir o fluxo em duas etapas e encaminhar o pagador ao checkout da Efí.

Atualiza os atributos permitidos de um link de pagamento existente. Use quando a experiência ou as opções do checkout precisarem ser revistas sem criar outra cobrança.

Atualiza os dados permitidos de um plano de assinatura existente. Use para revisar sua configuração de recorrência; verifique o efeito esperado nas assinaturas vinculadas antes da alteração.

Atualiza os dados permitidos de uma assinatura existente. Use para revisar a configuração individual do vínculo com o plano sem criar uma nova assinatura.

Acrescenta uma descrição ao histórico de uma assinatura. Use para registrar uma ocorrência operacional sem alterar o plano, a forma de pagamento ou seu estado.

Define que a cobrança previamente criada produzirá um boleto balancete e informa seu conteúdo tabular. Use quando o documento precisar desse layout; a Efí apenas organiza os dados fornecidos.

Marca manualmente uma cobrança como paga. Use somente quando o valor tiver sido recebido por outro meio e o estado precisar ser refletido na Efí, pois há efeito financeiro.

Marca manualmente uma parcela específica de carnê como paga. Use quando o recebimento externo daquela parcela precisar ser registrado, pois a operação altera seu estado financeiro.

Cria a transação e sua forma de pagamento em uma única operação. Use quando todos os dados comerciais e do pagador já estiverem disponíveis para emitir a cobrança imediatamente.

Solicita nova tentativa de pagamento por cartão para uma cobrança compatível. Use após uma tentativa não autorizada e com dados válidos; a operação pode efetivar a cobrança do cliente.

Solicita o estorno total ou parcial de um pagamento realizado com cartão, conforme o contrato do SDK. Use para devolver valores de uma cobrança já paga; a operação movimenta recursos.

Lista cobranças conforme os filtros aceitos pela Efí. Use para conciliação, acompanhamento operacional ou localização de transações sem modificar seus estados.

Cria e submete uma cobrança por cartão de crédito pela versão atual da rota de cartões. Use quando o token de pagamento e os dados exigidos já estiverem disponíveis; pode cobrar o cliente.

Cria uma cobrança Pix com vencimento usando um txid definido pelo recebedor. Use quando a cobrança precisar de data de vencimento e das regras financeiras admitidas para cobranças desse tipo.

Revisa os campos permitidos de uma cobrança Pix com vencimento identificada pelo txid. Use para atualizar uma cobrança existente enquanto seu estado admitir mudanças.

Consulta pelo txid os dados, a revisão e o estado de uma cobrança Pix com vencimento. Use para acompanhar a cobrança ou obter dados para exibição sem alterá-la.

Lista cobranças Pix com vencimento no período e com os filtros informados. Use em rotinas de acompanhamento e conciliação sem modificar as cobranças encontradas.

Solicita a geração assíncrona de um relatório de conciliação Pix. Use quando precisar consolidar movimentações para conferência; a resposta identifica o processamento a acompanhar.

Consulta o estado e os dados de um relatório de conciliação solicitado anteriormente. Use para verificar se o processamento terminou e obter as informações disponibilizadas pela Efí.

Cria uma cobrança Pix imediata com txid definido pelo recebedor. Use quando a aplicação precisar controlar o identificador e gerar um pagamento Pix rastreável.

Revisa os campos permitidos de uma cobrança Pix imediata identificada pelo txid. Use para atualizar uma cobrança existente enquanto seu estado admitir alteração.

Cria uma cobrança Pix imediata e deixa a Efí atribuir o txid. Use quando a aplicação não precisar escolher previamente o identificador da cobrança.

Consulta pelo txid os dados, a revisão e o estado de uma cobrança Pix imediata. Use para acompanhar pagamento ou remoção sem modificar a cobrança.

Lista cobranças Pix imediatas no período e com os filtros informados. Use em rotinas de acompanhamento e conciliação sem alterar os registros retornados.

Consulta um recebimento Pix pelo identificador end-to-end. Use para confirmar valor, horário, pagador e eventuais devoluções de uma transação já recebida.

Lista recebimentos Pix conforme período e filtros aceitos. Use para conciliar entradas na conta e acompanhar devoluções sem movimentar valores.

Solicita uma transferência Pix para uma chave ou conta favorecida usando um identificador de envio. Use somente após conferir pagador, favorecido e valor; a operação movimenta saldo da conta.

Consulta um Pix enviado usando seu identificador end-to-end. Use para confirmar processamento, favorecido, valor e devoluções sem iniciar nova transferência.

Lista transferências Pix enviadas no período e com os filtros informados. Use para acompanhamento e conciliação de saídas sem movimentar valores.

Solicita uma devolução vinculada a um Pix recebido e identifica essa devolução dentro da transação. Use após conferir o recebimento e o valor, pois a operação movimenta saldo.

Consulta o estado e os dados de uma devolução já solicitada para um Pix recebido. Use para acompanhar seu processamento sem criar outra devolução ou movimentar valores.

Configura a URL que receberá eventos Pix associados a uma chave. Use depois de preparar o endpoint de callback com os requisitos de segurança; a configuração substitui o destino aplicável.

Consulta a configuração de webhook associada a uma chave Pix. Use para confirmar URL e criação do vínculo antes de depender das notificações, sem alterar a configuração.

Lista as configurações de webhook Pix conforme os filtros disponíveis. Use para inventariar destinos de notificação e verificar vínculos sem modificá-los.

Remove a configuração de webhook associada a uma chave Pix. Use quando aquele destino não deve mais receber eventos; a aplicação deixará de receber as notificações correspondentes.

Cria uma location reutilizável para associar uma cobrança a um payload dinâmico. Use antes de gerar o QR Code quando a aplicação precisar administrar essa associação separadamente.

Lista locations de payload Pix conforme os filtros informados. Use para localizar associações de cobranças e QR Codes sem modificar seus vínculos.

Consulta uma location Pix pelo identificador e informa sua associação atual. Use para verificar o vínculo com uma cobrança antes de gerar ou reutilizar o QR Code.

Gera o Pix Copia e Cola e a imagem do QR Code para uma location existente. Use depois de associar a location à cobrança que o pagador deverá acessar.

Remove o vínculo entre uma location e o txid de sua cobrança Pix. Use antes de reutilizar a location ou encerrar a associação; o QR Code deixa de representar aquele vínculo.

Registra uma nova chave Pix aleatória na conta autenticada. Use quando a conta precisar de uma EVP para receber pagamentos; a resposta contém a chave criada.

Lista somente as chaves Pix do tipo aleatória registradas na conta autenticada. Use para inventariar EVPs disponíveis antes de configurar cobranças ou webhooks.

Remove uma chave Pix aleatória da conta. Use apenas quando ela não deve mais receber pagamentos; a mesma EVP não poderá ser recriada e cobranças ligadas a ela podem deixar de funcionar.

Consulta o saldo disponível da conta Efí e, quando solicitado, os valores bloqueados. Use antes de operações de saída ou em conciliações; nenhum saldo é movimentado.

Cria ou modifica regras de recebimento e notificação Pix da conta ou de chaves específicas. Use para controlar formas aceitas de recebimento; a mudança afeta transações futuras.

Retorna as regras Pix definidas para a conta e suas chaves. Use para conferir comportamento de recebimento e notificações antes de alterá-lo.

Consulta a configuração de split vinculada a uma cobrança Pix imediata. Use para verificar como o recebimento será distribuído sem alterar a cobrança ou seus repasses.

Vincula uma configuração de split existente a uma cobrança Pix imediata. Use antes do pagamento para definir a distribuição do valor entre os participantes.

Remove o vínculo de split de uma cobrança Pix imediata. Use quando o recebimento não deve mais seguir aquela distribuição e confira o estado da cobrança antes da mudança.

Consulta a configuração de split vinculada a uma cobrança Pix com vencimento. Use para verificar a distribuição prevista do recebimento sem alterar seus repasses.

Vincula uma configuração de split existente a uma cobrança Pix com vencimento. Use antes do pagamento para definir como o valor recebido será distribuído.

Remove o vínculo de split de uma cobrança Pix com vencimento. Use quando o recebimento não deve mais seguir aquela distribuição e verifique o estado da cobrança antes da mudança.

Cria uma configuração de split que define participantes e critérios de distribuição. Use antes de vinculá-la a cobranças Pix que devam repartir valores recebidos.

Cria ou substitui uma configuração de split usando um identificador escolhido. Use quando a aplicação precisar controlar o identificador; vínculos futuros usarão a definição resultante.

Consulta participantes e critérios de uma configuração de split Pix. Use para validar a distribuição antes de vinculá-la a uma cobrança ou revisar um vínculo existente.

Consulta uma transferência Pix pelo identificador atribuído pela aplicação no envio. Use para acompanhar processamento, favorecido e valor sem iniciar outra transferência.

Cria ou substitui um lote de cobranças Pix com vencimento sob um identificador. Use para registrar várias cobranças coordenadas; a operação altera o conteúdo integral do lote.

Revisa cobranças específicas dentro de um lote Pix com vencimento. Use para alterar somente os itens informados, preservando as demais cobranças do lote.

Consulta pelo identificador um lote de cobranças Pix com vencimento e seus itens. Use para acompanhar o processamento e as revisões sem modificar o lote.

Lista lotes de cobranças Pix com vencimento conforme período e filtros aceitos. Use para localizar lotes e acompanhar sua criação sem alterar seus conteúdos.

Envia uma defesa para uma infração específica do Mecanismo Especial de Devolução. Use para complementar a análise; o envio não substitui o acompanhamento e documentos solicitados por ticket.

Lista infrações MED abertas nas contas associadas ao documento da conta autenticada. Use para acompanhar contestações e identificar casos que exigem defesa ou tratativa adicional.

Solicita o pagamento de um QR Code por seu Pix Copia e Cola e um identificador de envio. Use após validar os dados do recebedor e o valor; a operação movimenta saldo da conta.

Solicita o reenvio de notificações Pix dentro do recorte informado. Use para recuperar callbacks não processados; o endpoint configurado poderá receber novamente eventos já emitidos.

Obtém o comprovante em PDF de uma transação Pix usando um de seus identificadores aceitos. Use para entregar ou arquivar a evidência de uma operação já realizada.

Solicita uma transferência Pix exclusivamente para conta da mesma titularidade. Use após conferir origem, destino e valor; a operação movimenta o saldo da conta autenticada.