Tranzakt Payment Platform (TPP) React SDK

A React library for seamless integration with Tranzakt Payment Platform APIs. This SDK simplifies your integration by providing an intuitive interface for making API calls.

Installation

npm install --save tranzakt-react-sdk
# or
yarn add tranzakt-react-sdk

Quick Start

import { Tranzakt } from "tranzakt-react-sdk";

const tranzakt = new Tranzakt("your-public-key");

Core Features

1. Invoice Operations

Create Invoice

Creates a new payment invoice for a collection. Supports both fixed and variable amounts, multiple beneficiaries, and custom metadata for integration with your systems.

// Create a new invoice
const response = await tranzakt.createInvoice({
  // Required parameters
  collectionId: "37a71e2e-ed54-4e46-a3a9-47a211c352ea",
  payerEmail: "[email protected]",
  payerName: "John Doe",
  payerPhoneNumber: "07078955432",
  title: "Checkout Invoice",

  // Optional parameters (some may be required based on collection settings)
  amount: 40000, // Required if collection has no fixed amount
  invoiceBeneficiaries: [
    {
      linkedAccountId: "02VUJZW14MER86VWAFWDQGH92T",
      amount: 20000,
    },
  ], // Required if collection has no fixed beneficiaries
  callBackUrl: "https://your-callback-url.com/webhook",
  billerMetaData: {
    "order-id": "12345",
  },
});

if (response.success) {
  const invoice = response.data;
  console.log(`Payment URL: ${invoice.paymentUrl}`);
}

Response example:

{
  success: true,
  data: {
    id: "inv-001",
    title: "Checkout Invoice",
    collectionName: "Product Sales",
    payerName: "John Doe",
    payerEmail: "[email protected]",
    payerPhoneNumber: "07078955432",
    billerName: "Example Business",
    billerAddress: "123 Business St",
    billerEmail: "[email protected]",
    amount: 40000,
    serviceCharge: 400,
    vat: 0,
    totalAmount: 40400,
    invoiceStatus: "Unpaid",
    serviceFeePayer: "Payer",
    settlementFrequency: "Instant",
    type: "Live",
    paymentUrl: "https://pay.tranzakt.finance/inv-001",
    dateCreated: "2024-03-24T12:00:00Z",
    dateModified: "2024-03-24T12:00:00Z",
    paymentDate: "",
    paymentMethod: "Card",
    invoiceBeneficiaries: [
      {
        amount: "20000",
        linkedAccountId: "37a71e2e-ed54-4e46-a3a9-47a211c352ea",
        accountName: "Business Account",
        accountNumber: "1234567890",
        bankName: "Example Bank",
        businessName: "Example Business"
      }
    ],
    billerMetaData: {
      "order-id": "12345"
    },
    callBackUrl: "https://your-callback-url.com/webhook"
  },
  status: 201,
  message: "Invoice created successfully"
}

Error Handling

The SDK provides detailed error information when something goes wrong:

try {
  const invoice = await tranzakt.createInvoice(/* ... */);
} catch (error) {
  console.error(`${error.status}: ${error.message}`);
  console.error("Error type:", error.type);
  console.error("Details:", error.errors);
}

Common Error Scenarios:

• 400: Invalid request (missing required fields, incorrect amounts)
• 403: Permission denied (disabled collection, wrong API key type)
• 412: Business validation failed (unverified beneficiary, missing collection owner)

Important Notes

When creating invoices:

1. Don't specify amount if collection has fixed amount
2. Must specify amount if collection has no fixed amount
3. Don't specify beneficiaries if collection has fixed beneficiaries
4. Must specify beneficiaries if collection has no fixed beneficiaries
5. Collection owner must be included in beneficiaries
6. All beneficiary accounts must be verified (KYB completed)

Support

• Email: [email protected]
• Docs: https://docs.tranzakt.com

License

MIT License - © TRANZAKT FINANCIAL SERVICES LIMITED