Tranzakt APIs
    Tranzakt APIs
    • Introduction
    • Collections
      • Get Collection by ID
        GET
      • Get Collection Invoices
        GET
    • Invoices
      • Create Invoice
        POST
      • Get Invoice by ID
        GET
      • Invalidate Invoice
        POST
    • Webhooks
      • Webhooks 🔔

    Introduction

    Welcome to Our API Platform 👋#

    Welcome to our API documentation! Our platform provides robust and flexible APIs designed to help you integrate powerful payment solutions into your applications. Whether you're building a new fintech product or enhancing your existing payment infrastructure, our APIs offer the tools you need to create seamless financial experiences for your users.

    Overview#

    Our API platform offers a robust set of endpoints that enable you to:
    Process payments securely
    Manage financial transactions
    Handle settlements efficiently
    Track payment statuses in real-time
    Create customized payment flows
    Implement split payments
    Generate comprehensive reports

    🎯 Key Features#

    Secure: Built with industry-standard security practices
    Scalable: Designed to handle transactions at any scale
    Flexible: Adaptable to various business models
    Real-time: Instant updates and notifications
    Reliable: High availability and consistent performance
    Developer-Friendly: Clear documentation and support

    📚 Documentation Sections#

    1.
    Getting Started Guide
    2.
    Authentication & Security
    3.
    API References


    Getting Started#

    Welcome to our API platform! This guide will help you get started with integrating our APIs into your application.

    Understanding API Keys#

    Our platform uses API keys for authentication. Each account has access to both test and live API keys from the dashboard:
    Test Keys: For development and testing
    Live Keys: For production use and real transactions

    Base URL#

    All API requests should be made to:
    https://api.tranzakt.finance

    Environment Support#

    We provide two environments to support your development process:
    Test Environment: For development and testing
    Live Environment: For production use

    Key Types#

    Test Secret Key: For development and testing
    Test Public Key: For client-side operations in test mode
    IP Whitelist: Required for API access

    Authentication#

    All our external APIs use API key authentication via the x-api-key header.

    Common Headers#

    http#

    Setting Up Your API Access#

    1. Obtaining Your API Key
    To get your API key:
    1
    First Step
    Log in to your merchant dashboard
    2
    Second Step
    Click 'Settings' in the sidebar menu
    3
    Third Step
    Select 'API Keys & Webhooks'
    4
    Fourth Step
    Once processed, you'll receive both test and live API keys
    5
    Fifth Step
    The Secret Key provided will be your x-api-key.
    Note: The Test/Live mode can be toggled using the switch in the top right corner of the API Keys page
    🔑 Keep your API keys secure and never share them publicly

    2. IP Whitelisting
    For enhanced security, you must whitelist the IP addresses that will access our APIs:
    Go to API Settings in your dashboard
    Navigate to "Settings" > "API Keys & Webhooks" > "IP Whitelist"
    Add your application's IP addresses
    Save your changes
    ⚠️ Only requests from whitelisted IPs will be processed

    Integration Process#

    1.
    Development Phase
    Use test API keys for development
    Test all required functionality
    Implement error handling
    Set up webhook endpoints
    2.
    Going Live
    Return to 'API Keys and Webhooks' in Settings
    Toggle the 'Test Mode' button to switch you to 'Live Mode'
    Follow the necessary steps in the verification process
    Switch to your live API key after approval
    🔐 Security Note: Whether test or live, always keep your API keys secure and never expose them in client-side code or public repositories.


    API Key Requirements#

    RequirementDescription
    IP WhitelistingClient IP must be in the whitelisted IPs list
    Key Type MatchAPI key must match environment (Test/Live)
    Header FormatMust be included as x-api-key: secretKey

    Modified at 2024-11-12 15:26:57
    Next
    Collections
    Built with