Lançar parcela de Pix Automático

POST

/api/PixAutomatico/Recebedor/CadastrarAgendamento

PixAutomatico

Funcionalidade principal

O endpoint Recebedor/CadastrarAgendamento é utilizado para registrar uma ordem de pagamento vinculada a uma recorrência existente. Enquanto a solicitação de recorrência cria o "contrato" de débito, este endpoint cria a "parcela" ou o "agendamento" específico de uma data e valor, informando ao sistema que aquela cobrança deve ser processada no banco do pagador.

Casos de uso comuns

Cobrança de valor variável: Uma concessionária de energia que, após ler o medidor, agenda o valor exato do consumo mensal contra o consentimento de Pix Automático do cliente.

Lançamento de parcela específica: Um sistema de ERP que agenda a próxima mensalidade de um serviço assim que a nota fiscal é gerada.

Atualização de valor: Uso em casos onde o valor da assinatura sofreu reajuste e a empresa precisa agendar o novo montante (respeitando o teto máximo autorizado).

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/CadastrarAgendamento' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "IdRecorrencia": 0,
        "DataRecorrencia": "string",
        "DataVencimento": "string",
        "Valor": 0,
        "InfoAdicional": "string"
    }
}'

Response Example

{
    "Data": {
        "Id": 0,
        "DataGravacao": "string",
        "TipoRecorrencia": "string",
        "TipoFrequencia": "string",
        "DataInicioRecorrencia": "string",
        "HoraInicioRecorrencia": "string",
        "DataFimRecorrencia": "string",
        "HoraFimRecorrencia": "string",
        "Valor": 0,
        "RecebedorNome": "string",
        "DevedorNome": "string",
        "NumeroContrato": "string",
        "DescricaoContrato": "string",
        "DataCriacaoConfirmacao": "string",
        "HoraCriacaoConfirmacao": "string",
        "DataCriacaoRecorrencia": "string",
        "HoraCriacaoRecorrencia": "string",
        "DataExpiracaoConfirmacao": "string",
        "HoraExpiracaoConfirmacao": "string",
        "Status": "string"
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:16:27

Página anterior

Listar contratos de Pix Automático

Próxima página

Consultar um contrato de Pix Automático

Lançar parcela de Pix Automático

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns