Abathuthukisi

I-API ithimba lakho eliyoyithokozela ngempela

I-REST ebikezelekayo, okhiye be-idempotency, ama-webhook asayiniwe kanye ne-sandbox enemizila elingisiwe ukuze uxhume konke kusukela ekuqaleni kuze kube sekugcineni ngaphambi kokuhambisa ngisho ifranga elilodwa.

Vula i-akhawunti
Yakhelwe abathuthukisi

Ukuqoqa kwakho kokuqala ngesicelo esisodwa

I-REST ehlanzekile, imvilophu ye-JSON ebikezelekayo kanye ne-id yesicelo kuyo yonke impendulo. I-sandbox ifana ncamashi ne-production: i-API efanayo, izimo ezifanayo, ama-webhook afanayo.

  • Okhiye be-sandbox nabe-production, abahlukaniselwe uhlelo ngalunye
  • Ama-webhook asayinwe nge-HMAC anokuvikelwa ekuphindweni kwezicelo
  • Okhiye be-idempotency kuso sonke isicelo esihambisa imali
  • Amaphutha anezinhlobo ezicacile akutshela ngqo ukuthi yini okumele uyilungise
  • Incazelo ye-OpenAPI, iqoqo le-Postman ne-llms.txt, konke kushicilelwe
  • Amaseshini okukhokha asingathiwe nama-callback ayisicaba ezixhumanisi ze-CRM, i-ERP nezitolo
POST /v1/collections
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"
  }'
201 Created
{
  "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"
}

Ukuqoqa kwakho kokuqala

Isicelo esisodwa senza inhloso yenkokhelo, sibuyisele i-id yesicelo futhi, kwimali yeselula, sithumele isicelo kufoni yokhokhayo. I-sandbox iziphatha ngokufana ncamashi nomkhiqizo.

Thola okhiye bakho bokuhlolaYenza i-akhawunti bese okhiye be-sandbox bavela ngokushesha ekhasini lakho lomthuthukisi. Okhiye bomkhiqizo bavuleka emva kokuqinisekiswa kwebhizinisi.
POST /v1/collections
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"
  }'
Impendulo
{
  "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"
}
201 Created
Amanani ayizintambo zedesimali emngceleni we-API futhi ayizinyathelo ezincane encwadini, ngakho akukho okulahlekayo. Wonke umbizo onyakazisa imali uthatha ukhiye we-idempotency futhi yonke impendulo iphethe i-id yesicelo ongayisho kusizo.

Ama-SDK eseva

Izembozo ezincane ezinezinhlobo phezu kwe-API ye-REST efanayo, ne-idempotency nokuqinisekiswa kwesiginesha ngaphakathi.

TypeScript and NodeKushicilelwa maduze@capay/sdk
Ukungenisa
import { Capay } from '@capay/sdk';

Ayikho ku-npm okwamanje. Umugqa we-import ongenhla ungowokugcina, ngakho ukuxhumana kwakho ngeke kushintshe lapho ikhishwa.

Funda umhlahlandlela
PythonKushicilelwa maduzecapay
Ukungenisa
from capay import Capay

Ayikho ku-PyPI okwamanje. Umugqa we-import ongenhla ungowokugcina, ngakho ukuxhumana kwakho ngeke kushintshe lapho ikhishwa.

Funda umhlahlandlela
PHPKushicilelwa maduzecapay/capay-php
Ukungenisa
use Capay\CapayClient;

Ayikho ku-Packagist okwamanje. Umugqa we-import ongenhla ungowokugcina, ngakho ukuxhumana kwakho ngeke kushintshe lapho ikhishwa.

Funda umhlahlandlela

Qinisekisa yonke i-webhook

Amasiginesha abalwa emzimbeni oluhlaza futhi aqhathaniswe ngesikhathi esingaguquki, futhi isitembu sesikhathi esidala kunamasekhondi angu-300 siyenqatshwa. Ungalokothi wethembe i-webhook ongakayiqinisekisi.

X-Capay-Signature
# 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.
Isihloko sesiginesha
X-Capay-Signature: t=1767225600,v1=6f8b4c2d9e0a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f0a2b4c6d8e0f1a3b5c
X-Capay-Event-Id: evt_2n4Kq8Zr41Xa
X-Capay-Event-Type: collection.completed
Ukulethwa nokuzama futhi

Ukulethwa okwehlulekile kuzanywa futhi ngeshejuli engaguquki: 1m, 5m, 30m, 2h, 6h, 12h, 24h, 24h. Iphuzu eliphelela ngokwehluleka izikhathi ezingu-8 zilandelana livalwa futhi uyaziswa, ukuze iphuzu elifile lingagwinyi izehlakalo ngokuthula.

Izimfihlo ezimbili zokusayina zingasebenza kanyekanye, ngakho ungazishintsha ngaphandle kokulahlekelwa isehlakalo. Yenqaba noma yini engaphandle kwewindi lamasekhondi angu-300 futhi ugcine i-id yesehlakalo ukuze ukuphinda kungabi nangozi.

Okusele kwamathuluzi

Izincazelo ezifundwa umshini, iqoqo ongalingenisa, namathuluzi azifundayo.

llms.txtWonke amadokhumenti ehliswa abe ngumbhalo owodwa wabasizi bokubhala ikhodi, ukuze i-AI yakho iphendule nge-API yethu isebenzisa umbhalo wethu.Incazelo ye-OpenAPIInkontileka egcwele, ekhiqizwe kusuka ku-API. Yingenise ukuze wakhe iklayenti nganoma yiluphi ulimi.Iqoqo le-PostmanWonke amaphuzu okugcina anemizimba yesibonelo nezinguquko zemvelo, akulungele ukusebenza ku-sandbox.
Umugqa womyaloKuyezaYenza izinkokhelo zokuhlola, ulandele izehlakalo futhi udlale i-webhook emshinini wakho.@capay/cli
Iseva ye-MCPKuyezaNikeza umsizi wakho wekhodi ukufinyelela kokufunda ku-sandbox yakho ukuze aphendule ngedatha yakho yangempela.@capay/mcp
Iskripthi sokukhokhaKuyezaVula ikhasi lokukhokha ewindini phezu kwekhasi lakho esikhundleni sokuqondisa kwenye indawo.https://pay.capayglobal.com/capay.js

Qala ukuqoqa izinkokhelo kulo lonke elase-Afrika namuhla

Vula i-akhawunti yamahhala, wakhe usebenzisa i-sandbox, bese usebenza bukhoma ngemva kokuqinisekiswa.

Vula i-akhawunti

Sitshele ngemizila yakho namavolumu akho noma nini.