Cancelar recorrência

stable

Este endpoint permite que o usuário pagador possa solicitar o cancelamento de uma recorrência de agendamento.

Pré-requisito

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

O cliente de nosso parceiro possua uma recorrência de agendamentos criada.

Requisição (Request)

Requisição HTTP

DELETE https://api-mtls.sandbox.bankly.com.br/pix/scheduling-payments/recurrences/{requestIdentifier}

curl --request DELETE \
     --url https://api-mtls.sandbox.bankly.com.br/pix/scheduling-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
`pix.schedule-payment.write`	Concede acesso para cancelar uma recorrência de agendamento.

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
`requestIdentifier`	`path`	Obrigatório. Identificador da recorrência.	—

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.

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

Nome	Tipo	Descrição
`recurrence`	`objeto`	Objeto que contem os dados da recorrência.
`recurrence.requestIdentifier`	`string`	Identificador da recorrência.
`recurrence.status`	`string`	Status da recorrência.
`scheduling`	`array`	Array que contem os agendamentos atrelados à recorrência.
`scheduling.requestIdentifier`	`string`	Identificador do agendamento atrelado à recorrência.
`scheduling.status`	`string`	Status do agendamento atrelado à recorrência.

{
  "recurrence": {
    "requestIdentifier": "R1314008820250926102859521EET8W2KAYM",
    "status": "CANCELED"
  },
  "scheduling": [
    {
      "requestIdentifier": "E1314008820251008172412216AM1HGM",
      "status": "SUCCESS"
    },
    {
      "requestIdentifier": "E1314008820251008172412217AH5TV6",
      "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 about 2 hours ago