Tranzakt APIs

Get Collection by ID

GET

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

Returns comprehensive details about a collection, including its settings, accounts, and current status.

Request

Path Params

string

required

The unique identifier of the collection

Example:

550e8400-e29b-41d4-a716-446655440000

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/collections/550e8400-e29b-41d4-a716-446655440000' \
--header 'x-api-key: Your secret key'

Responses

🟢200OK

application/json

Body

object {0}

Examples

SuccessException

{
    "status": "success",
    "message": "Collection details fetched successfully",
    "data": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "collectionName": "Q1 Sales Collection",
        "description": "Q1 2024 sales collection",
        "invoiceExpirationPeriod": "OneDay",
        "paymentChannels": [
            "Card",
            "BankTransfer"
        ],
        "settlementFrequency": "Daily",
        "serviceFeeBilling": "Payer",
        "amount": 1000,
        "dateCreated": "2024-03-21T10:00:00Z",
        "status": "Active",
        "collectionCategory": {
            "id": "a7e3a0eb-4e55-4741-a6d1-bf453c0e9b31",
            "name": "Test Category"
        },
        "collectionAccounts": [
            {
                "percentage": 100,
                "linkedAccount": {
                    "id": "a7e3a0eb-5f27-4741-a6d1-bf453c0e9b31",
                    "accountName": "Main Account",
                    "accountNumber": "0123456789",
                    "bank": {
                        "id": "b8f4b1fc-6e38-5852-b7e2-cf564d1f0a42",
                        "name": "Sample Bank",
                        "code": "042",
                        "logo": "https://example.com/image.png"
                    }
                }
            }
        ]
    }
}

Modified at 2024-11-07 01:24:29

Collections

Get Collection Invoices