Cancel an invoice

Cancels an unpaid invoice.

DELETE/invoices/{invoiceId}

System information

API key: Required
Rate limit: ∞

curl -X DELETE "https://api.atomic.wallet/api/v1/invoices/{invoiceId}" \
  -H "x-api-key: $API_KEY"

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "projectUuid": "73e68013-32f0-4248-95ac-46aed61e59b0",
  "coinCode": "USDT",
  "networkCode": "tron",
  "coinName": "Tether USD",
  "networkName": "TRON",
  "networkPrefix": "TRC-20",
  "amount": "100.000000",
  "sourceAmount": "100.00",
  "sourceCurrency": "USD",
  "sourceRate": "1.000000",
  "status": "cancelled",
  "confirmedAmount": "0.000000",
  "unconfirmedAmount": "0.000000",
  "remainingAmount": "100.000000",
  "overpaidAmount": "0.000000"
}

Response fields

Parameter	Type	Description
uuid	string	Invoice UUID.
projectUuid	string	Project UUID.
coinCode	string	Cryptocurrency code.
networkCode	string	Blockchain network code.
coinName	string	Cryptocurrency name.
networkName	string	Network name.
networkPrefix	string	Token standard in the network, for example `TRC-20`.
amount	string	Amount to pay in cryptocurrency.
sourceAmount	string	Invoice amount in the source currency.
sourceCurrency	string	Invoice source currency.
sourceRate	string	Conversion rate from the source currency to cryptocurrency.
status	string	Invoice status, see “Statuses”.
confirmedAmount	string	Paid and confirmed amount.
unconfirmedAmount	string	Received but not yet confirmed amount.
remainingAmount	string	Amount left to pay.
overpaidAmount	string	Overpaid amount.

Possible errors

HTTP	Code	Description
404	`INVOICE_NOT_FOUND`	Invoice not found.
400	`INVOICE_CANCELLATION_NOT_ALLOWED`	The invoice cannot be cancelled.

← PreviousRetrieve an invoice Next →Invoice transactions