CamelPay logocamelpaydocs
Reference

API Reference

Complete list of CamelPay API endpoints, webhook events, and supported payment methods.

Public Endpoints (no auth)

MethodEndpointDescription
POST/v1/students/registerCreate account
POST/v1/students/auth/otp/requestRequest OTP
POST/v1/students/auth/otp/verifyVerify OTP, get JWT
POST/v1/students/auth/loginStart login (email/phone + password)
POST/v1/students/auth/login/verifyComplete login with emailed MFA code
POST/v1/payments/checkoutInitiate a payment (scoped to a page slug)
GET/v1/payments/{reference}/statusCheck payment status

JWT Endpoints (dashboard / account)

MethodEndpointDescription
GET/v1/students/meGet profile + verification_status
POST/v1/students/me/documentsSubmit KYC documents
POST/v1/storage/presignGet a purpose-bound KYC image upload URL
GET/v1/wallets/meGet wallet balance
GET/v1/wallets/me/transactionsList wallet transactions
POST/developers/appsCreate developer app
GET/developers/appsList developer apps
POST/developers/keysGenerate API key
GET/developers/keysList API keys (requires ?app_id=)
POST/developers/keys/{id}/rotateRotate API key
DELETE/developers/keys/{id}Revoke API key
POST/developers/apps/{id}/webhookRegister/update webhook URL
GET/developers/apps/{id}/webhookView webhook config + secret
POST/developers/apps/{id}/webhook/rotateRotate webhook secret
DELETE/developers/apps/{id}/webhookRemove webhook
GET/developers/apps/{id}/webhook/deliveriesRecent webhook delivery attempts
POST/v1/merchant/payment-pagesCreate payment page (dashboard)
GET/v1/merchant/payment-pages/meList payment pages (dashboard)
PATCH/v1/merchant/payment-pages/{id}Update payment page (dashboard)
POST/v1/merchant/payoutsRequest payout (dashboard)
GET/v1/merchant/payouts/meList payouts (dashboard)
POST/v1/admin/students/{id}/verifyApprove or reject KYC (admin)

API Key Endpoints (/v1/*)

MethodEndpointScope
GET/v1/balancebalance:read
GET/v1/profileprofile:read
GET/v1/transactionstransactions:read
GET/v1/payment-pagespages:read
GET/v1/payment-pages/{id}pages:read
POST/v1/payment-pagespages:write (KYC-verified)
PATCH/v1/payment-pages/{id}pages:write (KYC-verified)
POST/v1/payoutspayouts:write
GET/v1/payoutspayouts:read
GET/v1/payouts/{reference}/statuspayouts:read

Webhook Events

EventDescription
payment.completedPayment successful, wallet credited

Supported Payment Methods

  • M-Pesa
  • Airtel Money
  • Mixx by Yas
  • Halotel

Support

  • Documentation: https://docs.camelpay.in
  • Email: developers@cameltech.online
  • Status: https://status.camelpay.in