Skip to main content

Kavodax Partner API Documentation

Complete API reference and integration guides

Dashboard

Welcome to Kavodax Partner API

Here, you'll find complete API references, step-by-step guides, and end-to-end workflow examples to help you integrate our payment infrastructure quickly and confidently.

Quick Start

  1. Register your application to receive API credentials
  2. Set up HMAC authentication with your API Key and Secret Key
  3. Create a customer and initiate KYC verification
  4. Test onramp transactions in sandbox mode
  5. Test offramp transactions in sandbox mode
  6. Configure webhooks to receive real-time updates

Base URL

Sandbox:https://app.kavodax.com/api/partner/v1

Production environment coming soon. All testing should be done in sandbox mode.

Core API Concepts

Before integrating, get familiar with these core concepts

Authentication

All API requests require authentication using API Key and Secret Key. Requests are signed using HMAC-SHA256 to ensure security and prevent tampering.

Customers

Customers represent end-users in your platform. Each customer must complete KYC verification before conducting transactions. Customers can have multiple transactions and recipients.

Transactions

Track onramp and offramp transactions with real-time status updates. Transactions go through multiple states: initiated, pending, completed, or failed.

Webhooks

Receive real-time notifications about transaction status changes, KYC updates, and balance changes. All webhooks include HMAC signatures for verification.

Integration Checklist

→

Register your application

Get your API credentials from the Partner Portal

→

Implement HMAC authentication

Sign all API requests with your secret key

→

Test in sandbox environment

Use simulation endpoints to test your integration

→

Set up webhook endpoints

Receive real-time transaction updates

→

Test thoroughly in sandbox

Use simulation endpoints to test all scenarios before going live

Testing with Postman

We provide a complete Postman collection with pre-configured requests for all API endpoints, including HMAC authentication setup and sandbox simulation examples.

Download Postman Collection

Import this collection to get started with all API endpoints pre-configured

Download Collection

Import Postman Collection

  1. Download the collection file from the Partner Portal
  2. Open Postman and click "Import" in the top left
  3. Drag and drop the collection file or browse to select it
  4. The collection will appear in your sidebar with all endpoints

Configure Environment Variables

After importing, set up these environment variables in Postman:

baseUrlhttps://app.kavodax.com
apiKeyYour API Key (pk_...)
secretKeyYour Secret Key (sk_...)
customerIdTest customer ID (auto-populated after KYC)

Pre-Request Script

The collection includes a pre-request script that automatically generates HMAC signatures for all requests. You don't need to manually sign requests in Postman.

The script reads your api_key and secret_key from environment variables and calculates the signature for each request before sending it.

Collection Structure

📁
Authentication- Create Customer, Initiate KYC & Simulate KYC Approval
📁
Onramp Bank- Initiate On-Ramp - Bank (USD)
📁
Onramp Interac- Interac On-Ramp & Simulate Interac Accept
📁
On ramp failure & pending patterns- Showing failure and pending patterns for Onramp
📁
Off ramp & simulation- Getting schema, Creating recipient, Quote to Initiation & Simulating fee and deposit
📁
Off ramp failure patterns- Showing failure patterns for Offramp with fee & email

Testing Tips

  • •Run requests in order: Registration → KYC → Transactions
  • •Save customer IDs and transaction IDs from responses to reuse in subsequent requests
  • •Check the "Tests" tab in each request to see automatic validations