Cancelar recorrência de Pix Automático

⚠️
O endpoint desta página cancela toda a série de cobranças recorrentes. Para cancelar uma transação específica, vá para Solicitar devolução Pix .

Requisição

Ambiente	Método	Endpoint
Sandbox	put	`https://apisandbox.braspag.com.br/v2/RecurrentPayment/{RecurrenceId}/deactivate`
Produção	put	`https://api.braspag.com.br/v2/RecurrentPayment/{RecurrenceId}/deactivate`

Parâmetros no path

Campo	Tipo	Descrição
`RecurrenceId`	string	Identificação da recorrência de Pix Automático, retornado pela API na criação do QR Code Pix. Tamanho: 36.

Parâmetros do cabeçalho

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
`MerchantId`	Identificador da loja no Gateway de Pagamentos.	Text	36	Sim
`MerchantKey`	Chave pública para autenticação dupla no Gateway de Pagamentos.	Text	40	Sim
`RequestId`	Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.	Text	36	Não

Ao cancelar uma série de recorrências com sucesso, a API irá retornar o código HTTP 200 Ok.

OK

Para os erros mais comuns a API irá retornar o código HTTP de erro acompanhado de Code e Message.

Exemplo:

Uma das repostas de erro mais comuns é quando a API não localiza o RecurrenceId informado:

[
    {
        "Code": 313,
        "Message": "Recurrent Payment not found"
    }
]