Partner API

Transactions

Detailed financial ledgers for every credit and debit event across your partner ecosystem. Use for monthly billing reconciliation, dispute resolution, and auditing balance movements between your account and your customers.

Overview

Two endpoints cover different scopes of transaction data:

/accounts/{id}/transactionsSingle customer

All debits and credits for one specific customer. Use for per-customer invoicing and customer-facing statements.

/transactionsAll customers

Global ledger across every customer under your partner account. Use for platform-wide reconciliation and monthly financial close.

Customer Transactions

GEThttps://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/transactions

Returns a paginated transaction ledger for one specific customer. Filter by transaction type and date range to generate statements for a specific billing period.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

Query Parameters

Parameter	Default	Description
page	1	Page number
per_page	20	Records per page (max 100)
transaction_type	(all)	Filter by type: recharge, debit, adjustment, refund
from_date	(none)	Start date filter — YYYY-MM-DD
to_date	(none)	End date filter — YYYY-MM-DD

cURL — All transactions for a customer

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/transactions?page=1&per_page=20" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

cURL — Billing cycle (March 2026)

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/transactions?from_date=2026-03-01&to_date=2026-03-31&per_page=100" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

cURL — Recharges only

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/transactions?transaction_type=recharge&per_page=50" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK

{
  "data": [
    {
      "id": "txn_abc123",
      "type": "recharge",
      "amount": 500.00,
      "currency": "INR",
      "balance_before": 1950.00,
      "balance_after": 2450.00,
      "description": "April recharge — Credresolve",
      "initiated_by": "partner-882abc",
      "created_at": "2026-03-25T11:00:00Z"
    },
    {
      "id": "txn_def456",
      "type": "debit",
      "amount": -12.45,
      "currency": "INR",
      "balance_before": 2450.00,
      "balance_after": 2437.55,
      "description": "Call usage — 27 calls, 415 minutes",
      "created_at": "2026-03-25T23:59:00Z"
    }
  ],
  "meta": {
    "total": 48,
    "page": 1,
    "per_page": 20
  }
}

All Transactions (Global)

GEThttps://api.vobiz.ai/api/v1/partner/transactions

Global reconciliation log — all transaction events across every customer under your partner account in a single paginated response. Same filter parameters as the per-customer endpoint. Essential for platform-wide monthly financial close.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

cURL — Global transactions

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/transactions?page=1&per_page=50" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

cURL — Global billing cycle

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/transactions?from_date=2026-03-01&to_date=2026-03-31&transaction_type=debit&per_page=100" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

Response Fields

Field	Type	Description
id	string	Unique transaction ID for dispute resolution and deduplication
type	string	Transaction type — see Transaction Types below
amount	number	Positive for credits (recharge, refund), negative for debits
currency	string	Currency code (INR)
balance_before	number	Customer wallet balance immediately before this transaction
balance_after	number	Customer wallet balance immediately after this transaction
description	string	Human-readable note — set by partner on recharges, auto-generated for usage debits
initiated_by	string	Partner auth_id for recharges, system for automatic usage debits
created_at	ISO 8601	Transaction timestamp in UTC

Transaction Types

recharge

Partner transferred balance to the customer wallet. Amount is positive.

debit

Automatic usage deduction for completed calls. Amount is negative. Generated daily or per-call depending on configuration.

adjustment

Manual balance correction by Vobiz support. Amount can be positive or negative.

refund

Credit issued for a disputed charge or service outage. Amount is positive.

Monthly Billing Guide

Use transactions to generate accurate invoices for your customers:

Pull all debits for the billing period

Query /accounts/{id}/transactions?transaction_type=debit&from_date=YYYY-MM-01&to_date=YYYY-MM-31. Sum the amounts for total usage cost.

Add your margin

Your customers pay you the Vobiz rate plus your markup. The debit amount is your cost. Invoice your customer for cost + margin.

Check recharge history

Pull transaction_type=recharge for the same period to reconcile what you loaded into the customer wallet vs. what they consumed.

Global reconciliation

Use /transactions (global) to sum all debits across all customers for your monthly Vobiz bill reconciliation.

Balance Transfer

CDRs