Criar uma autorização

post

https://api-sandbox.asaas.com/v3/pix/automatic/authorizations

Recipes

🦉

Pix Automático

Open Recipe

Cria uma autorização de Pix Automático vinculada a um cliente e gera o QR Code imediato utilizado no primeiro pagamento e na obtenção do consentimento para os pagamentos recorrentes.

O modo definido em paymentCreationMode determina se as cobranças dos próximos ciclos serão criadas pela aplicação ou automaticamente por uma assinatura.

📘
Ativação da autorização
A criação da autorização não significa que ela já está ativa. A resposta disponibiliza o id da autorização e o QR Code do primeiro pagamento.
Após a conclusão do primeiro pagamento e da autorização pelo pagador, a autorização passa para ACTIVE. Acompanhe essa mudança pelos Webhooks de Pix Automático.
Consulte os eventos para Pix Automático.

Conteúdos relacionados

Guides

Webhooks

Eventos para Pix Automático

Body Params

frequency

string

enum

required

Frequência dos pagamentos periódicos

Allowed:

contractId

string

required

length ≤ 35

Número, identificador, ou código que representa o objeto da autorização

startDate

date

required

Inicio da vigência da autorização e dos pagamentos

finishDate

date

Fim da vigência da autorização. Opcional caso o Pix Automático seja de prazo indeterminado

value

number

Valor fixo para as cobranças periódicas.

description

string

length ≤ 35

Descrição

customerId

string

required

Identificador único do cliente

immediateQrCode

object

required

Cobrança imediata atrelada a ativação da autorização

minLimitValue

number

Se o usuário pagador atribuir um valor máximo para os pagamentos daquela autorização, ele não poderá ser inferior ao piso definido pelo usuário recebedor. Não pode ser preenchido nas autorizações de valor fixo, ou seja, com campo valor preenchido

paymentCreationMode

string

enum

Defaults to MANUAL

Modo de criação dos pagamentos vinculados à autorização. Utilize SUBSCRIPTION para que as cobranças sejam geradas automaticamente por uma assinatura ou MANUAL para criar cada cobrança manualmente. Caso informado como SUBSCRIPTION, é obrigatório preencher o campo value para configuração da assinatura

Allowed:

retryPolicy

string

enum

Defaults to NOT_ALLOWED

Política de retentativa de cobranças da autorização. Utilize ALLOW_THREE_IN_SEVEN_DAYS para permitir até 3 retentativas nos 7 dias após o vencimento ou NOT_ALLOWED para desativar retentativas

Allowed:

Responses

Ativação da autorização

Conteúdos relacionados

Guides

Webhooks

200Ok

400Bad Request

401Unauthorized