Developer Documentation

API Endpoints

GET /api/v1/transactions

POST /api/v1/payments

GET /api/v1/payments/{id}/status

Hooks

Use the following hooks to customize VTUmax:

• vtumax_before_payment - Triggered before a payment is processed.
• vtumax_after_payment - Triggered after a payment is completed.
• vtumax_on_error - Triggered when an error occurs during a transaction.

Filters

Modify VTUmax behavior with these filters:

• vtumax_payment_gateway - Customize the payment gateway options.
• vtumax_transaction_fee - Adjust the transaction fee dynamically.
• vtumax_currency_format - Modify the currency display format.

Examples

Here are some examples to get you started:

    // Example: Fetch transactions
    fetch('/api/v1/transactions')
        .then(response => response.json())
        .then(data => console.log(data));

    // Example: Initiate a payment
    fetch('/api/v1/payments', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify({ amount: 1000, currency: 'NGN' })
    }).then(response => response.json())
      .then(data => console.log(data));
                

FAQ

Find answers to common questions:

• How do I get an API key? Sign up on our platform and navigate to the API section.
• What is the rate limit for API requests? The default limit is 100 requests per minute.
• Can I test the API in a sandbox environment? Yes, we provide a sandbox mode for testing.