API ɗin da tawagarka za ta ji daɗin amfani da shi da gaske
REST da za a iya hasashe, maɓallan idempotency, webhook masu sa hannu da sandbox mai kwaikwayon hanyoyi domin ka kammala haɗawa gabaki ɗaya kafin ko kwabo ya motsa.
Karɓarka ta farko cikin buƙata guda
REST mai tsafta, tsarin amsa JSON da za a iya hasashe, da lambar buƙata a kowace amsa. Sandbox ɗin na kwaikwayon ainihin tsarin: API iri ɗaya, matsayi iri ɗaya, webhook iri ɗaya.
- Maɓallan sandbox da na ainihin aiki, keɓaɓɓu ga kowace manhaja
- Webhook masu sa hannun HMAC tare da kariyar maimaitawa
- Maɓallan idempotency a kowace kira da ke motsa kuɗi
- Kurakurai masu nau'i da ke gaya maka daidai abin da za ka gyara
- Bayanin OpenAPI, tarin Postman da llms.txt, duk an buga su
- Zaman biyan kuɗi da callback masu sauƙi ga masu haɗa CRM, ERP da shaguna
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"
}Karbar ka ta farko
Bukata daya tana kirkirar niyyar biya, tana mayar da tantancewar bukata kuma, ga kudin waya, tana tura sanarwa zuwa wayar mai biya. Sandbox yana aiki daidai kamar samarwa.
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 na uwar garke
Rufi masu sirara da nau'i kan API din REST guda daya, tare da idempotency da tantance sa hannu a ciki.
import { Capay } from '@capay/sdk';Ba ta kan npm ba tukuna. Layin import da ke sama shi ne na ƙarshe, don haka haɗin ku ba zai canja ba lokacin da aka buga shi.
Karanta jagorafrom capay import CapayBa ta kan PyPI ba tukuna. Layin import da ke sama shi ne na ƙarshe, don haka haɗin ku ba zai canja ba lokacin da aka buga shi.
Karanta jagorause Capay\CapayClient;Ba ta kan Packagist ba tukuna. Layin import da ke sama shi ne na ƙarshe, don haka haɗin ku ba zai canja ba lokacin da aka buga shi.
Karanta jagoraTantance kowane webhook
Ana lissafin sa hannu kan jikin danye kuma ana kwatanta shi cikin lokaci daidai, kuma ana kin tambarin lokaci da ya wuce sakan 300. Kada ka taba amincewa da webhook da ba ka tantance ba.
# 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.completedAna sake gwada isarwa da ta gaza bisa tsayayyen jadawali: 1m, 5m, 30m, 2h, 6h, 12h, 24h, 24h. Wurin da ya gaza sau 8 a jere ana kashe shi kuma a sanar da kai, don haka wuri matacce ba zai hadiye abubuwan da suka faru a asirce ba.
Sirrikan sa hannu biyu na iya kasancewa masu aiki a lokaci daya, don haka za ka iya musanya su ba tare da rasa wani abin da ya faru ba. Ki duk abin da ke wajen tagar sakan 300 kuma ka adana tantancewar abin da ya faru don maimaitawa ta zama mara illa.
Sauran kayan aiki
Bayanan da inji ke iya karantawa, tari da za ka iya shigo da shi, da kayan aikin da ke karanta su.
Bincika dandalin
Fara karɓar biyan kuɗi a faɗin Afirka yau
Buɗe asusu kyauta, gina a sandbox, sannan ka fara aiki na gaske bayan tantancewa.
Faɗa mana hanyoyinka da yawan ma'amalolinka a kowane lokaci.