Horumariyayaasha

API ay kooxdaadu run ahaantii ku farxi doonto

REST la saadaalin karo, furayaal idempotency ah, webhook-yo saxiixan iyo sandbox leh marinno la ekaysiiyey, si aad si dhammaystiran ugu isku xirto kahor inta uusan hal faran dhaqaaqin.

Samee akoon

Loo dhisay horumariyayaasha

Ururintaadii ugu horreysay hal codsi gudihiis

REST nadiif ah, qaab JSON ah oo la saadaalin karo, iyo aqoonsi codsi oo jawaab kasta ku yaal. Sandbox-gu wuxuu si buuxda u mataalaa nidaamka rasmiga ah: isla API-ga, isla xaaladaha, isla webhook-yada.

Furayaal sandbox iyo kuwa rasmi ah, oo app kasta loo qoondeeyey
Webhook-yo lagu saxiixay HMAC oo leh ilaalin dib-u-celin (replay)
Furayaal idempotency ah oo saaran wicitaan kasta oo lacag dhaqaajinaya
Khaladaad nooc leh oo si sax ah kuugu sheegaya waxa aad hagaajinayso
Qeexida OpenAPI, ururinta Postman iyo llms.txt, dhammaantood waa la daabacay
Fadhiyo bixin la martigeliyey iyo callback fidsan oo loogu talagalay isku-xirayaasha CRM, ERP iyo dukaamada

Akhri dukumentiyada Hagaha isku-dhafka

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"
}

Ururintaadii ugu horreysay

Hal codsi wuxuu abuuraa ujeedo lacag bixin, wuxuu soo celiyaa aqoonsi codsi, lacagta mobaylkana wuxuu u diraa fariin taleefanka bixiyaha. Sandbox-ku si sax ah ayuu ula dhaqmaa sida wax soo saarka.

Hel furayaashaada tijaabadaSamee akoon, furayaasha sandbox-kuna isla markiiba waxay ka muuqdaan boggaaga horumariyaha. Furayaasha wax soo saarku waxay furmaan ka dib xaqiijinta ganacsiga.

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"
  }'

Jawaabta

{
  "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

Xaddiyadu waa xadhkaha tobanle ee xadka API-ga iyo cutubyo yaryar buugga xisaabaadka, sidaas darteed waxba kuma lumaan. Wicitaan kasta oo lacag dhaqaajiya wuxuu qaataa fure idempotency, jawaab kastana waxay sidataa aqoonsi codsi oo aad taageerada u sheegi karto.

SDK-yada server-ka

Duub khafiif ah oo nooc leh oo ku dul yaal isla API-ga REST, oo leh idempotency iyo xaqiijinta saxeexa gudaha.

TypeScript and NodeDhawaan ayaa la daabacayaa@capay/sdk

Soo dejinta

import { Capay } from '@capay/sdk';

Weli kuma jirto npm. Xariiqda import ee kore waa mid u dambeeya, sidaas darteed isku-xidhkaagu isma beddelayo marka la daabaco.

Akhri hagaha

PythonDhawaan ayaa la daabacayaacapay

Soo dejinta

from capay import Capay

Weli kuma jirto PyPI. Xariiqda import ee kore waa mid u dambeeya, sidaas darteed isku-xidhkaagu isma beddelayo marka la daabaco.

Akhri hagaha

PHPDhawaan ayaa la daabacayaacapay/capay-php

Soo dejinta

use Capay\CapayClient;

Weli kuma jirto Packagist. Xariiqda import ee kore waa mid u dambeeya, sidaas darteed isku-xidhkaagu isma beddelayo marka la daabaco.

Akhri hagaha

Xaqiiji webhook kasta

Saxeexyada waxaa lagu xisaabiyaa jirka ceeriin waxaana lagu barbardhigaa waqti go'an, calaamad waqti ka weyn 300 ilbiriqsi waa la diidaa. Waligaa ha aamin webhook aadan xaqiijin.

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.

Madaxa saxeexa

X-Capay-Signature: t=1767225600,v1=6f8b4c2d9e0a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f0a2b4c6d8e0f1a3b5c
X-Capay-Event-Id: evt_2n4Kq8Zr41Xa
X-Capay-Event-Type: collection.completed

Gaarsiinta iyo isku dayga

Gaarsiin fashilantay waxaa dib loogu dayaa jadwal go'an: 1m, 5m, 30m, 2h, 6h, 12h, 24h, 24h. Barta 8 jeer oo isku xigta fashilanta waa la damiyaa waana laguu sheegayaa, si aan bar dhimatay si aamusan u liqin dhacdooyinka.

Laba sir oo saxeex ah ayaa isku mar shaqayn kara, sidaas darteed waad beddeli kartaa adigoon dhacdo lumin. Diid wax kasta oo ka baxsan daaqadda 300 ilbiriqsi oo kaydi aqoonsiga dhacdada si dib u celintu ay u noqoto mid aan waxyeello lahayn.

Qalabka intiisa kale

Qeexid mashiinku akhriyi karo, ururin aad soo dejin karto, iyo qalabka akhriya.

llms.txtDukumentiga oo dhan oo loo simay caawiyayaasha koodhka, si AI-gaagu uga jawaabo API-gayaga isagoo isticmaalaya qoraalkayaga.Qeexida OpenAPIHeshiiska buuxa, oo laga soo saaray API-ga. Soo deji si aad u dhisto macmiil luqad kasta.Ururinta PostmanBar kasta oo leh jirro tusaale ah iyo doorsoomayaal deegaan, diyaar u ah in lagu socodsiiyo sandbox-ka.

Khadka amarradaWaa soo socdaaAbuur lacag bixino tijaabo ah, raac dhacdooyinka oo dib ugu ciyaar webhook mashiinkaaga.@capay/cli

Server-ka MCPWaa soo socdaaSii caawiyahaaga koodhka helitaan akhris ah sandbox-kaaga si uu ugaga jawaabo xogtaada dhabta ah.@capay/mcp

Qoraalka lacag bixintaWaa soo socdaaKu fur bogga lacag bixinta daaqad bogaaga dul saaran halkii aad meel kale u wareejin lahayd.https://pay.capayglobal.com/capay.js

Baadh madasha

UrurintaUrurinta lacagta moobaylka iyo bangiyada Lacag-bixinnada cryptoUSDT, USDC iyo kuwo kale, oo laguugu bixiyo doolarka Maraykanka Lacag-diriddaLacag-dirid boorsooyin oo otomaatig ah QiimahaQiimayaal dhaqdhaqaaq kasta ah, khidmad go'an ma jirto BaaxaddaSuuqyada shaqaynaya iyo hababka FAQJawaabo kooban oo su'aalaha caadiga ah

Maanta ka bilow ururinta lacagta Afrika oo dhan

Samee akoon bilaash ah, ku dhis sandbox-ga, kadib xaqiijintana si rasmi ah u bilow.

Samee akoon

Waqti kasta nooga sheeg marinnadaada iyo mugga ganacsigaaga.