Cancelar uma cobrança

Visão geral

Você pode cancelar uma cobrança para que o cliente não possa mais pagá-la. Isso é útil quando a cobrança contém um erro. O cancelamento exige duas condições:

• Status da cobrança: Em aberto
• Visualizações da página de pagamento: 0

Se a cobrança pertencer a outro projeto e a chave estiver restrita a um projeto, o método responde com Restricted project. Se você não tiver nenhuma cobrança com esse identificador — Invoice not found. Se a cobrança for encontrada mas as condições de cancelamento não forem atendidas — Invoice cannot be canceled.

Requisição

curl -X POST https://api.bitsby.app/invoices/cancel \
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
	-F "invoiceId=ade9550d-3dc7-4fd3-b94e-3b4c12aaaa0c"

Parâmetros da requisição

Parâmetro	Tipo de dado	Descrição	Exemplo	Obrigatório?
invoiceId	UUID	ID da cobrança no formato UUID	ade9550d-3dc7-4fd3-b94e-3b4c12aaaa0c	sim

Exemplo de resposta

{
   "result":"success",
   "data":"Invoice canceled"
}