[PATCH] /payments/:id/cancel

Cancela uma cobrança Bolepix

Essa funcionalidade permite que os clientes da Firebanking consigam cancelar uma cobrança.

Endpoint de produçãoCopied!

Método PATCH

https://bank-slip-api.firebanking.com.br/payments/:id/cancel

RequisiçãoCopied!

Headers

Campo	Valor	Tipo	Descrição
Content-Type	application/json	string	Define o conteúdo como JSON
apiKey	123	string	Sua chave de API

Parâmetros da rota

Campo	Obrigatório	Descrição
id	Sim	ID retornado no momento da criação do boleto ou external id enviado no body da criação do boleto

Curl:

curl --request GET \
  --url 'https://bank-slip-api.firebanking.com.br/payments/<id>/cancel' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <sua-chave-api>'

Resposta:

A rota retorna um status HTTP 204 No Content, indicando que a solicitação foi bem-sucedida, mas não há conteúdo a ser retornado.