API ya Biashara

Hati za Washirika wa Nje

Muhtasari

Hii inaeleza API ya Biashara ya Wakapay kwa washirika wa nje. Kwa kutumia API hii unaweza kuthibitisha utambulisho, kusimamia salio la pochi, kupata viwango vya FX, kuthibitisha wapokeaji, kuanzisha malipo ya nje, na kuuliza miamala — yote kupitia HTTPS salama.

Maombi yote na majibu yote yanatumia JSON. Mifano ya msimbo inatumia curl kwa uwazi.

Mazingira na URL za Msingi

Wakapay inatoa mazingira tofauti ya Majaribio na ya Uzalishaji.

Mazingira ya Majaribio

• URL ya Msingi: https://api.test.wakapay.io
• Madhumuni: Maendeleo na majaribio bila kushughulikia miamala halisi
• Vitambulisho vya Majaribio: Hutolewa unapofungua akaunti ya msanidi
• Hakuna pesa halisi inayoshughulikiwa

Mazingira ya Uzalishaji

• URL ya Msingi: https://api.wakapay.io
• Madhumuni: Miamala halisi yenye pesa halisi
• Inahitaji: Uthibitishaji wa KYB
• Miamala yote ni ya mwisho

Vitambulisho vya Majaribio vya TESTENV

Tumia vitambulisho hivi kwa majaribio katika mazingira ya majaribio:

Nambari za Simu za Majaribio (Pesa za Simu)

Nambari za Lipa za Majaribio (Till/Paybill)

Salio la Akaunti ya Majaribio

Salio la akaunti za majaribio hutofautiana kulingana na akaunti. Akaunti mpya zinaweza kuanza na salio sifuri. Unaweza kuomba kuongezewa salio kutoka kwa timu ya admin ikiwa inahitajika kwa majaribio.

Angalia salio lako la sasa kwa kutumia Balance API.

Viwango vya FX Vilivyowekwa

• USD → KES: 129 (kimewekwa na kinafanya kazi)

Kumbuka: Nambari za simu zisizo za majaribio katika TESTENV zitarudisha makosa ya verified: false au account not active.

Uthibitishaji

Maombi yote ya API yanahitaji uthibitishaji kwa kutumia tokeni za Bearer. Jifunze zaidi katika mwongozo wetu wa Uthibitishaji.

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

Muundo wa Ombi na Jibu

Aina ya Maudhui

Maombi yote yanapaswa kujumuisha kichwa cha Content-Type: application/json.

Muundo wa Jibu

Majibu yote yanarudishwa katika muundo wa JSON wenye muundo thabiti:

{
  "success": true,
  "data": {
    // Data ya jibu
  },
  "message": "Operation successful"
}

Majibu ya Makosa

Makosa yanafuata muundo wa kawaida:

{
  "success": false,
  "error": {
    "code": "INVALID_AMOUNT",
    "message": "Amount must be greater than 0"
  }
}

Kupunguza Kiwango (Rate Limiting)

Maombi ya API yamewekewa kikomo ili kuhakikisha uthabiti wa mfumo:

• Uzalishaji: maombi 100 kwa dakika kwa kila funguo ya API
• Majaribio: maombi 60 kwa dakika kwa kila funguo ya API

Taarifa za kikomo cha kiwango zinajumuishwa katika vichwa vya jibu:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

Mazingira

URL za Mazingira ya Majaribio

Tumia mazingira ya majaribio kuendeleza na kujaribu uunganishaji wako bila kushughulikia miamala halisi.

• URL: https://api.test.wakapay.io
• Vitambulisho vya majaribio hutolewa unapofungua akaunti ya msanidi
• Hakuna pesa halisi inayoshughulikiwa

URL za Mazingira ya Uzalishaji

Mazingira ya uzalishaji yanashughulikia miamala halisi.

• URL: https://api.wakapay.io
• Inahitaji uthibitishaji wa KYB
• Miamala yote ni ya mwisho

Hatua Zinazofuata

Uko tayari kuanza kujenga? Endelea hadi mwongozo wetu wa Anza Haraka ili kupiga simu yako ya kwanza ya API kwa dakika chache.