Endpoint responsável por iniciar o fluxo de Pix Automático.

Ao realizar esta chamada, o sistema cria uma autorização de pagamentos recorrentes vinculada a um cliente. No mesmo processo também é gerado um QR Code de pagamento imediato, que será utilizado para realizar o primeiro pagamento e registrar o consentimento do pagador para as cobranças recorrentes futuras.

Esse comportamento ocorre porque a requisição inclui o objeto immediateQrCode, que representa a cobrança imediata utilizada para ativar a autorização.

--= principais da requisição

Alguns campos da requisição definem como a recorrência funcionará:

• customerId - Identificador do cliente que autorizará os pagamentos automáticos.
• frequency - Define a frequência das cobranças recorrentes. Os valores possíveis são:
  • WEEKLY — semanal
  • MONTHLY — mensal
  • QUARTERLY — trimestral
  • SEMIANNUALLY — semestral
  • ANNUALLY — anual
• contractId - Identificador do contrato ou objeto que originou a autorização. Esse campo permite que sua aplicação associe a autorização a um contrato ou assinatura interna.
• startDate - Data de início da vigência da autorização e dos pagamentos automáticos.
• finishDate - Data de término da autorização. Caso não seja informado, a autorização poderá permanecer ativa por prazo indeterminado.
• value - Valor fixo das cobranças recorrentes. Quando informado, todas as cobranças criadas para essa autorização devem utilizar esse valor.
• description - Descrição da autorização.
• immediateQrCode - Objeto que define os parâmetros da cobrança imediata que ativará a autorização. Essa cobrança representa o primeiro pagamento do fluxo e será apresentada ao pagador por meio de um QR Code. Os atributos internos desse objeto devem seguir a referência do endpoint.

Fluxo da autorização

O fluxo ocorre da seguinte forma:

1. Sua aplicação envia a requisição para criar a autorização utilizando o endpoint:
2. O Asaas cria a autorização e gera um QR Code imediato.
3. O QR Code é apresentado ao pagador.
4. O pagador realiza o pagamento utilizando o aplicativo bancário.
5. Após a confirmação do pagamento, a autorização passa para o status ACTIVE.

Criação de cobranças recorrentes

Somente após a autorização estar ativa será possível criar cobranças recorrentes vinculadas a ela.

Identificador da autorização

A resposta da API retorna o identificador da autorização:

Esse identificador deve ser armazenado pela aplicação, pois será utilizado para:

• criar cobranças recorrentes utilizando o campo pixAutomaticAuthorizationId
• consultar o status da autorização
• acompanhar os eventos via webhook