Businesses

List the businesses associated with your account and discover tenant context for other SDK operations.

The business module is where most server integrations discover their tenant context. It gives you the business IDs that other SDK features depend on.

Install

npm install @wistfare/core @wistfare/business

pip install wistfare

go get github.com/wistfare/wistfare-go

dependencies:
  wistfare_core: ^0.1.0
  wistfare_business: ^0.1.0

cargo add wistfare

dependencies: [
  .package(path: "../sdks/swift")
]

implementation("com.wistfare:sdk:0.1.0")

dotnet add package Wistfare.Core
dotnet add package Wistfare.Business

Get the Business Client

import { Wistfare } from '@wistfare/core';
import { BusinessClient } from '@wistfare/business';

const wf = new Wistfare({
  apiKey: process.env.WISTFARE_API_KEY!,
});

const businesses = new BusinessClient(wf);

from wistfare import Wistfare

wf = Wistfare(api_key="wf_live_xxx")

businesses = wf.businesses

import (
  "os"

  "github.com/wistfare/wistfare-go/business"
  "github.com/wistfare/wistfare-go/core"
)

client := core.New(os.Getenv("WISTFARE_API_KEY"))
businesses := business.New(client)

import 'package:wistfare_core/wistfare_core.dart';
import 'package:wistfare_business/wistfare_business.dart';

final wf = Wistfare(apiKey: 'wf_live_xxx');
final businesses = BusinessClient(wf);

use wistfare::Wistfare;

let client = Wistfare::new("wf_live_xxx")?;
let businesses = client.businesses();

import Wistfare

let client = try Wistfare(apiKey: "wf_live_xxx")
let businesses = client.businesses

import com.wistfare.sdk.Wistfare
import com.wistfare.sdk.WistfareConfig

val client = Wistfare(WistfareConfig(apiKey = "wf_live_xxx"))
val businesses = client.businesses

using Wistfare.Core;
using Wistfare.Business;

var client = new WistfareClient(new WistfareOptions
{
    ApiKey = Environment.GetEnvironmentVariable("WISTFARE_API_KEY")!,
});

var businesses = new BusinessClient(client);

Get a Business

Retrieve the full details of a single business by ID.

const business = await businesses.get('biz_123');

business = businesses.get("biz_123")

business, err := businesses.Get(ctx, "biz_123")

final business = await businesses.get('biz_123');

var business = await businesses.GetAsync("biz_123");

curl -X GET "https://api-production.wistfare.com/v1/businesses/biz_123" \
  -H "X-API-Key: wf_live_xxx"

Response

{
  "id": "biz_123",
  "ownerId": "usr_1",
  "name": "Test Cafe",
  "slug": "test-cafe",
  "description": "A cozy cafe in Kigali",
  "businessType": "restaurant",
  "category": "food_beverage",
  "logoUrl": "https://img.example.com/logo.png",
  "coverImageUrl": "https://img.example.com/cover.png",
  "address": {
    "city": "Kigali",
    "street": "123 Main St",
    "district": "Gasabo",
    "country": "RW"
  },
  "contact": {
    "phone": "+250781234567",
    "email": "info@testcafe.rw"
  },
  "walletId": "wal_456",
  "isVerified": true,
  "status": "active",
  "rating": 4.5,
  "reviewCount": 120,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-15T00:00:00Z"
}

List Businesses

const result = await businesses.list({
  businessId: 'biz_123',
  page: 1,
  perPage: 20,
});

result = businesses.list(business_id="biz_123", page=1, per_page=20)

result, err := businesses.List(ctx, &business.ListParams{
  BusinessID: "biz_123",
  Page:       1,
  PerPage:    20,
})

final result = await businesses.list(
  businessId: 'biz_123',
  page: 1,
  perPage: 20,
);

var result = await businesses.ListAsync(new ListBusinessesParams
{
    BusinessId = "biz_123",
    Page = 1,
    PerPage = 20,
});

curl -X GET "https://api-production.wistfare.com/v1/businesses?businessId=biz_123&page=1&perPage=20" \
  -H "X-API-Key: wf_live_xxx"

Use this first when your server needs to discover the business ID it should attach to collections, fees, wallet settings, or disbursements.