Cancelar um agendamento de pagamento de parcela do Pix Automático

POST

/api/PixAutomatico/Recebedor/CancelarAgendamento

PixAutomatico

Funcionalidade principal

O endpoint Recebedor/CancelarAgendamento é utilizado para cancelar um agendamento de pagamento individual dentro de uma recorrência de Pix Automático. É importante notar que este comando cancela apenas uma parcela específica e não o contrato de recorrência (consentimento) como um todo.

Casos de uso comuns

Estorno preventivo: O cliente pagou a fatura por outro meio (como boleto ou cartão) e a empresa precisa cancelar o agendamento do Pix para evitar a cobrança duplicada.

Suspensão de serviço: O cliente solicitou a pausa de uma assinatura e a empresa cancela os agendamentos dos meses em que o serviço não será prestado.

Erro de lançamento: A empresa identificou um erro no valor ou na data de um agendamento enviado anteriormente e precisa removê-lo para cadastrar o correto.

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/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:17:13

Página anterior

Consultar um contrato de Pix Automático

Próxima página

Cancelar um contrato de Pix Automático

Cancelar um agendamento de pagamento de parcela do Pix Automático

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns