Online Payments Made Easy
\nSignup on our demo site: https://demo.campay.net
\nLogin and register an application
\nError codes reference
\n| Error code | Description |
|---|---|
ER101 | Invalid phone number. Ensure the number starts with the country code. e.g 237xxxxxxxxx |
ER102 | Unsupported Carrier phone number. Currently, only MTN and Orange phone numbers are accepted for mobile money |
ER201 | Invalid amount. Decimal numbers are NOT allowed. The Amount can be sent as integer or string |
ER301 | Insufficient balance. Trying to withdraw an amount which is above your current balance for the specific carrier |
There are two methods of authenticating requests.
\nUsing a permanent access token that does not expire.
\nUsing a temporary access token that expires and you can renew it.
\nYou can find your permanent access token under the APP KEYS section of your app.
Copy it and use it in the Authorisation header of your request. e.g
{\n Authorization: Token 69e2df238ea8d66f24018574c5de51e2b77d9abb,\n Content-Type: application/json\n}\n\nAfter registering your application from your account, we generate API access username and password for that application which will be used to get access tokens before you can perform operations on our API.
\nThis endpoint is used to request payment from users.
\nWhen this endpoint is called, the user gets a prompt on their mobile phone to authorize the payment by entering their mobile money PIN.
\nThe token gotten from the /token endpoint is used here with the Authorization header beginning with \"Token\".
When you initiate a transaction, the default status is PENDING. When processed, the status can be SUCCESSFUL or FAILED.
\nThis endpoint supports Idempotency on external_reference field. If you make the first request with a particular external_reference and then make the second request with the same external_reference as the first, you will get the results of the first request. Change the external_reference or leave it blank to initiate a new transaction
\nFormat: Json
\nParameters:
\n\"amount\": \"A valid integer\" e.g \"5\",
\"currency\": \"XAF\"
\"from\": \"A valid phone number with country code\" e.g \"2376xxxxxxxx\",
\"description\": \"Payment description\",
\"external_reference\": \"OPTIONAL. You can use this field to specify the reference of the transaction generated by your system. We will return this reference to you on the /transaction status endpoint\"
\"A valid and unique UUID4\". Example herehttps://www.uuidgenerator.nete.g \"2ceefe04-1a79-4914-9dd0-c61748c2aecd\". Each request should have a unique UUID. A request with a duplicate UUID will be rejected
Format: Json
\nParameters:
\n\"reference\": \"A valid UUID4. This reference is used to check the status of the transaction. Use the /transaction/(reference)/ endpoint to check the status.
Receive payments from your clients using generated links.
\nFormat: Json
\nParameters:
\nFormat: Json
\nParameters:
\nUse this endpoint to check for the status of an initiated transaction. When you perform an operation, for example, request payment, a reference UUID is returned which will serve as the reference for your requested transaction. Use the reference to check the transaction status
\n","urlObject":{"path":["api","transaction","(reference)",""],"host":["https://demo.campay.net"],"query":[],"variable":[]}},"response":[{"id":"231243eb-eb6a-402a-95c8-0a37a9850c30","name":"Pending Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInVpZCI6Mn0.eyJpYXQiOjE2MDc0OTk4MDMsIm5iZiI6MTYwNzQ5OTgwMywiZXhwIjoxNjA3NTAzNDAzfQ.wDVpvyC00u5EX8KpddbNc8zbg43XFBrDYD7gJbeAc3w","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://demo.campay.net/api/transaction/bcedde9b-62a7-4421-96ac-2e6179552a1a/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Oct 2020 19:02:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Accept-Language, Origin"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"reference\": \"85ac913b-bf64-49c5-979e-d175f058a6af\",\n \"external_reference\": \"\",\n \"status\": \"PENDING\",\n \"amount\": 2.0,\n \"currency\": \"XAF\",\n \"operator\": \"MTN\",\n \"code\": \"D201102W0002LK\",\n \"operator_reference\": null,\n \"description\": \"Test\",\n \"external_user\": \"\",\n \"reason\": null,\n \"phone_number\": \"2376xxxxxxxx\",\n \"endpoint\": \"collect\"\n}"},{"id":"56799411-51cc-495a-b810-b1cf8418f0fa","name":"Successful Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInVpZCI6Mn0.eyJpYXQiOjE2MDc0OTk4MDMsIm5iZiI6MTYwNzQ5OTgwMywiZXhwIjoxNjA3NTAzNDAzfQ.wDVpvyC00u5EX8KpddbNc8zbg43XFBrDYD7gJbeAc3w","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://demo.campay.net/api/transaction/bcedde9b-62a7-4421-96ac-2e6179552a1a/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Oct 2020 19:04:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Accept-Language, Origin"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"reference\": \"85ac913b-bf64-49c5-979e-d175XXXa6af\",\n \"external_reference\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"amount\": 2.0,\n \"currency\": \"XAF\",\n \"operator\": \"MTN\",\n \"code\": \"D201102W0002LK\",\n \"operator_reference\": null,\n \"description\": \"Test\",\n \"external_user\": \"\",\n \"reason\": null,\n \"phone_number\": \"2376xxxxxxxx\",\n \"endpoint\": \"collect\"\n}"},{"id":"a39cfbc6-5c0e-4c8f-84f9-dec415fcf5ac","name":"Failed Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInVpZCI6Mn0.eyJpYXQiOjE2MDc0OTk4MDMsIm5iZiI6MTYwNzQ5OTgwMywiZXhwIjoxNjA3NTAzNDAzfQ.wDVpvyC00u5EX8KpddbNc8zbg43XFBrDYD7gJbeAc3w","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://demo.campay.net/api/transaction/bcedde9b-62a7-4421-96ac-2e6179552a1a/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Oct 2020 19:04:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Accept-Language, Origin"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"reference\": \"85ac913b-bf64-49c5-979e-d175f058a6af\",\n \"external_reference\": \"\",\n \"status\": \"FAILED\",\n \"amount\": 2.0,\n \"currency\": \"XAF\",\n \"operator\": \"MTN\",\n \"code\": \"D201102W0002LK\",\n \"operator_reference\": null,\n \"description\": \"Test\",\n \"external_user\": \"\",\n \"reason\": null,\n \"phone_number\": \"2376xxxxxxxx\",\n \"endpoint\": \"withdraw\"\n}"}],"_postman_id":"d9278e44-aa8a-4ed1-85f7-7e0184dc35db"},{"name":"Withdraw funds","id":"885dbde0-b0dd-4514-a0f9-f84fc83df12d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInVpZCI6Mn0.eyJpYXQiOjE2MDc0OTk4MDMsIm5iZiI6MTYwNzQ5OTgwMywiZXhwIjoxNjA3NTAzNDAzfQ.wDVpvyC00u5EX8KpddbNc8zbg43XFBrDYD7gJbeAc3w","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"2\",\n \"to\": \"2376XXXXXXXX\",\n \"description\": \"Test\",\n \"external_reference\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.campay.net/api/withdraw/","description":"Withdraw funds from an app to a mobile money account. Ensure phone number has country code.
\nNote: Withdrawals through the API must be allowed under your application settings
\nThis endpoint supports Idempotency on external_reference field. If you make the first request with a particular external_reference and then make the second request with the same external_reference as the first, you will get the results of the first request. Change the external_reference or leave it blank to initiate a new transaction
\nFormat: Json
\nParameters:
\n\"amount\": \"A valid integer\" e.g \"5\",
\"to\": \"A valid phone number with country code\" e.g \"237679587525\",
\"description\": \"Payment description\",
\"external_reference\": \"OPTIONAL. You can use this field to specify the reference of the transaction generated by your system. We will return this reference to you on the /transaction status endpoint\"
\"external_reference\": \"A valid UUID4\". Example here https://www.uuidgenerator.net e.g \"a2707130-2419-441e-95b8-1bddefc2cbfb\". Each request should have a unique UUID. A request with a duplicate UUID will be rejected
Format: Json
\nParameters:
\n\"reference\": \"A valid UUID4. This reference is used to check the status of the transaction. Use the /transaction/(reference)/ endpoint to check the status.
Define a callback url under your registered app.
\nYour callback url will be notified when a transaction is SUCCESSFUL or FAILED.
You can set if your callback url should expect a GET or POST request.
*If your callback url method is GET, expect a request with the following parameters. If your callback url is POST, expect a request with following JSON data:
\nstatus: \"SUCCESSFUL\" or \"FAILED\",
reference: \"Reference of the transaction. A valid UUID4\",
amount: \"Transaction amount\",
currency: \"Transaction currency\",
operator: \"MTN or ORANGE\",
code: \"CamPay Reference\",
operator_reference: \"Mobile Operator Reference\"
signature:\"jwt token. You can validate this request that is coming from CamPay by using your app webhook key to validate the jwt token\"
endpoint: \"collect\" or \"withdraw\". This shows the kind of transaction that was performed. Deposits are \"collect\" while Withdrawals are \"withdraw\".
external_reference: The reference on the platform that initiated the transaction.
external_user: The user on the platform that initiated the transaction.
extra_first_name: First name provided when the transaction was initiated.
extra_last_name: Last name provided when the transaction was initiated.
extra_email: Email provided when the transaction was initiated.
Returns
\nThis endpoint is used to query your app's transaction history.
\nIt requires the \"start_date\" and \"end_date\" to be provided in the POST data.
\nNote: The date should be in the format YYYY-MM-DD
Transfer airtime to mobile numbers.\nOn sandbox or demo environment, manimum and maximum amount is 100 XAF
\n","urlObject":{"path":["api","utilities","airtime","transfer",""],"host":["https://demo.campay.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"544cb091-1104-4bf1-b9ad-893c5067c925"},{"name":"Utilities: Transaction Status","id":"e2686c97-565d-45dd-86f4-375e39268a44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInVpZCI6Mn0.eyJpYXQiOjE2MDc0OTk4MDMsIm5iZiI6MTYwNzQ5OTgwMywiZXhwIjoxNjA3NTAzNDAzfQ.wDVpvyC00u5EX8KpddbNc8zbg43XFBrDYD7gJbeAc3w","type":"text"}],"url":"https://demo.campay.net/api/utilities/transaction/(reference)/","description":"Check the status of an initiated utility(Airtime) transaction
\n","urlObject":{"path":["api","utilities","transaction","(reference)",""],"host":["https://demo.campay.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2686c97-565d-45dd-86f4-375e39268a44"},{"name":"Phone Number Holder Info","id":"7f8af623-82fd-4c17-850e-329d75823697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInVpZCI6Mn0.eyJpYXQiOjE2MDc0OTk4MDMsIm5iZiI6MTYwNzQ5OTgwMywiZXhwIjoxNjA3NTAzNDAzfQ.wDVpvyC00u5EX8KpddbNc8zbg43XFBrDYD7gJbeAc3w","type":"text"}],"url":"https://demo.campay.net/api/holder_info/?phone_number=237XXXXXXXX","description":"Check the name associated to a phone number
\n","urlObject":{"path":["api","holder_info",""],"host":["https://demo.campay.net"],"query":[{"key":"phone_number","value":"237XXXXXXXX"}],"variable":[]}},"response":[{"id":"ab352d1f-344f-4707-b22a-0361ee70f4e3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInVpZCI6Mn0.eyJpYXQiOjE2MDc0OTk4MDMsIm5iZiI6MTYwNzQ5OTgwMywiZXhwIjoxNjA3NTAzNDAzfQ.wDVpvyC00u5EX8KpddbNc8zbg43XFBrDYD7gJbeAc3w","type":"text"}],"url":{"raw":"https://demo.campay.net/api/holder_info/?phone_number=237XXXXXXXX","host":["https://demo.campay.net"],"path":["api","holder_info",""],"query":[{"key":"phone_number","value":"237XXXXXXXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 28 Jan 2026 06:30:58 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.12.3"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"40"},{"key":"Vary","value":"Accept-Language"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"full_name\": \"JOHN DOE\"\n}"},{"id":"a09d0314-afbb-40ca-9273-d43166a039dd","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInVpZCI6Mn0.eyJpYXQiOjE2MDc0OTk4MDMsIm5iZiI6MTYwNzQ5OTgwMywiZXhwIjoxNjA3NTAzNDAzfQ.wDVpvyC00u5EX8KpddbNc8zbg43XFBrDYD7gJbeAc3w","type":"text"}],"url":{"raw":"https://demo.campay.net/api/holder_info/?phone_number=237XXXXXXXX","host":["https://demo.campay.net"],"path":["api","holder_info",""],"query":[{"key":"phone_number","value":"237XXXXXXXX"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 28 Jan 2026 06:32:57 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.12.3"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"27"},{"key":"Vary","value":"Accept-Language"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No name found\"\n}"}],"_postman_id":"7f8af623-82fd-4c17-850e-329d75823697"}],"event":[{"listen":"prerequest","script":{"id":"707f0100-f316-4940-985e-14127767d704","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"01245fcb-2824-4d1c-973d-1b52ef88cf62","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://demo.campay.net"},{"key":"app_username","value":"b-8OfojjDf35sqwli92G2t_EU4s7Oxxbp0wEWvX_ITTUUsIkSLiQWo7c_jG0ok8E59EM8A5OXVQ-Y1FeTtTRnw"},{"key":"app_password","value":"hFOs7Ibg0yyN0fsDq8CFvI2QRZHmGgUMObyetKli0N07uZ8eq9d3Gr2GfjsQjvP9m5YtmQk7asBefJdNgwBzTg"},{"key":"access_token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInVpZCI6Mn0.eyJpYXQiOjE2MDc0OTk4MDMsIm5iZiI6MTYwNzQ5OTgwMywiZXhwIjoxNjA3NTAzNDAzfQ.wDVpvyC00u5EX8KpddbNc8zbg43XFBrDYD7gJbeAc3w"},{"key":"amount","value":"5"},{"key":"from","value":"2376XXXXXXXX"},{"key":"description","value":"Test"},{"key":"reference","value":"(reference)"},{"key":"external_reference","value":""},{"key":"currency","value":"XAF"},{"key":"to","value":"237XXXXXXXX"},{"key":"redirect_url","value":"https://example.com"},{"key":"first_name","value":"John"},{"key":"last_name","value":"Doe"},{"key":"email","value":"example@mail.com"}]}