Bitsby documentation
Bitsby documentation
Bitsby documentation
Bitsby documentation
  • General information
  • Balance and tariffs
  • FAQ
  • Invoice creation
    • In my personal account
    • In the telegram bot
    • HTML forms and links
    • Via API
  • Settings
    • Wallets
    • Payment by bank cards
  • API documentation
    • General information
    • Invoice list
    • Invoice creation
    • Invoice cancellation
    • Bind payment to invoice
    • List of payments
    • Invoice statistics
    • Payment statistics
    • User balances
    • Balance change history
    • Project tariffs
  • Webhook URL
  • Plugins for online stores and CMS
  • Документация на русском
Powered by GitBook
On this page
  • Description
  • Request
  • Request parameters
  • Пример ответа
  1. API documentation

Invoice cancellation

Description

An invoice can be canceled to prevent the buyer from paying the invoice. This is necessary if an error has been made on the invoice. An invoice can only be canceled if two conditions are met:

  • Invoice status: not paid

  • Payment page views: 0 views

Request

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

Request parameters

Parameter
Data type
Description
Example
Mandatory?

invoiceId

UUID

Invoice ID in UUID format

ade9550d-3dc7-4fd3-b94e-3b4c12aaaa0c

yes

Пример ответа

{
   "result":"success",
   "data":"Invoice canceled"
}
PreviousInvoice creationNextBind payment to invoice

Last updated 1 year ago