Docs
Guia do Usuário
  • Sumário de Implementação
  • API Explorer
    • API
    ...

    Nesta página

    Funcionalidades para Desenvolvedores

    Informações gerais sobre funcionalidades de cobrança. É necessário estar logado no console para acessar tais funcionalidades.

    1. Envio de eventos

    Se você deseja usar a Central de Cobranças para gerar faturas e gerenciar os pagamentos no seu aplicativo, é necessário, primeiramente, que seu aplicativo esteja configurado para emitir cobranças. Além disso, é imprescindível que um plano seja criado e devidamente configurado. O plano deve conter:

    • Regras configuradas
    • Nome do evento vinculado à regra
    • Criado e publicado na plataforma

    Por fim, você precisa configurar e enviar eventos. Um evento é uma ação específica realizada no seu aplicativo que resulta em uma cobrança, e ele precisa ser registrado e enviado para a plataforma de cobrança para que o processo seja automatizado.

    Identifique as funcionalidades cobráveis no seu App

    Primeiro, identifique no seu aplicativo quais funcionalidades são passíveis de cobrança. Isso pode incluir ações como:

    • Realização de transferências
    • Assinaturas de planos
    • Compra de créditos
    • Ações com pagamento por uso

    Essas funcionalidades devem ser mapeadas para que você saiba exatamente o que precisa ser registrado como evento para gerar uma cobrança correspondente.

    Crie um nome de evento

    Uma vez que você tenha identificado as funcionalidades cobráveis, o próximo passo é criar um nome para o evento que será enviado para a plataforma. O nome deve ser claro e refletir a ação realizada no seu app. Por exemplo:

    • “transferencia-realizada”
    • “assinatura-renovada”
    • “compra-créditos”

    Crie o plano de cobrança

    • Agora, no sistema da Central de Cobranças, você precisa criar e publicar um plano de cobrança. O plano define as regras e valores associados aos eventos do seu aplicativo. Para que a cobrança seja feita corretamente, o nome do evento no plano deve corresponder ao nome do evento enviado via API.

    Envio do evento via API

    • Com o nome do evento definido e o plano criado, o próximo passo é enviar os eventos através da API. Para cada ação que você deseja registrar, você deverá fazer uma requisição à API, incluindo as informações necessárias. A API vai processar esses dados e gerar a cobrança conforme as regras configuradas.

    Monitoramento e reenvio de eventos

    • Após enviar os eventos, é importante monitorar os erros que podem ocorrer. Caso um evento não tenha sido processado corretamente, ele deve ser reenviado para garantir que a cobrança seja gerada sem falhas. Acompanhe os logs de erro através da API e, caso necessário, faça o reenvio dos eventos.

    2. Planos de cobrança

    O plano é o que o usuário do seu aplicativo poderá ver quando instalar seu app. Um plano deve possuir uma regra de cobrança, é na regra de cobrança que você irá definir como quer cobrar pelas atividades associadas aos eventos da sua aplicação.

    Como criar e configurar um plano
    1. Clique em Gerenciar Área de trabalho no menu superior direito
    2. Clique em Desenvolvimento a partir do menu lateral esquerdo
    3. Clique em Editar no app que deseja configurar o plano de cobrança
    4. Clique em Receita para acessar a tela de configuração de plano do app selecionado
    5. Acessando a tela do seu app, clique em no canto superior direito
    6. Você deve ter um plano com o status rascunho e o mesmo nome do seu app. Clique em Editar. Essa é a tela do seu plano. Ela permite você criar e editar suas regras de cobrança e publicar seu plano.
      Existem 3 tipos de regra de cobrança: Unidade, Escalonado e Pacote
      • Unidade: É o modelo de cobrança mais simples. Cada evento contabilizado irá gerar um cobrança com um valor fixo predefinido.
        Exemplo: R$0,20 por evento de cobrança. 10 eventos irão acarretar em uma cobrança de R$2,00
      • Pacote: Define um saldo de eventos a serem contabilizados. O valor cobrado é predefinido e será cobrado caso o saldo de eventos seja consumido totalmente ou não. Se o limite for ultrapassado, uma nova cobrança será realizada.
        Exemplo: 10.000 eventos à R$200. Se só 8.000 eventos forem consumidos, a cobrança ainda será R$200. Mas se 10.001 eventos forem consumidos, será cobrado R$400
      • Escalonado: É similar ao modelo por unidade, porém permite definir intervalos de cobrança em escalas.
        Exemplo: R$0,25 por evento para os primeiros 100 eventos e R$0,10 para os demais
    7. Selecione a regra desejada no menu superior direito e clique em
    8. Defina o nome da regra e o nome do evento a ser cobrado.
    9. Defina os valores a serem cobrados de acordo com a regra escolhida
    10. Selecione a forma que os eventos recebidos serão contabilizados. Na opção unitária a cobrança será feita por evento recebido (valor definido nos passos anteriores X quantidade de eventos recebidos). Na opção customizada o calculo será feito com base no parâmetro ‘custom_unit_quantity’ recebido na criação do evento (valor definido nos passos anteriores X somatória dos valores recebidos no parâmetro custom_unit_quantity).
    11. Quando estiver satisfeito com sua regra, clique em

    Publicando um plano

    Instruções para publicar um plano de cobrança.

    Como publicar um plano
    1. Clique em após criar um plano

    Depois de publicado, a versão do plano não poderá mais ser editada. Para continuar editando é necessário salvar como rascunho.

    Voltar

    Para clientes

    Avançar

    Sumário de Implementação