JOVPay Developers
Entrar Criar conta
Recursos

Pix Automático

Trabalhe com autorizações recorrentes e competências pela API JOVPay.

O Pix Automático permite obter uma autorização do cliente e utilizá-la para cobranças recorrentes futuras.

Fluxo da autorização

  1. Cadastre ou localize o cliente.
  2. Crie a autorização Pix Automático.
  3. Disponibilize ao cliente os dados necessários para concluir a autorização.
  4. Aguarde a aprovação.
  5. Crie ou acompanhe as competências.
  6. Acompanhe as cobranças relacionadas à autorização.

Tipo de valor

amount_type pode utilizar fixed ou minimum. fixed é apropriado quando o valor recorrente é fixo. minimum permite trabalhar com uma autorização cujo limite autorizado parte de um valor mínimo.

Gerenciamento pela API

Quando schedule_management estiver definido como api, o seu sistema envia cada competência através da API. Cada competência deve possuir uma reference única dentro da integração.

Desconto por pontualidade

As competências compatíveis podem utilizar punctuality_discount. O desconto pode ser fixo ou percentual, conforme os campos documentados na criação da cobrança.

Idempotência

Preserve a mesma reference ao repetir uma operação documentada como idempotente. Uma falha de comunicação não deve levar sua aplicação a inventar uma nova referência para a mesma cobrança.

PDF

A API disponibiliza uma rota específica para obter o documento PDF associado à cobrança do Pix Automático.

Cancelamento

Uma competência pode possuir cancelamento próprio quando sua situação atual ainda permitir essa operação.

Pronto para integrar?

Consulte parâmetros, exemplos, respostas e execute chamadas na referência da API.

Ver endpoints do Pix Automático  →