Tranzakt APIs

Get Invoice by ID

GET

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

Returns comprehensive details about an invoice, including its current status and payment information.

Request

Path Params

string

required

Invoice ID

Header Params

x-api-key

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200OK

application/json

Body

object {0}

Examples

SuccessException

{
    "status": "success",
    "message": "Invoice fetched successfully",
    "data": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "title": "Invoice #123",
        "collectionName": "Q1 Sales Collection",
        "payerName": "John Doe",
        "payerEmail": "john@example.com",
        "payerPhoneNumber": "2348012345678",
        "billerName": "ABC Company",
        "amount": 1000,
        "serviceCharge": 50,
        "vat": 75,
        "totalAmount": 1125,
        "invoiceStatus": "Paid",
        "paymentDate": "2024-03-21T10:30:00Z",
        "paymentMethod": "Card"
    }
}

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

Create Invoice

Invalidate Invoice