Cadastrar recorrência via QR Code

POST

/api/PixAutomatico/Pagador/CadastrarRecorrencia

PixAutomatico

Funcionalidade principal

O endpoint CadastrarRecorrencia processa os dados contidos em um QR Code de Pix Automático para criar um vínculo de autorização (consentimento) entre o pagador e o recebedor. Diferente de um Pix comum, aqui o usuário não está apenas enviando dinheiro, mas sim permitindo que débitos futuros ocorram automaticamente em sua conta, respeitando limites e periodicidades pré-definidos.

Casos de uso comuns

Adesão via QR Code físico: O usuário escaneia um QR Code impresso em uma fatura de serviços públicos (luz, água) para ativar o débito automático via Pix.

Checkout com recorrência: Em um site de assinaturas, o usuário escaneia o QR Code dinâmico para pagar a primeira parcela e já deixar as próximas autorizadas.

Controle de teto de gasto: No momento do cadastro, o pagador define um "valor máximo" que permite ser debitado por aquele recebedor, garantindo segurança financeira.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/PixAutomatico/Pagador/CadastrarRecorrencia' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "CodigoCliente": 0,
    "CodigoCanal": 0,
    "TextoQrCode": "string",
    "ValorPisoMaximo": 0,
    "IdentificacaoOpcional": "string"
}'

Response Example

{
    "IdRecorrencia": 0,
    "DataGravacao": "string"
}

Modificado em 2026-03-03 15:19:01

Página anterior

Calcular último pagamento

Próxima página

Atualizar status de uma recorrência

Cadastrar recorrência via QR Code

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns