Propor adesão ao Pix Automático (Push)

POST

/api/PixAutomatico/Recebedor/EnviarSolicitacaoRecorrencia

PixAutomatico

Funcionalidade principal

O endpoint EnviarSolicitacaoRecorrencia dispara uma proposta de adesão ao Pix Automático para um cliente específico. Ao invés de esperar o cliente escanear um QR Code, a empresa envia os termos (valor, periodicidade e datas) diretamente para a instituição financeira do pagador para que este apenas revise e confirme a autorização em seu próprio aplicativo bancário.

Casos de uso comuns

Migração de cobrança: Uma empresa de software (SaaS) ou concessionária de serviços públicos que deseja migrar seus clientes do boleto ou cartão para o Pix automático.

Vendas por telefone/chat: O atendente fecha uma venda recorrente e envia a solicitação de autorização Pix diretamente para o banco do cliente em tempo real.

Renovação de assinaturas: Envio programado de novas solicitações de recorrência quando um contrato anterior está prestes a expirar.

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/Recebedor/EnviarSolicitacaoRecorrencia' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "Periodicidade": "Semestral",
        "DataPrimeiroPagamento": "string",
        "DataUltimoPagamento": "string",
        "Valor": 0,
        "PisoValorMaximo": 0,
        "UsuarioPagadorCpfCnpj": "string",
        "UsuarioPagadorIspb": "string",
        "UsuarioPagadorConta": "string",
        "UsuarioPagadorAgencia": "stri",
        "DevedorNome": "string",
        "DevedorCpfCnpj": "string",
        "NumeroContrato": "string",
        "DescricaoContrato": "string",
        "RecurringConsentId": "string"
    }
}'

Response Example

{
    "Data": {},
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:15:32

Página anterior

Remover favorecido para Pix

Próxima página

Listar contratos de Pix Automático

Propor adesão ao Pix Automático (Push)

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns