API gareen kee dhugumaan itti gammadu
REST tilmaamamaa, furtuu idempotency, webhook mallattaa'e fi sandbox daandii fakkeessu: utuu farankii tokko hin sochoosin dura walitti hidhama xumuraa hanga xumuraatti qoruu dandeessa.
Walitti qabiinsi kee inni jalqabaa gaaffii tokkoon
REST qulqulluu, envelope JSON tilmaamamaa, akkasumas deebii hundarratti request id. Sandboxiin akkuma produkshinii: API tokko, haala tokko, webhook tokko.
- Furtuu sandbox fi produkshinii, tokkoon tokkoon appiitiif kan daangeffame
- Webhook HMAC'n mallattaa'e, eegumsa irra-deebii waliin
- Waamicha maallaqa sochoosu hundarratti furtuu idempotency
- Dogoggora gosa qabu kan waan sirreessitu sirriitti sitti himu
- Ibsa OpenAPI, walitti qabaa Postman fi llms.txt, hundinuu maxxanfamaniiru
- Walqabsiistota CRM, ERP fi suuqaatiif yeroo kaffaltii keessummeeffamee fi callback diriiraa
curl https://api.capayglobal.com/v1/collections \
-H "Authorization: Bearer sk_test_..." \
-H "Idempotency-Key: 9f1c-collect-01" \
-H "Content-Type: application/json" \
-d '{
"amount": "2500",
"currency": "XAF",
"country": "CM",
"method": "mobile_money",
"msisdn": "2376XXXXXXXX",
"merchant_reference": "order-1042"
}'{
"status": "success",
"data": {
"id": "col_9xKQ2mD41Vb8",
"object": "collection",
"status": "pending",
"amount": "2500",
"currency": "XAF",
"country": "CM",
"method": "mobile_money",
"merchant_reference": "order-1042",
"fees": {
"platform_fee": "50",
"provider_fee": "0",
"total_fee": "50",
"bearer": "merchant"
},
"net_amount": null,
"livemode": false,
"created_at": "2026-08-30T12:04:11Z"
},
"request_id": "req_b0f3d2c1"
}Walitti qabuu kee jalqabaa
Gaaffiin tokko kaayyoo kaffaltii uuma, eenyummeessaa gaaffii deebisa, maallaqa bilbilaatiifis gaaffii sana gara bilbila kaffalaatti erga. Sandbox akkuma oomishaa hojjeta.
curl -X POST https://api.capayglobal.com/v1/collections \
-H "Authorization: Bearer sk_test_XXXXXXXXXXXX" \
-H "Idempotency-Key: col-order-10482-a1b2c3" \
-H "Content-Type: application/json" \
-d '{
"amount": "5000",
"currency": "XAF",
"country": "CM",
"method": "mobile_money",
"msisdn": "+237650000001",
"merchant_reference": "order-10482"
}'{
"status": "success",
"data": {
"id": "col_7Qm3k1Xa9Zr4",
"object": "collection",
"status": "pending",
"amount": "5000",
"currency": "XAF",
"auth_model": "STK_PROMPT",
"livemode": false
},
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}SDK saarvarii
API REST walfakkaataa irratti maramtoota qal'oo fi gosa qaban, idempotency fi mirkaneessa mallattoo keessa qabatan.
import { Capay } from '@capay/sdk';Amma illee npm irra hin jiru. Sararri import isa gubbaa isa dhumaa ti, kanaafuu yeroo maxxanfamu walsimsiisuun kee hin jijjiiramu.
Qajeelfama dubbisifrom capay import CapayAmma illee PyPI irra hin jiru. Sararri import isa gubbaa isa dhumaa ti, kanaafuu yeroo maxxanfamu walsimsiisuun kee hin jijjiiramu.
Qajeelfama dubbisiuse Capay\CapayClient;Amma illee Packagist irra hin jiru. Sararri import isa gubbaa isa dhumaa ti, kanaafuu yeroo maxxanfamu walsimsiisuun kee hin jijjiiramu.
Qajeelfama dubbisiWebhook hunda mirkaneessi
Mallattoowwan qaama jalqabaa irratti shallagamanii yeroo wal qixaan wal bira qabamu, mallattoon yeroo sekondii 300 caalaa dulloome ni kufaatii. Webhook ati hin mirkaneessin gonkumaa hin amanin.
# T is the t= value from X-Capay-Signature; delivery.json is the raw body as received.
T=1767225600
SECRET=whsec_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
{ printf '%s.' "$T"; cat delivery.json; } \
| openssl dgst -sha256 -hmac "$SECRET" -r | cut -d' ' -f1
# Compare the printed hex with each v1= value in the header (either may match
# during a secret rotation), and reject the delivery if |now - T| > 300 s.X-Capay-Signature: t=1767225600,v1=6f8b4c2d9e0a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f0a2b4c6d8e0f1a3b5c
X-Capay-Event-Id: evt_2n4Kq8Zr41Xa
X-Capay-Event-Type: collection.completedGeessuun kufe sagantaa hin jijjiiramneen irra deebi'ama: 1m, 5m, 30m, 2h, 6h, 12h, 24h, 24h. Iddoon dhumaa walitti aansee yeroo 8 kufe ni dhaabbata sittis ni himama, kanaafuu iddoon du'e taatee callisee hin liqimsu.
Iccitiiwwan mallattoo lama yeroo tokkotti hojii irra ta'uu danda'u, kanaafuu taatee osoo hin dhabin jijjiiruu dandeessa. Waan foddaa sekondii 300 alatti argamu hunda kuffisi, eenyummeessaa taatees kuusi, akka irra deebi'anii erguun miidhaa hin qabaanneef.
Meeshaalee hafan
Ibsa maashiniin dubbifamu, walitti qabaa ati galchuu dandeessu, fi meeshaalee isaan dubbisan.
Pilaatfoormicha sakatta'i
Har'uma Afrikaa keessatti kaffaltii walitti qabuu jalqabi
Akkaawuntii bilisaa banadhu, sandbox irratti ijaari, erga mirkaneeffamteen booda hojii jalqabi.
Waa'ee daandiiwwanii fi hamma keetii yeroo barbaaddetti nutti himi.