Wallet & Balance API

Angalia salio za pochi katika sarafu mbalimbali.

Salio la Mazingira ya Majaribio: Salio la akaunti za majaribio hutofautiana kulingana na akaunti. Akaunti mpya zinaweza kuanza na salio sifuri. Wasiliana na timu ya admin kuomba kuongezewa salio kwa majaribio.

Pata Salio

Pata salio la pochi kwa sarafu maalum au sarafu zote.


GET /business/balance

Vigezo vya Hoja (Query)

Kigezo	Aina	Inahitajika	Maelezo
`currency`	string	Hapana	Msimbo wa sarafu (USD, KES, TZS, UGX, ZAR). Ikiachwa, inarudisha salio zote

Mifano ya Maombi

Sarafu Moja


curl https://api.test.wakapay.io/business/balance?currency=USD \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"


const response = await fetch(
  "https://api.test.wakapay.io/business/balance?currency=USD",
  {
    headers: {
      Authorization: "Bearer YOUR_ACCESS_TOKEN",
    },
  },
);
 
const balance = await response.json();
console.log(balance);


import requests
 
response = requests.get(
    'https://api.test.wakapay.io/business/balance',
    params={'currency': 'USD'},
    headers={'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}
)
 
balance = response.json()
print(balance)

Sarafu Zote


curl https://api.test.wakapay.io/business/balance \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Jibu la Mafanikio — Sarafu Moja

Msimbo wa Hali: 200 OK


{
  "available": 5000000,
  "businessId": "019d****-****-****-****-********19c3",
  "currency": "USD",
  "holding": 0,
  "pending": 0
}

Jibu la Mafanikio — Sarafu Zote

Msimbo wa Hali: 200 OK


{
  "businessId": "019d****-****-****-****-********19c3",
  "items": [
    {
      "available": 5000000,
      "currency": "USD",
      "holding": 0,
      "pending": 0
    },
    {
      "available": 0,
      "currency": "KES",
      "holding": 0,
      "pending": 0
    },
    {
      "available": 0,
      "currency": "TZS",
      "holding": 0,
      "pending": 0
    }
  ]
}

Sehemu za Jibu

Sehemu	Aina	Maelezo
`available`	number	Salio linalopatikana ambalo linaweza kutumika kwa malipo ya nje
`businessId`	string	Kitambulisho cha biashara yako
`currency`	string	Msimbo wa sarafu (USD, KES, TZS, UGX, ZAR)
`holding`	number	Fedha zilizoshikiliwa (zilizotengwa kwa miamala inayoshughulikiwa)
`pending`	number	Fedha zinazosubiri (miamala inayoendelea)
`items`	array	Safu ya vitu vya salio (unapouliza sarafu zote)

Hali za Salio

Salio Linalopatikana

Fedha ambazo zinaweza kutumika mara moja kwa malipo ya nje. Hili ndilo salio unalopaswa kuangalia kabla ya kuanzisha malipo ya nje.

Salio Lililoshikiliwa

Fedha zilizotengwa kwa muda kwa:

Miamala inayoshughulikiwa
Malipo ya nje yanayosubiri
Vizuizi vya usimamizi wa hatari

Fedha hizi zitarudishwa kwenye linalopatikana au kuhamishiwa kwa zinazosubiri mara muamala unapokamilika.

Salio Linalosubiri

Fedha kutoka kwa:

Uhamishaji unaoingia
Marejesho yanayoshughulikiwa
Makusanyo yanayotatuliwa

Fedha hizi zitakuwa zinapatikana mara baada ya kushughulikiwa kikamilifu.

Majibu ya Makosa

401 — Authorization Inakosekana

Kichwa cha Authorization kinakosekana:


{
  "message": "missing value in request header"
}

401 — Tokeni Isiyo Sahihi

Tokeni ya JWT iliyoharibika au isiyo sahihi:


{
  "message": "token is malformed: token contains an invalid number of segments"
}

Msimbo wa Sarafu Usio Sahihi

Ukiuliza sarafu isiyo sahihi au isiyoungwa mkono, API inarudisha salio sifuri badala ya kosa:


{
  "available": 0,
  "businessId": "019d****-****-****-****-********19c3",
  "currency": "INVALID",
  "holding": 0,
  "pending": 0
}

Sarafu Zinazoungwa Mkono

Sarafu	Msimbo	Nchi
Dola ya Marekani	USD	Miamala ya kuvuka mipaka
Shilingi ya Kenya	KES	Kenya
Shilingi ya Tanzania	TZS	Tanzania
Shilingi ya Uganda	UGX	Uganda
Randi ya Afrika Kusini	ZAR	Afrika Kusini

Mifano ya Matumizi

Angalia Kabla ya Malipo ya Nje

Daima angalia salio linalopatikana kabla ya kuanzisha malipo ya nje:


async function sendPayout(amount, currency) {
  // Check balance first
  const balanceResponse = await fetch(
    `https://api.test.wakapay.io/business/balance?currency=${currency}`,
    {
      headers: { Authorization: `Bearer ${token}` },
    },
  );
 
  const balance = await balanceResponse.json();
 
  if (balance.available < amount) {
    throw new Error("Insufficient balance");
  }
 
  // Proceed with payout
  // ...
}

Fuatilia Pochi Zote


async function getAllBalances() {
  const response = await fetch("https://api.test.wakapay.io/business/balance", {
    headers: { Authorization: `Bearer ${token}` },
  });
 
  const data = await response.json();
 
  // Display all balances
  data.items.forEach((wallet) => {
    console.log(`${wallet.currency}: ${wallet.available} available`);
  });
 
  return data.items;
}

Mbinu Bora

Angalia kabla ya malipo ya nje: Daima thibitisha salio la kutosha kabla ya kuanzisha malipo ya nje
Fuatilia holding: Salio kubwa la holding linaweza kuashiria miamala inayosubiri
Linganisha sarafu: Hakikisha unaangalia sarafu sahihi kwa malipo yako ya nje
Uunganishaji wa webhook: Sanidi webhooks kufuatilia mabadiliko ya salio kwa wakati halisi
Vikomo vya tahadhari: Sanidi tahadhari salio linaposhuka chini ya kikomo

Yanayohusiana

FX Rates API — Pata viwango vya ubadilishaji wa sarafu
Payouts API — Tuma pesa kwa kutumia salio lako
Transactions API — Tazama historia ya miamala