Cancelar um agendamento de pagamento da recorrência

POST

/api/PixAutomatico/Pagador/CancelarAgendamento

PixAutomatico

Funcionalidade principal

O endpoint Pagador/CancelarAgendamento permite que o cliente final desista de um pagamento individual que já foi programado por um recebedor. Ao contrário do cancelamento da recorrência (que encerra o vínculo), este comando atua apenas sobre uma parcela/lançamento específico, mantendo as autorizações para os meses seguintes intactas.

Casos de uso comuns

Pagamento por outra via: O utilizador já pagou a fatura via boleto ou QR Code estático e precisa cancelar o agendamento automático para evitar a duplicidade.

Disputa de valor: O utilizador identifica que o valor agendado por uma empresa de serviços variáveis está incorreto e suspende aquele débito específico até que a situação seja resolvida.

Gestão de fluxo de caixa: O cliente percebe que não terá saldo suficiente na data prevista e opta por cancelar o agendamento para renegociar o pagamento posteriormente.

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/CancelarAgendamento' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "Id": 0
    }
}'

Response Example

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

Modificado em 2026-03-03 15:22:33

Página anterior

Consultar um agendamento

Próxima página

Transferir saldo internamente (P2P)

Cancelar um agendamento de pagamento da recorrência

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns