Invalidate Invoice

POST

https://api.tranzakt.finance/api/v1/invoices/{id}/invalidate

Marks an unpaid invoice as invalid, preventing it from being paid.

Validation Rules

Invoice Exists: Invoice must exist
Error Message: "Invoice with the given Id does not exist"

Invoice Status: Must be unpaid
Error Message: "The invoice has already been paid or is no longer valid"

Request

Path Params

string

required

Invoice ID

Header Params

x-api-key

string

required

Example:

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.tranzakt.finance/api/v1/invoices//invalidate' \
--header 'x-api-key: Your secret key'

🟢200OK

application/json

Body

object {0}

Examples

SuccessException

{
    "status": "success",
    "message": "Invoice invalidated successfully"
}

Modified at 2024-11-07 01:27:52