Vituo vya Mwisho vya Muamala (api/Muamala)

Ufafanuzi wa Jumla

Kigezo	Maelezo
msingi	Sanduku la mchanga - https://test.xprizo.com/apiMoja kwa moja- https://wallet.xprizo.com/api
chuki	1.0
apikey	Kitufe cha API Kwa uthibitishaji

Unda Ombi la Amana kwa Kutumia Kadi

Ombi

curl --eneo '{baseurl}/Transaction/CardDeposit' \
--kichwa 'Kubali: maandishi/wazi; toleo la x-api=1.0' \
--kichwa 'Aina ya Yaliyomo: application/json; toleo la x-api=1.0' \
--kichwa 'toleo la x-api: {apiversion}' \
--kichwa 'ufunguo wa x-api: {apikey}' \
--data '{
 "maelezo": <purpose ya amana>,
 "rejea": <unique kumbukumbu>,
 "kiasi": <the amana kiasi>,
 "kitambulisho cha akaunti": <merchants pochi kitambulisho>,
 "mteja": <unique jina kwa ya mwekaji>,
 "creditCard": {
 "jina": <name juu kadi>,
 "nambari": <card nambari>,
 "expiryMonth":<2 taswira ya mwisho wa mwezi 01-12>,
 "expiryYear": <2 diget expiry year>,
 "cvv": <3 au 4 tarakimu>
 },
 "routingCode": "string",
 "redirect": "string"
}'

Kigezo	Maelezo
akauntiId	(Inahitajika) Hiki ni kitambulisho cha pochi ya mpokeaji - pochi ambayo fedha zitawekwa.
kumbukumbu	(Inahitajika) Rejeleo ni kitambulisho cha kipekee cha muamala kwa muamala huu. Hii itatolewa na mtumiaji wa kichakataji na itatumika katika ukaguzi wa hali na upigaji simu tena.
mteja	(Inahitajika) Kitambulisho cha kipekee cha mtu anayeweka amana. Ikiwa mteja huyu hatapatikana kwenye mfumo, ataongezwa kwenye kitabu cha anwani cha mpokeaji. Unaweza kupitisha kitambulisho cha barua pepe cha mtumiaji huyo.
kiasi	(Inahitajika) Kiasi cha amana, kilicho na nafasi 2 za desimali, kwa kutumia nukta kama desimali.
maelezo	(Si lazima) Maandishi yanayoweza kutumiwa kuelezea sababu ya kuweka akiba. Katika Modi ya Mtihani. tumia:- Pasi, Ufanisi - muamala utaundwa kama ulivyoidhinishwa.Kataa, Umeshindwa, Ghairi - muamala utaundwa na kisha kukataliwa.
Msimbo wa uelekezaji	Tumia mojawapo ya misimbo ya uelekezaji ambayo imewekwa kwenye akaunti yako (misimbo ya uelekezaji hutumika kwa sarafu na vikomo tofauti). Hii itasanidiwa na Timu ya Xprizo na unaweza kupata hizi hapa.
elekeza kwingine	(Inahitajika kwa 3DS) Ikiwa kadi itachakatwa kwa kutumia 3ds basi utahitaji kufungua skrini ya uthibitishaji (URL ya kuelekeza upya kwa skrini ya uthibitishaji inarejeshwa katika jibu la ombi hili). Uelekezaji upya huku ni URL ambayo mtumiaji atarejeshwa baada ya skrini ya uthibitishaji kufungwa.

Jibu (200)

{
    "ufunguo": <a kipekee kitambulisho kwa ya shughuli>,
    "Msimbo wa hali": <The nambari sawa ya ya Hali>,
    "hali": ,
    "thamani":
}

Kigezo	Maelezo
ufunguo	kitambulisho cha kipekee cha muamala
Msimbo wa hali	Nambari inayolingana na Hali
hali	Imetumika – Muamala umekamilika Inayosubiriwa kwa mafanikio – Muamala haukuweza kukamilishwa na unahitaji hatua zaidi Imekataliwa – Muamala umekataliwaRedirect – (3DS) mtumiaji anahitaji kuelekezwa kwenye URL nyingine ili kukamilisha muamala.
thamani	Imetumika - thamani itaonyesha maelezoInayosubiri - thamani itaonyesha maelezo Yamekataliwa - thamani itaonyesha sababu IelekezweUpesi - thamani itaonyesha URL ya kuelekeza kwa

Makosa

400 (Ombi Mbaya) Muamala haukuweza kukamilika. Sababu imerejeshwa Angalia hitilafu, wasiliana na Xprizo, au suluhisha tatizo na ujaribu tena.
- UjumbeMaelezo ya UjumbeMsimbo batili wa uelekezaji Akaunti yako haina msimbo wa uelekezaji uliosanidiwa. Tafadhali wasiliana na timu ya XPrizo ili kuweka mipangilio hii. Msimbo batili wa uelekezaji (Hakuna Seti ya Kati)Akaunti yako haina MID iliyosanidiwa. Tafadhali wasiliana na timu ya Xprizo ili kusanidi hii.Muamala ulio na rejeleo hili tayari upoUnahitaji kutengeneza marejeleo mapya na ujaribu tenaMuamala unaosubiri na marejeleo haya tayari upo (Rejelea:652-1706532591287))Muamala tayari unapatikana kwa hili. nambari ya kumbukumbu na hali inasubiri, tafadhali angalia hali ya hii au jaribu tena na nambari mpya ya kumbukumbu
401 (Haijaidhinishwa) Tokeni batili au iliyoisha muda wake.
403 (Imeharamishwa) Huna haki ya kuunda au kuidhinisha muamala huu.
500 (Hitilafu ya Seva ya Ndani) Hitilafu kubwa isiyotarajiwa ya mfumo imetokea. Wasiliana na XPrizo na uripoti hitilafu.

Unda Ombi la Kuweka Amana Kwa Kutumia Mkoba wa Xprizo

Ombi

curl --eneo '{baseurl}/Transaction/RequestPayment' \
--kichwa 'Kubali: maandishi/wazi; toleo la x-api=1.0' \
--kichwa 'Aina ya Yaliyomo: application/json; toleo la x-api=1.0' \
--kichwa 'toleo la x-api: {apiversion}' \
--kichwa 'ufunguo wa x-api: {apikey}' \
--data '{
    "kutokaAkauntiId": <kitambulisho_cha_akaunti_ya_watumiaji>,
    "toAccountId": <kitambulisho_cha_akaunti yako>,
    "maelezo": <purpose ya amana>,
    "kiasi": <requested kiasi>,
    "rejea":<unique kumbukumbu>
}'

Kigezo	Maelezo
kutokaAkauntiId	Hiki ndicho kitambulisho cha pochi ya anayelipwa - mtumiaji anayelipa pesa hizo
kwaAkauntiId	Hiki ndicho kitambulisho cha pochi ya mpokeaji - mtumiaji ambaye atapokea pesa
maelezo	(Si lazima) Maandishi yanayoweza kutumiwa kuelezea sababu ya muamala
kiasi	Kiasi cha muamala
kumbukumbu	Rejeleo la kipekee limeundwa ili uweze kutambua na kuunganisha muamala huu kwenye mfumo wako

Jibu (200)

{
    "ufunguo":<a kipekee kitambulisho kwa ya shughuli>,
    "approveById": <id ya ya mtu kwa kuidhinisha ya shughuli>,
    "Ghairi": <can kuwa imeghairiwa au sivyo>,
    "ttl": <time kushoto katika sekunde>,
    "tarehe ya mwisho wa matumizi": ,
    "error": ""
}

Kigezo	Maelezo
ufunguo	kitambulisho cha kipekee cha muamala
kupitishaById	<id of the person to approve the transaction>
Ghairi	<can be cancelled or not>
tarehe ya mwisho wa matumizi	<date/time when the transaction expires>
ttl	<time left in seconds>

Makosa

400 (Ombi Mbaya) Muamala haukuweza kukamilika. Sababu imerejeshwa Angalia hitilafu, wasiliana na Xprizo, au suluhisha tatizo na ujaribu tena.
401 (Haijaidhinishwa) Tokeni batili au iliyoisha muda wake.
403 (Imeharamishwa) Huna haki ya kuunda au kuidhinisha muamala huu.
500 (Hitilafu ya Seva ya Ndani) Hitilafu kubwa isiyotarajiwa ya mfumo imetokea. Wasiliana na XPrizo na uripoti hitilafu.

Unda Ombi la Kuweka Amana Kwa Kutumia Mkoba wa Mpesa

Ombi

curl --eneo '{baseurl}/Transaction/MPesaDeposit' \
--kichwa 'Kubali: maandishi/wazi; toleo la x-api=1.0' \
--kichwa 'Aina ya Yaliyomo: application/json; toleo la x-api=1.0' \
--kichwa 'toleo la x-api: {apiversion}' \
--kichwa 'ufunguo wa x-api: {apikey}' \
--data '{
    "namba ya simu ya mkononi": <mpesa_nambari_ya_simu>,
    "kitambulisho cha akaunti": <kitambulisho_cha_akaunti yako>,
    "maelezo": <purpose ya amana>,
    "kiasi": <requested kiasi>,
    "rejea":<unique kumbukumbu>
}'

Kigezo	Maelezo
namba ya simu ya mkononi	Nambari ya simu ya Mpesa itatumika kufanya miamala
akauntiId	Hiki ndicho kitambulisho cha pochi ya mpokeaji - mtumiaji ambaye atapokea pesa
maelezo	(Si lazima) Maandishi yanayoweza kutumiwa kuelezea sababu ya muamala. Katika Modi ya Mtihani. tumia:- Pasi, Ufanisi - muamala utaundwa kama ulivyoidhinishwa.Kataa, Umeshindwa, Ghairi - muamala utaundwa na kisha kukataliwa.
kiasi	Kiasi cha muamala
kumbukumbu	Rejeleo la kipekee limeundwa ili uweze kutambua na kuunganisha muamala huu kwenye mfumo wako

Jibu (200)

{
    "ufunguo": <a kipekee kitambulisho kwa ya shughuli>,
    "Msimbo wa hali": <The nambari sawa ya ya Hali>,
    "hali": ,
    "thamani": <transaction maelezo>
}

Kigezo	Maelezo
ufunguo	kitambulisho cha kipekee cha muamala
Msimbo wa hali	Nambari inayolingana na Hali
hali	Imetumika - Muamala umekamilika kwa mafanikioInayosubiriwa - Muamala haukuweza kukamilika na unahitaji hatua zaidi Imekataliwa - Muamala umekataliwa
thamani	Imetumika - thamani itaonyesha maelezo Inasubiri - thamani itaonyesha maelezo Yamekataliwa - thamani itaonyesha sababu

Makosa

400 (Ombi Mbaya) Muamala haukuweza kukamilika. Sababu imerejeshwa Angalia hitilafu, wasiliana na Xprizo, au suluhisha tatizo na ujaribu tena.
401 (Haijaidhinishwa) Tokeni batili au iliyoisha muda wake.
403 (Imeharamishwa) Huna haki ya kuunda au kuidhinisha muamala huu.
500 (Hitilafu ya Seva ya Ndani) Hitilafu kubwa isiyotarajiwa ya mfumo imetokea. Wasiliana na XPrizo na uripoti hitilafu.

Idhini ya Majibu ya Webhook

Umeunda Muamala na Majibu ya Muamala Yaliyoidhinishwa kwenye Webhook (Mfano)

# Imeundwa Shughuli
{
  "haliAina": 1,
  "hali": "Mpya",
  "maelezo": null,
  "actionedById": 724,
  "Vitambulisho vya Mawasiliano vilivyoathirika": [
    723,
    2
  ],
  "shughuli": {
    "kitambulisho": 0,
    "imeundwaKwaId": 724,
    "aina": "UCD",
    "tarehe": "2024-02-07T03:41:59.823195+00:00",
    "kumbukumbu": "652-1706532591283",
    "currencyCode": "USD",
    "kiasi": 5
  }
}

# Imeidhinishwa Shughuli
{
  "haliAina": 2,
  "hali": "Imekubaliwa",
  "maelezo": null,
  "Vitambulisho vya Mawasiliano vilivyoathirika": [
    723,
    2
  ],
  "shughuli": {
    "kitambulisho": 3169,
    "imeundwaKwaId": 724,
    "aina": "UCD",
    "tarehe": "2024-02-07T03:43:50.9186754+00:00",
    "kumbukumbu": "652-1706532591283",
    "currencyCode": "USD",
    "kiasi": 5
  }
}

Kigezo	Maelezo
haliAina	Hii ndio hali 2 = Imekubaliwa
hali	Toleo la maandishi la hali "Imekubaliwa"
Vitambulisho vya Mawasiliano vilivyoathirika	Orodha ya vitambulisho vya anwani ambavyo vilihusika katika shughuli hii ya ununuzi
Shughuli	Muamala ambao uliundwa
kitambulisho	Kitambulisho cha kipekee cha muamala kilichotolewa na Xprizo
imeundwaKwaId	Kitambulisho cha mtu anayeunda muamala
aina	Aina ya shughuli (UCD = Amana ya Kadi)
tarehe	Tarehe ya muamala
kumbukumbu	Kitambulishi cha kipekee cha muamala cha mpokeaji cha muamala huu
currencyCode	Sarafu ya muamala huu
kiasi	Kiasi cha muamala huu

Jibu la Muamala Lililokataliwa kwenye Webhook (Mfano)

{
 "haliAina":3,
 "hali":"Imekataliwa",
 "maelezo":"Sababu ya kukataliwa",
 "actionedById":1,
 "Vitambulisho vya Mawasiliano vilivyoathirika":[]
 "shughuli": {
   "kitambulisho":0,
   "imeundwaKwaId":2,
   "aina":"UCD",
   "tarehe":"2021-04-20T20:34:00.7606173+02:00",
   "kumbukumbu":234234234,
   "currencyCode":"USD",
   "kiasi":100.00
 }
}

Ifuatayo ni orodha ya misimbo ya hali ya uidhinishaji ambayo inaweza kurejeshwa

0 = Hakuna - Inatumika kwa majaribio
1 = Mpya - Muamala mpya unaosubiri umeundwa
2 = Imeidhinishwa- Muamala uliidhinishwa na kuchakatwa
3 = Imekataliwa - Muamala ulikataliwa na mpokeaji
4 = Imeghairiwa - Muamala ulighairiwa na muundaji

Ukaguzi wa Hali ya Muamala

Mwisho huu unaweza kutumika kuangalia hali ya aina yoyote ya muamala kwa mfano amana ya kadi, uondoaji wa Mpesa n.k.

Ombi

curl --eneo '{baseurl}/Muamala/Hali/{accountId}/?reference={reference}' \
--kichwa 'toleo la x-api: {apiversion}' \
--kichwa 'ufunguo wa x-api: {apikey}'

Kigezo	Maelezo
akauntiId	Hiki ndicho kitambulisho cha pochi ambacho kina shughuli hiyo. Unapoomba malipo tumia kitambulisho cha pochi ya mpokeaji.
kumbukumbu	Rejeleo ni kitambulisho cha kipekee cha Muamala wa Wafanyabiashara kwa muamala huu

Jibu (200)

{
    "ufunguo" : <a kipekee kitambulisho kwa ya shughuli>
    "StatusCode" : <0/3/1/-1/4/5/6>
    "hali" :
    "thamani":
}

# Inasubiri Muamala 

{
    "ufunguo": "",
    "Msimbo wa hali": 1,
    "hali": "Inasubiri",
    "thamani": "Pasi"
}


# Muamala Ulioidhinishwa

{
    "ufunguo": "3169",
    "Msimbo wa hali": 0,
    "hali": "Inayotumika",
    "thamani": "testing.com Pass"
}

# Muamala Umekataliwa

{
    "ufunguo": "144",
    "Msimbo wa hali": 3,
    "hali": "Imekataliwa",
    "thamani": "Jaribio Lililoshindikana"
}

# Haijapatikana Muamala

{
    "ufunguo": "",
    "Msimbo wa hali": -1,
    "hali": "Haipatikani",
    "thamani": ""
}

# Hold Transaction (Utoaji wa Mpesa)

{
    "ufunguo": "144",
    "Msimbo wa hali": 5,
    "hali": "Shikilia",
    "thamani": "Utoaji wa Mpesa +254342222222"
}

Muamala Utupu wa # (Utoaji wa Mpesa)

{
    "ufunguo": "144",
    "Msimbo wa hali": 6,
    "hali": "Utupu",
    "thamani": "342222222 Haijatumika: Hakuna Data ya Majibu"
}

Kigezo	Maelezo
ufunguo	Hiki ndicho kitambulisho cha kipekee cha muamala. Wakati Umetumika au Umesitishwa au Ubatili hii itakuwa na kitambulisho cha muamala. Ikikataliwa au Kughairiwa, itakuwa kitambulisho kilichotolewa katika faili ya kumbukumbu kwa ajili ya ingizo.Inaposubiri au Haijapatikana, itakuwa tupu.
hali	Hali ya muamala - Inaweza kuwa mojawapo ya yafuatayo:Inayotumika - Muamala ni muamala halali unaoendeleaInayosubiri - Muamala unangoja idhini (au kukataliwa).Haijapatikana - Muamala kwenye pochi hii, ukitumia marejeleo haya. Imekataliwa - muamala umekataliwa na mpokeaji. Imeghairiwa - Xprizo ikighairi muamala kwa sababu ya hitilafu ya kiufundi au simu zisizo sahihi. Shikilia - Hii inatumika kwa uondoaji wa Mpesa
thamani	Wakati Imetumika, hii itakuwa na maelezo ya bili Kwa amana ya kadi na maelezo ya muamala kwa miamala mingine. Wakati Inashikilia hii itakuwa na maelezo ya uondoajiWakati Ubatili hii itakuwa na sababu batiliIkikataliwa au Kughairiwa, itakuwa na sababu.Inaposubiri au Haijapatikana, itakuwa na sababu. kuwa mtupu

Usanidi wa Mtihani kwa Chaguo za Uelekezaji

Chaguo la Uelekezaji	Kiambishi awali cha Msimbo wa Uelekezaji	Usanidi
Chaguo A	MWANAUME	Kiasi$1.00 au $2.00 – Inayotumika( 2DS Success)$3.00 au $4.00 – Imekataliwa$5.00 au $6.00 – Redirect (3DS Redirect URL)$7.00 au zaidi – Kesi 3DS Iliyokataliwa

Kenya

Falme Za Kiarabu (UAE)

Je, unahitaji mwongozo?

Vituo vya Mwisho vya Muamala (api/Muamala)

Ufafanuzi wa Jumla

Unda Ombi la Amana kwa Kutumia Kadi

Ombi

Jibu (200)

Makosa

Unda Ombi la Kuweka Amana Kwa Kutumia Mkoba wa Xprizo

Ombi

Jibu (200)

Makosa

Unda Ombi la Kuweka Amana Kwa Kutumia Mkoba wa Mpesa

Ombi

Jibu (200)

Makosa

Idhini ya Majibu ya Webhook

Umeunda Muamala na Majibu ya Muamala Yaliyoidhinishwa kwenye Webhook (Mfano)

Jibu la Muamala Lililokataliwa kwenye Webhook (Mfano)

Ifuatayo ni orodha ya misimbo ya hali ya uidhinishaji ambayo inaweza kurejeshwa

Ukaguzi wa Hali ya Muamala

Ombi

Jibu (200)

Usanidi wa Mtihani kwa Chaguo za Uelekezaji

Gundua miongozo mingine

Vituo vya Mwisho vya Wallet (api/Wallet)

Mapendeleo ya Mwisho (api/Mapendeleo)

Vituo vya Mwisho vya Muamala (api/Muamala)

Urambazaji

Kampuni

Msaada

Vipakuliwa

Kisheria