Cancelar autorização

stable

Este endpoint permite que o usuário pagador possa cancelar uma autorização de Pix automático.

O cancelamento de uma autorização do Pix Automático ocorre quando o usuário pagador solicita o encerramento de uma autorização existente. Ao receber essa solicitação, a Bankly verifica se a autorização ainda está ativa. Caso esteja, ela realiza o cancelamento da autorização e tenta, simultaneamente, encerrar todos os agendamentos vinculados à autorização cancelada.
Mesmo que algum agendamento não seja cancelado, a Bakly considera o cancelamento da autorização como bem-sucedido. Por isso, após cancelar a autorização, quem consome os serviços da Bankly deveconsultar os agendamentos vinculados à autorização. Caso existam agendamentos ativos, é necessário acionar o serviço de cancelamento do agendamento para garantir que todas as transações vinculadas à autorização sejam efetivamente encerradas.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O cliente de nosso parceiro tenha autorizado uma ou mais recorrências de pagamentos via Pix automático.

Requisição (Request)

Requisição HTTP

DELETE https://api-mtls.sandbox.bankly.com.br/pix/recurring-payments/{idRecurrence}

curl --request DELETE \
     --url https://api-mtls.sandbox.bankly.com.br/pix/recurring-payments/RR595881112025031252S6M18DDD1 \
     --header 'Authorization: bearer' \
     --header 'accept: application/json' \
     --header 'api-version: 1' \
     --header 'x-bkly-pix-user-id: 123456789' \
     --header 'x-correlation-id: haseher-2414n-bnjk2-213jl'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`recurring_payment_auth.write`	Concede acesso para consultar autorizações de pagamentos recorrentes via Pix automático.

Cabeçalhos (Headers)

Nome	Descrição	Especificação
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.	—
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.	—
`x-bkly-pix-user-id`	Obrigatório. Número do documento do usuário que está fazendo a requisição.	Informe somente números.
`x-correlation-id`	Obrigatório. Identificador de correlação da requisição.	Formato GUID v4. A cada requisição, deve-se gerar um novo GUID.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição	Especificação
`IdRecurrence`	`path`	Obrigatório*. Identificador da autorização/recorrência.	`RRxxxxxxxxyyyyMMddkkkkkkkkkkk`(29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo: 1º caractere `R` ou `C` - Fixo `R` caso a recorrência tenha sido criada dentro do Pix. `C` caso tenha sido criada pela trilha do Open Finance. 2º caractere `R` ou `N` - Fixo `R` caso a recorrência permita novas tentativas de pagamento pós vencimento `N` caso não permita novas tentativas. `xxxxxxxx` identificação do agente que presta serviço para o usuário recebedor que gerou o Pix Automático, podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros dígitos do CNPJ do prestador de serviço de iniciação (8 caracteres numéricos nkly.); `yyyyMMdd`: data (8 caracteres) de criação da recorrência; `kkkkkkkkkkk`: sequencial criado pelo agente que gerou o Pix Automático (11 caracteres alfanuméricos s://docs.bank). Deve ser único dentro de cada ""yyyyMMdd"".

Corpo da requisição (Body)

Não é necessário enviar campos no Body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.

📘
Sobre o cancelamento de uma autorização
Quando o cancelamento da autorização for realizada com sucesso será retornado response 200.
Devido a ser um fluxo paralelo, ao receber um código 200, não significa que todos os agendamentos atrelados à autorização foram cancelados. Por isso, após cancelar a autorização, quem consome os serviços da Bankly deveconsultar os agendamentos vinculados à autorização. Caso existam agendamentos ativos, é necessário acionar o serviço de cancelamento do agendamento para garantir que todas as transações vinculadas à autorização sejam efetivamente encerradas.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`authorizationId`	`string`	Identificador da recorrência e da autorização
`reason`	`string`	Tipo do cancelamento. `SLDB`: Cancelamento solicitado pelo usuário pagador
`status`	`string`	Status da autorização.
`scheduling`	`objeto`	Objeto contendo todos os agendamentos relacionados a essa autorização, sendo eles pagos, não pagos, retentivas e os agendamentos futuros que foram cancelado com sucesso.
`scheduling.transactionIdentification`	`string`	Identificador único da transação, enviado na pain.013 que originou a ordem de pagamento
`scheduling.endToEnd`	`string`	Identificação da instrução de pagamento
`scheduling.status`	`string`	Status do agendamento

{
  "authorizationId": "RR595881112025031252S6M18DDD1",
  "reason": "SLDB",
  "status": "CANCELED",
  "scheduling": [
    {
      "transactionIdentification": "afb1c976-0195-1000-fb69-sadsaffa8641d",
      "endToEnd": "E5958811120250324200809925PFR97O",
      "status": "CANCELED"
    },
    {
      "transactionIdentification": "afb1c976-0195-1000-fb69-sadsaffa8641d",
      "endToEnd": "E5958811120250324200809925PFR971",
      "status": "CANCELED"
    }
  ]
}

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated 14 days ago