Todas as rotas de escrita desta página exigem o header
IdempotencyKey, com um valor novo a cada chamada.O que o seu app precisa oferecer
O Banco Central exige que o app do pagador:- mostre os dados da recorrência antes da autorização: recebedor, contrato, periodicidade, valor e datas;
- permita definir e alterar um valor máximo em recorrências de valor variável;
- liste as autorizações pendentes, ativas e o histórico;
- permita cancelar a autorização a qualquer momento e um débito agendado até 23h59 da véspera.
Jornadas 2, 3 e 4: ler o QR Code
Leia o QR Code pelo mesmo endpoint de pagamento por QR Code. Quando o código traz uma recorrência, a resposta temtype igual a COMPOSITE, um decodeType de recorrência e o objeto recurrence.
Os valores
QR_CODE_STATIC, QR_CODE_IMMEDIATE e QR_CODE_DUE_DATE indicam um QR Code comum, sem recorrência.
Registrar a autorização (jornadas 2 e 4)
Quando o pagador aceitar, registre a autorização com os dados derecurrence:
- Copie
journey,frequencyType, as datas,amountouminPayerMaxAmount,beneficiary,debtor,contractNumberecontractDescriptionda leitura do QR Code. beneficiaryé obrigatório.- Em recorrências de valor variável, informe em
payerMaxAmounto valor máximo escolhido pelo pagador. - Os dados do pagador vêm da conta autenticada. Não é preciso enviá-los.
Jornada 1: responder uma solicitação
As solicitações da jornada 1 chegam como autorizações pendentes. Liste-as comflow=0 e authorizationResult=PENDING_USER em Listar autorizações e mostre ao pagador.
recurrenceId e requestedAt. Ao recusar, informe o motivo em rejectionReason. O Banco Central prevê dois motivos: o pagador não reconhece o recebedor ou não tem interesse.
Alterar o valor máximo
O pagador pode alterar o valor máximo a qualquer momento. A mudança vale para os próximos agendamentos, não para os já feitos.Débitos agendados
Para listar os débitos agendados do pagador, use Listar agendamentos comflow=1. No dia do vencimento, o débito é feito automaticamente, entre 0h e 8h, e gera o webhook PIX_PAYMENT_UPDATED como um Pix enviado.
Para cancelar uma autorização ou um débito agendado, veja Cancelar. Use cancellationRequesterType igual a PAYER e cancellationReason igual a REQUESTED_BY_PAYER.
Referência da API
Registrar autorização
POST /baas/api/v1/pix/automatic/authorizations/{recurrenceId}/approveResponder solicitação
PUT /baas/api/v1/pix/automatic/authorizations/{recurrenceId}Alterar valor máximo
PUT /baas/api/v1/pix/automatic/authorizations/{recurrenceId}/max-amountLer QR Code
POST /baas/api/v2/pix/qrcode/payment-initialization
