Introduction

Introduction

API Root Endpoint

   https://api.camelotwave.com/api/ 
  

The CamelotWave API is built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

Getting Started

Example

    
{ "public_key":"CXT_pubkey-8398383989839938hrhrhfff", "access_key":"CXT_acckey-040934039039430940334jkjfkdj" "command":"load-data" }

To use our API you must satisfy these prerequistes

  1. A valid CamelotWave Account and password.
  2. Valid Api Keys, Both Public and Access Keys.

Authentication

All CamelotWave API Calls need to be authenticated using Api Keys.

You can obtain the Api Keys in any one of the following ways:

  1. Login to Your Account or Create One HERE
  2. Navigate to Dashboard > Api Keys, Access either LIVE or TEST keys depending on your needs.

NoAuth

CamelotWave REST APIs uses No Auth protocol to authorize and authenticate calls (The above approach of authentication via Api Keys will be deprecated soon). It provides secure access to protect resources thereby reducing the hassle of asking for a username and password everytime a user logs in. Follow the steps listed here, to access CamelotWave’s APIs using NoAuth

Step 1: Registering at Our Website HERE.

You will have to first register your application with CamelotWave's Developer console in order get your Public and Access Api Keys.

The CamelotWave API uses appropriate HTTP Protocoals for every action.

Method Description
POST Used for creating resources and performing resource actions.




















Errors

Request Example

https://api.camelotwave.com/api/sandbox/v3/card { "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "card-name": "ERIC HART", "card-number": "5258585922666506", "card-month": "09", "card-year": "21" }

Response Example

HTTP/1.1 201 Successfully Created Content-Type: application/json;charset=UTF-8 { "status": 00, "message": "Successfully charged" }
HTTP/1.1 404 Not Found Content-Type: application/json;charset=UTF-8 { "code": 1002, "message": "Endpoint does not exist" }
HTTP/1.1 500 Internal error Content-Type: application/json;charset=UTF-8 { "code": 1000, "message": "Internal error" }

CamelotWave uses HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range means success, 4xx range means there was an error in the provided information, and those in the 5xx range indicate server side errors. Commonly used HTTP status codes are listed below.

HTTP Status Codes

Status Code Descriptions
2xxSuccess
4xxBad request sent to server
5xxServer side error
Status Code Description
200 SuccessThe request was successfully completed.
201 CreatedThe request was a success and one or more resources have been created.
400 Bad requestThe request cannot be performed. Usually because of malformed parameter or missing parameter.
401 Unauthorized (Invalid AuthToken)Request was rejected because of invalid Api Key.
404 URL Not Found The URL you’ve sent is wrong. It’s possible that the resource you’ve requested has been moved to another URL.
405 Method Not AllowedThe requested resource does not support the HTTP method used. For example, requesting List of all charge transactions API with PUT as the HTTP method.
406 Not AcceptableThe requested response type is not supported by the client.
429 Too many requests Too many requests within a certain time frame.
500 Server errorCamelotWave server encountered an error which prevents it from fulfilling the request. Although this rarely happens, we recommend you to contact us at developers@camelotwave.com if you receive this error.

API Call Limit

API calls are limited to provide better quality of service and availability to all the merchants. The limits on total calls are illustrated below:

Charge Credit Card

CamelotWave Allows you Accept Credit Card Payment Instantly.

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/card

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/card

Card Charge Request Example

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "card-name": "ERIC HART", "card-number": "5258585922666506", "card-month": "09", "card-year": "21", "card-cvv": "909", "charge_amount": 10, "client_email": "test@camelotwave.com", "tx_referance": "MTX-REF-92939393", "client_ip": 127.0.0.1, }

Card Charge Response Example

  
{ "charge-status":"success", "osc_message":"credit card Billing Address Required", "system": { "osc_referance":"OSC_TCF-239212521546820628-CD_TLF", "tx_referance":"RW_T7329_8839381-rft", "status":"10-avs", or "10-pin" or "10-auth" or "00" "action_required":"AVS_AUTH", "loop_url":"N/A" } }

Card charge Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
card-name
Required
it highly advised to pass as a string, this is the card holder name it can be found on the front of the card.
card-number
Required
This is the 16 digit number infront of the credit card of the customer, should be passed as int.
card-month
Required
the month in which the card will expire, should be passed as int.
card-year
Required
the year in which the card will expire, should be passed as int
card-cvv
Required
The 3 or 4 Digit number behind the customer credit card, should be passed as int.
trex_referance
Required
this is the merchant unique referance that will be used to keep track of transaction, should be passed as string.

Card charge Responses Explained


If a 10-pin is returned as system.status value, you will be required to pass the system.osc_referance value and the card Pin and customer phone number. (Sample Payload below)

If a 10-avs is returned as system.status value, you are required to pass the card billing address from the customer and the value at system.osc_response. (Sample Payload below)

If a 10-auth is returned as system.status value, you are required to load the url in system.loop_url in an iframe then we pass the response to your call_back url that you setup in your account dashboard. (Sample Payload below)

If a 00 is returned as system.status value, this often hapens for cards with no auth, so if you get this response it means your charge was successfull, We then call your webhook with more transactions. you are advised to setup webhooks in your merchant dashboard. (Sample Payload below)

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/billing

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/billing

10-AVS Payload Sample(when returned as system.status value)

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "tx-zip-code": "20002", "tx-city": "Newyork", "tx-address": "Right hane street", "tx-state": "NY", "tx-country": "US", "osc_referance": "OSC_TCF-4921331035428754119-CD_TLF" }

10-AVS Payload Sample Response

  
{ "charge-status":"success", "osc_message":"", "system": { "osc_referance":"OSC_TCF-1162245723228357302712171150-CD_BLLN", "tx_referance":"RW_T5367_7950938-rft", "status":"10-auth", "action_required":"USER-AUTH", "loop_url":"https://api.camelotwave.com/api/sandbox/simulate-mock/card-charge/vbs-mock?osc_mocker=5d34bf71618e22453739215d34bf71618f0647782000", "charge_message":"Enter OTP Sent to Your Phone" } }

10-AVS Charge Payload Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
tx-zip-code
Required
The zip code of the card holder or customer, pass as string
tx-city
Required
The City of the card holder or customer.
tx-address
Required
The home addres of the card holder or customer
tx-state
Required
The home state of the card holder or customer. pass as string
tx-country
Required
The home country of the card holder or customer.
osc_referance
Required
This is the system.osc_response that was returned from the card charge endpoint. when you charged the card for the first time.

10-AVS Payload Response Explained

In Most cases you get a 10-auth as system.status value which tells you to load the returned url at system.loop_url in an iframe for the customer to confirm the transaction.

You are Rarely Likely to get a failed-avs response which tells you that the Customer or card holder address provided is invalid, therefore you are required to make the payload again from scratch.

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/pin

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/pin

10-PIN Payload Sample(when returned as system.status value)

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "card-pin": "3310", "phone-number": "186354995009", // must have the country code "osc_referance": "OSC_TCF-4921331035428754119-CD_TLF" }

10-PIN Payload Sample Response

  
{ "charge-status":"success", "osc_message":"", "system": { "osc_referance":"OSC_TPN-8201282564325062860344884692-TXCD", "tx_referance":"RW_T5367_7950938-rft", "status":"00", "action_required":"n/a", "loop_url":"n/a", "charge_message":"n/a" } }

10-PIN Charge Payload Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
card-pin
Required
Pin Code of the Card, this is Imputed by the Customer, You are highly advised not to store this PIN in your Database.
phone-number
Required
The Phone Number Of the customer, Most Recommended that one registered with the bank.
osc_referance
Required
This is the system.osc_response that was returned from the card charge endpoint. when you charged the card for the first time.

10-PIN Payload Response Explained

If the Imputed PIN is correct you will get a 00 as system.status value, this tells you that the transaction is successfull.

Incase a wrong PIN has been imputed you will immediately get an error message saying that the pin is wrong.




Card Charge Webhooks

After a Successfull Card Charge, CamelotWave Will Send You a Webhook with MOre Details About the Transaction, for that case you are highly advised to setup Webhooks and Call back Urls for better API experience.

CamelotWave Does Not Send Webhooks for failed card charge Transactions, because you get a response on your call back url upon transaction operation. eith Failed or Successfull.

Card Charge Webhook Sample

  
{ "event.executed": "CARD-TRANSACTION", "osc_referance": "OSC_TCF-6234248261152323442-CD_TLF", "trex_referance": "RW_T5529_8913417-rft", "status": "00", "b-processor": "CamelotWave.Direct", "charged-amount": "10", "currency": "USD" }


Charge MobileMoney Uganda

CamelotWave also Allows you to charge local Ugandan innovative payment platforms. like:

POST

SandBox Endpoint : https://api.camelotwave.com/api/sandbox/v3/mmcharge

Live EndPoint : https://api.camelotwave.com/api/coreprod/v3/mmcharge

MobileMoney Uganda Sample Charge Payload

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-country": "UG", "mm-network": "MTN", "mm-fname": "Kikomeko", "mm-lname": "Hudson", "charge-amount": 900, "phone-number": 256754120687, "voucher-number": "N/A", "client-email": "test@camelotwave.com", "client-ip": "127.0.0.1", "trex_referance": "MXT-83939393-MH" }

MobileMoney Uganda Sample Charge Response

  
{ "status":"charge-success", "osc_message": { "instruction_1":"Confirm With Your Pin", "instruction_2":"N/A" }, "system": { "status":"pending-u", "required_action":"MM-PIN-AUTH", "loop_url":"N/A", "osc_referance":"OSC_TMM-472432724359448808-M_TXT", "trex_referance":"RW_T6601_4104876-rmmt", "order_ref":"URF_MMGH_1563729677586_4944335" } }

MobileMoney Uganda Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-country
required
with this parameter tells us which mobile money country you want to charge, should be passed as string Expected Values are UG
mm-network
Required
this tells us which MobileMoney Wallet network you want to charge, should be passed as a string Expected Values are MTN or AIRTEL
mm-fname
Required
this is the first name of the customer as registered with the telecom company, should be passed as string
mm-lname
Required
this is the last name of the customer as registered with the telecom company, should be passed as string
charge-amount
Required
this is the amount to be charged to the customer, should be passed as INT
phone-number
Required
this is the customer phone number with country code :256754129874 that is to be charged, should be passed as string.

MobileMoney Uganda Charge Response Explained

status
Required
for a successfull charge this should return a charge-success
system.status
Required
this should return a pending-u on successful charge.
system.required_action
required
this parameter tells you what AUTH MODE is required to complete the charge.
osc_referance and order_ref
Required
these are the CamelotWave Payment Referances for this charge, you are advised to saved them in your database for fast support incase of any issue upon a transaction.
instruction_1 and instruction_2
Required
these tell you what is required to confirm the payment, you are advised to show them to the customer. these instructions are different depending on the mobile money network that is being charged.


Charge MobileMoney Ghana Sample Payload

CamelotWave also Allows you to charge local Ghanian innovative payment platforms. like:

POST

SandBox Endpoint : https://api.camelotwave.com/api/sandbox/v3/mmcharge

Live EndPoint : https://api.camelotwave.com/api/coreprod/v3/mmcharge

MobileMoney Ghana Sample Charge Payload

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-country": "GH", "mm-network": "TIG", "mm-fname": "Kikomeko", "mm-lname": "Hudson", "charge-amount": 900, "phone-number": 233754120687, "voucher-number": "N/A", //pass a value if network is vodafone "client-email": "test@camelotwave.com", "client-ip": "127.0.0.1", "trex_referance": "MXT-83939393-MH" }

MobileMoney Ghana Sample Charge Response

  
{ "status":"charge-success", "osc_message": { "instruction_1":"Dial *170# <|> Choose option: 6) Wallet <|> Choose option: 3) My Approvals", "instruction_2":"Enter your MOMO pin to retrieve your pending approval list <|> Choose a pending transaction <|> Tap button to continue" }, "system": { "status":"pending", "required_action":"MM-PIN-AUTH", "loop_url":"N/A", "osc_referance":"OSC_TMM-4276373314883813903-M_TXT", "trex_referance":"RW_T7328_2891876-rmmt", "order_ref":"URF_MMGH_1563728048957_8896235" } }

MobileMoney Ghana Charge Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-country
required
wih this parameter tells us which mobile money country you want to charge, should be passed as string Expected Values are GH
mm-network
Required
this tells us which MobileMoney Wallet network you want to charge, should be passed as a string Expected Values are MTN for MTN-GHANA or TIG for TIGO-GHANA or VDF FOR VODAFONE GHANA or AIR for AIRTEL GHANA   you can find more at the /wallets endpoint.
mm-fname
Required
this is the first name of the customer as registered with the telecom company, should be passed as string
mm-lname
Required
this is the last name of the customer as registered with the telecom company, should be passed as string
charge-amount
Required
this is the amount to be charged to the customer, should be passed as INT
phone-number
Required
this is the customer phone number with country code :233754129874 that is to be charged, should be passed as string.

MobileMoney Ghana Charge Response Explained

status
Required
for a successfull charge this should return a charge-success
system.status
Required
this should return a pending on successful charge.
system.required_action
required
this parameter tells you what AUTH MODE is required to complete the charge.
osc_referance and order_ref
Required
these are the CamelotWave Payment Referances for this charge, you are advised to saved them in your database for fast support incase of any issue upon a transaction.
instruction_1 and instruction_2
Required
these tell you what is required to confirm the payment, you are advised to show them to the customer. these instructions are different depending on the mobile money network that is being charged.


MobileMoney Rwanda

CamelotWave also Allows you to charge local Rwandan innovative payment platforms. like:

POST

SandBox Endpoint : https://api.camelotwave.com/api/sandbox/v3/mmcharge

Live EndPoint : https://api.camelotwave.com/api/coreprod/v3/mmcharge

MobileMoney Rwanda Sample Charge Payload

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-country": "RW", "mm-network": "MTN", "mm-fname": "Kikomeko", "mm-lname": "Hudson", "charge-amount": 100, "phone-number": 250754120687, "voucher-number": "N/A", //dont pass any value for MobileMoney Rwanda "client-email": "test@camelotwave.com", "client-ip": "127.0.0.1", "trex_referance": "MXT-83939393-MH" }

MobileMoney Rwanda Sample Charge Response

  
{ "status":"charge-success", "osc_message": { "instruction_1":"Please Confirm Transaction", "instruction_2":"N/A"}, "system": { "status":"pending-u", "required_action":"MM-PIN-AUTH", "loop_url":"N/A", "osc_referance":"OSC_TMM-5170348762240820183-M_TXT", "trex_referance":"RW_T7960_7856323-rmmt", "order_ref":"URF_MMGH_1563730009045_1918835" } }

MobileMoney Rwanda Charge Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-country
required
wih this parameter tells us which mobile money country you want to charge, should be passed as string Expected Values are RW
mm-network
Required
this tells us which MobileMoney Wallet network you want to charge, should be passed as a string Expected Values are MTN or AIRTEL
mm-fname
Required
this is the first name of the customer as registered with the telecom company, should be passed as string
mm-lname
Required
this is the last name of the customer as registered with the telecom company, should be passed as string
charge-amount
Required
this is the amount to be charged to the customer, should be passed as INT
phone-number
Required
this is the customer phone number with country code :25054129874 that is to be charged, should be passed as string.

MobileMoney Rwanda Charge Response Explained

status
Required
for a successfull charge this should return a charge-success
system.status
Required
this should return a pending on successful charge.
system.required_action
required
this parameter tells you what AUTH MODE is required to complete the charge.
osc_referance and order_ref
Required
these are the CamelotWave Payment Referances for this charge, you are advised to saved them in your database for fast support incase of any issue upon a transaction.
instruction_1 and instruction_2
Required
these tell you what is required to confirm the payment, you are advised to show them to the customer. these instructions are different depending on the mobile money network that is being charged.


MobileMoney Zambia

CamelotWave also Allows you to charge local Ugandan innovative payment platforms. like:

POST

SandBox Endpoint : https://api.camelotwave.com/api/sandbox/v3/mmcharge

Live EndPoint : https://api.camelotwave.com/api/coreprod/v3/mmcharge

MobileMoney Zambia Sample Charge Payload

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-country": "ZA", "mm-network": "MTN", "mm-fname": "Kikomeko", "mm-lname": "Hudson", "charge-amount": 100, "phone-number": 260754120687, "voucher-number": "N/A", //only pass a value when network is Vodafone "client-email": "test@camelotwave.com", "client-ip": "127.0.0.1", "trex_referance": "MXT-83939393-MH" }

MobileMoney Zambia Sample Charge Response

  
{ "status":"charge-success", "osc_message": { "instruction_1":"Please Confirm Transaction", "instruction_2":"N/A"}, "system": { "status":"pending-u", "required_action":"MM-PIN-AUTH", "loop_url":"N/A", "osc_referance":"OSC_TMM-5170348762240820183-M_TXT", "trex_referance":"ZA_T7960_7856323-rmmt", "order_ref":"URF_MMGH_1563730009045_1918835" } }

MobileMoney Zambia Charge Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-country
required
wih this parameter tells us which mobile money country you want to charge, should be passed as string Expected Values are ZA
mm-network
Required
this tells us which MobileMoney Wallet network you want to charge, should be passed as a string Expected Values are MTN
mm-fname
Required
this is the first name of the customer as registered with the telecom company, should be passed as string
mm-lname
Required
this is the last name of the customer as registered with the telecom company, should be passed as string
charge-amount
Required
this is the amount to be charged to the customer, should be passed as INT
phone-number
Required
this is the customer phone number with country code :26054129874 that is to be charged, should be passed as string.

MobileMoney Zambia Charge Response Explained

status
Required
for a successfull charge this should return a charge-success
system.status
Required
this should return a pending on successful charge.
system.required_action
required
this parameter tells you what AUTH MODE is required to complete the charge.
osc_referance and order_ref
Required
these are the CamelotWave Payment Referances for this charge, you are advised to saved them in your database for fast support incase of any issue upon a transaction.
instruction_1 and instruction_2
Required
these tell you what is required to confirm the payment, you are advised to show them to the customer. these instructions are different depending on the mobile money network that is being charged.


Mpesa Kenya

CamelotWave also Allows you to charge local Ugandan innovative payment platforms. like:

POST

SandBox Endpoint : https://api.camelotwave.com/api/sandbox/v3/mmcharge

Live EndPoint : https://api.camelotwave.com/api/coreprod/v3/mmcharge

Mpesa Sample Charge Payload

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-country": "KE", "mm-network": "Mpesa", "mm-fname": "Kikomeko", "mm-lname": "Hudson", "charge-amount": 100, "phone-number": 254754120687, "voucher-number": "N/A", //only required when network is vodafone "client-email": "test@camelotwave.com", "client-ip": "127.0.0.1", "trex_referance": "MXT-83939393-MH" }

Mpesa Sample Charge Response

  
{ "status":"charge-success", "osc_message": { "instruction_1":"Please Approval Transaction", "instruction_2":"N/A" }, "system": { "status":"pending-mp", "required_action":"MM-PIN-AUTH", "loop_url":"N/A", "osc_referance":"OSC_TMM-9034521072923884-M_TXT", "trex_referance":"RW_T7910_7650240-rmmt", "order_ref":"4529630929" } }

Mpesa Charge Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-country
required
wih this parameter tells us which mobile money country you want to charge, should be passed as string Expected Values are KE
mm-network
Required
this tells us which MobileMoney Wallet network you want to charge, should be passed as a string Expected Values are Mpesa
mm-fname
Required
this is the first name of the customer as registered with the telecom company, should be passed as string
mm-lname
Required
this is the last name of the customer as registered with the telecom company, should be passed as string
charge-amount
Required
this is the amount to be charged to the customer, should be passed as INT
phone-number
Required
this is the customer phone number with country code :254754129874 that is to be charged, should be passed as string.

Mpesa Charge Response Explained

status
Required
for a successfull charge this should return a charge-success
system.status
Required
this should return a pending-mp on successful charge.
system.required_action
required
this parameter tells you what AUTH MODE is required to complete the charge.
osc_referance and order_ref
Required
these are the CamelotWave Payment Referances for this charge, you are advised to saved them in your database for fast support incase of any issue upon a transaction.
instruction_1 and instruction_2
Required
these tell you what is required to confirm the payment, you are advised to show them to the customer. these instructions are different depending on the mobile money network that is being charged.


MobileMoney and Mpesa Webhooks

All MobileMoney and Mpesa Charge Webhooks are the Same with a few things in difference, Things linke :

Sample MobileMoney and Mpesa Webhooks

  
{ "event.executed": "MM-RWANDA", "osc_referance": "OSC_TMM-2883167631510738801-M_TXT", "trex_referance": "RW_T8541_4429295-rmmt", "status": "00", "b-processor": "CamelotWave.Direct", "charged-amount": "9000", "currency": "RWF" }




















How CamelotWave Bank Transfers Work


CamelotWave Allows you to Transfer to our local Partnered Banks Directly.
CamelotWave Also Supports the Following Payouts to different continents like :

When a Transfer is started CamelotWave Will call your webhook when it gets a response upon it then pass the details to you, you are highly advised to setup webhooks before further intergrations with our APIs.

When a Transfer is successfull, CamelotWave Will send you a webhook with status being 00, like in the previous examples when you get a 00 it means the transaction was successfull.

When a Transfer has failed, CamelotWave Will send you a webhook with status being failed, like in the previous examples when you dont get a 00 it means the transaction was not successfull.

African Bank Transfer Webhook Sample

  
{ "event.executed": "BANK.TRANSFER.NORMAL", "osc_referance": "OSC_TBT-69952_5842503_294835_2313771-TRS_BNT_PMCKDU_1", "trex_referance": "5d3561b0d89770.48655311", "status": "00", "b-status": "transfer-successful", "b-processor": "CamelotWave.Direct", "sent-amount": "20", "currency": "USD", "bank-route-response": "200-success-ok", "statement-descrip": "CamelotWave" }

International Bank Transfer Webhook Sample

  
{ "event.executed": "BANK.TRANSFER.INT", "osc_referance": "OSC_IXT-24440_4212004_2539620_4512602-IXT_BNX_PMCKDU_1", "trex_referance": "5d35ecb94be653.38045150", "status": "00", "b-status": "transfer-successful", "b-processor": "CamelotWave.Direct", "sent-amount": "90", "currency": "USD", "bank-route-response": "200-success-ok", "statement-descrip": "CamelotWave" }

Africa MobileMoney Transfer Webhook Sample

  
{ "event.executed": "RWANDA.TRANSFER.MM", "osc_referance": "RW_OSC_MM-18386_58752_2565013_2774387-IMM_PMCKDU_1", "trex_referance": "5d36080c2a2660.55250891", "status": "00", "network": "MTN-RWANDA", "b-status": "transfer-successful", "b-processor": "CamelotWave.Direct", "sent-amount": "274200", "currency": "RWF", // local currency has been exchanged USDtoRWF "telecom-route-response": "200-success-ok", "statement-descrip": "CamelotWave" }


African Bank Transfer ( Uganda, Kenya, Ghana,
Nigeria, Tanzania )

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/transfer-direct

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/transfer-direct

Transfer to Africa Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "to-country": "KE", "bank-code": "01",// can be found on the /banks endpoint "account-number": "0690000033", "account-name": "Wambura Amos", "transfer-amount": "90", "transfer-currency": "USD", "trex_referance": "M_YWYU9999990292" }

Transfer to Africa Response Sample

  
{ "transfer-status":"TRANSFER-INITIATED", "system": { "osc_referance":"OSC_TBT-69952_5842503_294835_2313771-TRS_BNT_PMCKDU_1", "trex_referance":"5d3561b0d89770.48655311", "bank-name":"Kenya Commercial Bank Limited", "account-number":"0690000033", "bank-response":"ready", "status":"00-02", "amount":"20", "currency":"USD", "beneficiary-name":"Wambura Amos", "T-date":"2019-07-22T00:12:41.000Z", "required-action":"inform reciever about transaction" } }

Transfer to Africa Transfer Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
to-country
Required
it highly advised to pass as a string, this tells us to which country you are sending Money. Expected Values : KE, UG, TZ, ZA, NG, GH
bank-code
Required
this is the bank code of the bank to which you are making a transfer, you can find them at the /banks endpoint, this should be passed as string
account-number
Required
this is a unique banking account number of the beneciary recieving the funds, should be passed as string
account-name
Required
this is the name in which the beneciary account number is registered, should be passed as string
transfer-amount
Required
this is the amount to be sent to the beneficialy minus transaction fees, should be passed as int.
transfer-currency
Required
this is the currency in which to transfer the money, Expected Values : USD ( for now ), should be passed as string
trex_referance
Required
this is the merchant unique referance that will be used to keep track of transaction, should be passed as string.

International Bank Transfers

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/itransfer

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/itransfer

International Transfer Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "to-country": "United States of America", "bank-name": "Bank of America", "account-number": "9498859490495", "account-name": "ERIC HART", "transfer-amount": 90, "transfer-currency": "USD", "trex_referance": "MREF-73838387484-83838", "routing-number": "8484848494", "swift-code": "UE788383939", "to-address": "Wall street, nile avenue" }

International Bank Transfer Response Sample

  
{ "transfer-status":"TRANSFER-INITIATED", "system": { "osc_referance":"OSC_IXT-18325_6516525_4585259_4646166-IXT_BNX_PMCKDU_1", "trex_referance":"5d35ed3053d900.87281282", "bank-name":"Bank of America", "account-number":"9498859490495", "status":"00-02", "amount":"90", "currency":"USD", "beneficiary-name":"ERIC HART", "T-date":"2019-07-22T10:07:54.000Z", "required-action":"inform reciever about transaction" } }

International Bank Transfer Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
to-country
Required
it highly advised to pass as a string, this tells us to which country you are sending Money. Expected Values : ISO codes or sortname of the country you are transfering to.
bank-name
Required
This is the bank name in which the beneficially has an account, this should be passed as string
account-number
Required
this is a unique banking account number of the beneciary recieving the funds, should be passed as string
account-name
Required
this is the name in which the beneciary account number is registered, should be passed as string
transfer-amount
Required
this is the amount to be sent to the beneficialy minus transaction fees, should be passed as int.
transfer-currency
Required
this is the currency in which to transfer the money, Expected Values : USD ( for now ), should be passed as string
trex_referance
Required
this is the merchant unique referance that will be used to keep track of transaction, should be passed as string.
routing-number
Required
this is the beneficiary bank routing number is a 9-digit code that will be used to identify where the beneficiary bank account was opened. It may also be known as an RTN, an ABA routing number, or a routing transit number.
swift-code
Required
this is the beneficiary bank SWIFT code, a code used to identify the country, bank and branch that an account is registered to. A SWIFT code is sometimes called a BIC (Bank Identifier Code) – but they’re exactly the same thing.
to-address
Required
this is the beneficiary home address, who is recieving the money.

MobileMoney Transfers

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/mm-transfer

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/mm-transfer

MobileMoney Transfer Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "network-code"=>"MTN", //these can be found on /wallets endpoint "network-name"=> "MTN-UGANADA", //these can be found on /wallets endpoint "to-number"=> "256754120687", "to-name"=> "Tom Doe", "amount"=> 300, "currency"=> "USD", //shoud be USD for easy currency exchange "to-country"=> "UG", "trex_referance"=> "MX-REF-838393393" }

MobileMoney Transfer Response Sample

  
{ "transfer-status":"TRANSFER-INITIATED", "system": { "osc_referance":"UG_OSC_MM-21550_7983516_6870998_3276436-IMM_PMCKDU_1", "trex_referance":"5d361297308379.08183923", "bank-name":"N/A", "account-number":"250754120687", "status":"00-02", "currency":"UGX", "beneficiary-name":"Tom Doe", "T-date":"N/A", "required-action":"Inform Reciever about Transaction" } }

MobileMoney Transfer Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
to-country
Required
it highly advised to pass as a string, this tells us to which country you are sending Money. Expected Values : UG or KE or RW or GH
network-code
Required
this is the network unique identification number that allows us to know which mobile money network are you sending to. these codes can be found from the /wallets endpoint, should be passed as string
network-name
Required
this is the name of the network you are sending money to, should be passed as string
to-number
Required
this is the phone number of the reciever that you are sending money to and you should allways add the country code

Example : 256 but not +256 not even this 07....10, but should be like 25675413230 and should be passed as string.
amount
Required
this is the amount to be sent minus the transaction fees, should be passed as int
currency
Required
this is the currency in which the exchange rate should be done, to the local currency of the reciever, it should be passed as
string, Expected Values : USD
trex_referance
Required
this is the merchant unique referance that will be used to keep track of transaction, should be passed as string.

CamelotWave Issued Credit Cards

CamelotWave gives the power to create and issue your own credit cards, with great power comes along reponsibility, CamelotWave Allows you to control these credit cards, ie.






Issue or Create Credit Card

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/create-card

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/create-card

Create Card Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "card-name":"Eric Hart", "card-address":"West, Ave Street, north bridge", "card-city":"New york", "card-state":"New york", "card-postal-code":"1002", "prefund-amount":90, "card-country":"US" }

Create Card Response Sample

  
{ "create-card":"success", "bank-card-route":"OSC_CXSD-29163_3264364-G1X", "system": { "system-id":"c16afa6f-3d20-4711-85f6-034a9493cc92", "card-number":"5563382600553614", "card-name":"ERIC HART", "card-mask-pan":"556338*******3614", "exp-date":"2022-07", "card-cvv":"017", "card-root-bank":"SILICON VALLEY BANK", "card-currency":"USD", "card-level":"fleet", "card-root-country":"United States", "card-country":"US", "card-type":"credit", "card-brand":"mastercard", "card-processor":"CamelotWave", "card-status":"active-valid", "creation-date":"2019-07-22T15:56:03.1827959+00:00", "card-security":"3ENC-DES-MIL-LEV-10", "card-network":"MasterCard", "global-access-enabled":"true", "local-access-enable":"true", "prefunded-amount":"90.00 USD", "card-fee":1.89, "cycle":"Monthly", "system-processor-fee":"4 USD" } }

Create Card Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
card-name
Required
this is the name that will appear on the credit card, or you can call it the card holder name.
network-code
Required
This is the card holders` Home address, or you can call it billing address.
card-city
Required
This is the home city of the card holder, or you can call it the billing city.
card-postal-code
Required
This is the home postal code of the card holder.
prefund-amount
Required
this is the amount to deposit on the card on creation or issuing. This should be in USD not less $5
card-country
Required
This is the home country of the card holder, or you can call it the billing country.
Expected Value : US

Freeze Credit Card

as we Stated, We empower you with the ability to control your own issued credit cards, see how to freeze a credi card.

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/card-control

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/card-control

Freeze Card Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "system-id"=>"ea303105-f31b-4d2d-aac8-4ec691cdffe9", "card-action"=>"freeze" //freeze or unfreeze }

Freeze Card Response Sample

  
{ "action-card":"success", "system": { "card-status":"freeze-success", "system-id":"ea303105-f31b-4d2d-aac8-4ec681cdffe9", "bank-route-code":"BC-USA-CD69321482-XCLD" } }

Freeze Card Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
card-action
Required
This is passed as the action to be performed upon the credit card, Expected Values freeze : to freeze a credit card unfreeze : to unlock a freezed credit card .
system-id
Required
This is returned with in the response after issuing of the credit card, as system.system-id

Unfreeze Credit Card

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/card-control

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/card-control

UnFreeze Card Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "system-id"=>"ea303105-f31b-4d2d-aac8-4ec691cdffe9", "card-action"=>"unfreeze" //freeze or unfreeze }

UnFreeze Card Response Sample

  
{ "action-card":"success", "system": { "card-status":"unfreeze-success", "system-id":"ea303105-f31b-4d2d-aac8-4ec681cdffe9", "bank-route-code":"BC-USA-CD69321482-XCLD" } }

UnFreeze Card Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
card-action
Required
This is passed as the action to be performed upon the credit card, Expected Values freeze : to freeze a credit card unfreeze : to unlock a freezed credit card .
system-id
Required
This is returned with in the response after issuing of the credit card, as system.system-id



Terminate Credit Card

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/terminate-card

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/terminate-card

Terminate Card Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "system-id": "ea303105-f31b-4d2d-aac8-4ec691cdffe9" }

Terminate Card Response Sample

  
{ "card-terminate":"SUCCESS", "system": { "osc_referance":"N/A", "trex_referance":"N/A", "status":"00-00", "required-action":"Credit Card Successfully Terminated", "bank-route-code":"success-00-tt" } }

Terminate Card Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
system-id
Required
This is returned with in the response after issuing of the credit card, as system.system-id

Get Freezed Credit Cards

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/xvcards

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/xvcards

Get Freezed Cards Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "card-status"=>"freezed" }

Get Freezed Card Response Sample

  
{ "cards": [ { "card_id":"ea303105-f31b-4d2d-aac8-4ec691cdffe9", "card_name":"Eric Hart", "card_pan":"556338*******5153", "card_type":"mastercard", "date_created":"2019-07-17T23:40:31.0015172+00:00", "date_freezed":"2019-07-22 <||> 08:39:51pm", "date_terminated":"2019-07-22 <||> 08:40:28pm" } ] }

Get Freezed Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
card-status
Required
This is the status in which the card is, ie.Terminated or Live or Freezed. Expected Value freezed

Get UnFreezed Credit Cards

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/xvcards

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/xvcards

Get UnFreezed Cards Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "card-status"=>"unfreezed" }

Get Unfreezed Cards Response Sample

  
{ "cards": [ { "card_id":"ea303105-f31b-4d2d-aac8-4ec691cdffe9", "card_name":"Eric Hart", "card_pan":"556338*******5153", "card_type":"mastercard", "date_created":"2019-07-17T23:40:31.0015172+00:00", "date_freezed":"2019-07-22 <||> 08:39:51pm", "date_terminated":"2019-07-22 <||> 08:40:28pm" } ] }

Get Freezed Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
card-status
Required
This is the status in which the card is, ie.Terminated or Live or Freezed. Expected Value unfreezed

Get Terminated Credit Cards

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/xvcards

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/xvcards

Get Terminated Cards Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "card-status"=>"terminated" }

Get Unfreezed Cards Response Sample

  
{ "cards": [ { "card_id":"ea303105-f31b-4d2d-aac8-4ec691cdffe9", "card_name":"Eric Hart", "card_pan":"556338*******5153", "card_type":"mastercard", "date_created":"2019-07-17T23:40:31.0015172+00:00", "date_freezed":"2019-07-22 <||> 08:39:51pm", "date_terminated":"2019-07-22 <||> 08:40:28pm" } ] }

Get Terminated Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
card-status
Required
This is the status in which the card is, ie.Terminated or Live or Freezed. Expected Value terminated

Fund Credit Cards

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/fund-card

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/fund-card

Fund Credit Cards Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "system-id": "ea303105-f31b-4d2d-aac8-4ec691cdffe9", "fund-amount": 20 }

Fund Credit Cards Response Sample

  
{ "funding-card":"success", "system": { "system-id":"b9713b5c-4cb5-464b-abdf-6006e806f8bb", "fund-amount":"20", "fund-currency":"USD", "card-processor":"CamelotWave", "bank-response-code":"00-success-00-v2", "fund-status":"00-success", "fund-referance":"OSC_FD-72413_74075-XPT" } }

Fund Card Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
system-id
Required
This is the system id of the target card returned in the system.system-id sample issue card payload response
fund-amount
Required
This is the amount to be deposited on the credit card. this amount should be in USD

Credit Card Charge Transactions

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/transactions

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/transactions

Credit Card Charge Transactions Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-command":"card-collections" }

Credit Card Charge Transactions Response Sample

  
{ "referance" : "osc_tcd-715440433849172170-cd" "merchant_referance" :"RW_T6657_7769656-rft" "amount" : "2.07" "currency" : "USD" "txdate" : "2019-07-19" "txtime" : "06:33:50pm" "status" : "00" "email" : "remitadmin@gmail.com" }

Credit Card Charge Transactions Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-command
Required
This is parameter tells the server which type of card transactions are you interested in, for this case its card charges or collections Expected value card-collections



MobileMoney Charge Transactions

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/transactions

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/transactions

MobileMoney Charge Transactions Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-command":"mm-ghana-collections" }

MobileMoney Charge Transactions Response Sample

  
{ "transaction-data": [ { "referance":"oscp-888434852192068817-mmt", "merchant_referance":"RW_T4430_3799672-rmmt", "order_number":"osc_ord-148717810166322030994", "amount":"900", "currency":"GHS", "txdate":"2019-07-14", "txtime":"02:55:26pm", "status":"02", "email":"micheal@gmail.com", "fname":"Eric", "lname":"Hart", "phone_number":"0754120687", "voucher":"N/A", "network":"MTN" } ] }

MobileMoney Charge Transactions Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-command
Required
This is parameter tells the server which type of MobileMoney Transactions are you interested in

see below for more details....

Expected Values:


mm-ghana-collections : All Ghana MobileMoney Collections
mm-uganda-collections : All Uganda MobileMoney Collections
mpesa-collections : All Mpesa MobileMoney Collections
mm-rwanda-collections : All Rwanda MobileMoney Collections
mm-zambia-collections : All Zambia MobileMoney Collections

International Bank Transfer Transactions

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/transactions

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/transactions

International Bank Transfer Transactions Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-command":"direct-bank-transfers" }

International Bank Transfer Transactions Response Sample

  
{ "transaction-data": [ { "referance":"OSC_IXT-10394_3127594_3006379_2195315-IXT_BNX_PMCK_ST_FDU_1", "merchant_referance":"MMMREX", "amount":"40", "currency":"USD", "txdate":"2019-07-20", "txtime":"11:16:13pm", "status":"03", "account_number":"05996905096", "holder_name":"Tom Millers", "bank":"National Bank Of Austria" } ] }

International Bank Transfer Transactions Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-command
Required
This is parameter tells the server which type of International Bank transactions are you interested in, for this case its card charges or collections Expected value direct-bank-transfers

African Bank Transfer Transactions

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/transactions

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/transactions

African Bank Transfer Transactions Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-command":"africa-bank-transfers" }

African Bank Transfer Transactions Response Sample

  
{ "transaction-data": [ { "referance":"OSC_TBT-16133_7052039_2945939_5878689-TRS_BNT_PMCK_ST_FDU_1", "merchant_referance":"REMMM-49409-IWOI-9029", "amount":"90", "currency":"USD", "txdate":"2019-07-20", "txtime":"10:00:41pm", "status":"03", "account_number":"89900999988", "holder_name":"STELLAH KAMYA" } ] }

African Bank Transfer Transactions Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-command
Required
This is parameter tells the server which type of African Bank transactions are you interested in, for this case its card charges or collections Expected value africa-bank-transfers

MobileMoney Transfer Transactions

POST

SandBox-Endpoint : https://api.camelotwave.com/api/sandbox/v3/transactions

Live-Endpoint : https://api.camelotwave.com/api/coreprod/v3/transactions

MobileMoney Transfer Transactions Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "mm-command":"mm-ghana-transfers" }

MobileMoney Transfer Transactions Response Sample

  
{ "transaction-data": [ { "referance":"oscp-888434852192068817-mmt", "merchant_referance":"RW_T4430_3799672-rmmt", "order_number":"osc_ord-148717810166322030994", "amount":"900", "currency":"GHS", "txdate":"2019-07-14", "txtime":"02:55:26pm", "status":"02", "email":"micheal@gmail.com", "fname":"Eric", "lname":"Hart", "phone_number":"0754120687", "voucher":"N/A", "network":"MTN" } ] }

MobileMoney Transfer Transactions Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
mm-command
Required
This is parameter tells the server which type of MobileMoney Transactions are you interested in

see below for more details....

Expected Values:


mm-ghana-transfers : All Ghana MobileMoney Transfers
mm-uganda-transfers : All Uganda MobileMoney Transfers
mpesa-transfers : All Mpesa MobileMoney Transfers
mm-rwanda-transfers : All Rwanda MobileMoney Transfers



Supported African Banks

POST

Endpoint : https://api.camelotwave.com/api/data/banks

View Supported African Banks Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "country" : "KE" }

View Supported African Banks Response Sample

  
{ "supported-banks": [ { "code":"16", "name":"Centenary Rural Development Bank Limited" }, { "code":"05", "name":"DFCU Bank" }, { "code":"01", "name":"Barclays Bank of Uganda Limited" }, { "code":"11", "name":"Orient Bank Ltd" }, { "code":"35", "name":"NC Bank Uganda Limited" }, { "code":"19", "name":"Diamond Trust Bank Uganda Limited" }, { "code":"29", "name":"Ecobank Uganda Limited" }, { "code":"06", "name":"Tropical Bank Ltd" }, { "code":"02", "name":"Bank of Baroda" }, { "code":"26", "name":"United Bank for Africa Uganda Ltd" }, { "code":"22", "name":"Citibank Uganda Ltd" }, { "code":"32", "name":"Exim Bank (Uganda) Ltd" }, { "code":"23","name":"Housing Finance Bank Ltd" }, { "code":"13", "name":"Bank of Africa Uganda Ltd." }, { "code":"37", "name":"Finance Trust Bank Ltd" }, { "code":"36", "name":"Commercial Bank of Africa (Uganda) Ltd" }, { "code":"25", "name":"KCB Bank Uganda Limited" }, { "code":"04", "name":"Stanbic Bank Uganda Ltd" }, { "code":"31", "name":"ABC Capital Bank Limited" }, { "code":"30", "name":"Equity Bank Uganda Ltd" }, { "code":"08", "name":"Standard Chartered Bank Uganda Limited" }, { "code":"18", "name":"Cairo International Bank Ltd" } ] }

View Supported African Banks Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
country
Required
This is parameter tells the server which country bank that you are interested in

see below for more details....

Expected Values:


KE : All Supported Kenyan Banks
UG : All Supported Ugandan Banks
TZ : All Tanzanian Supported Banks
ZA : All Zambian Supported Banks
NG : All Nigerian Supported Banks
GH : All Ghanian Supported Banks

Supported Mobile Wallets

POST

Endpoint : https://api.camelotwave.com/api/data/wallets

View Supported Mobile Wallets Payload Sample

  
{ "public_key": "CXT_pubkey-test-136740620695742292114-tx", "access_key": "CXT_acckey-test-1139949589005519065-tm", "country" : "GH" }

View Supported Mobile Wallets Response Sample

  
{ "wallets": [ { "code":"MTN", "network":"MTN Mobile Money" }, { "code":"TIG", "network":"TIGO Mobile Money" }, { "code":"VDF", "network":"Vodafone Mobile Money" }, { "code":"AIR", "network":"Airtel Mobile Money" } ] }

View Supported Mobile Wallets Parameters Explained

public_key
Required
This is your merchant public api key that can found at your dashboard->Api->keys.
access_key
Required
This key is so important it can befound in your merchant account dashbord->Api->keys, so its highly advised to keep secret and in a secure environment for it triggers full Api actions.
country
Required
This is parameter tells the server which country Wallets that you are interested in

see below for more details....

Expected Values:


KE : All Supported Kenyan Wallets
UG : All Supported Ugandan Wallets
ZA : All Zambian Supported Wallets
NG : All Nigerian Supported Wallets
GH : All Ghanian Supported Wallets


Demo Credit Cards

CamelotWave Demo Cards Should never be used for live transactions

5399 8383 8383 8381
Mastercard 3DSecure authentication
cvv: 470
Expiry: 10/22
Pin: 3310
otp: 12345
4751763236699647
Visa Card not 3DSecure
` Expiry: 09/21
cvv: pass as 909 (since this parameter cant be empty)
5061460410120223210
AVS and Pin authentication Card
Expiry Month 12
Expiry Year 21
cvv: 780
Pin: 3310
otp: 54321
4187427415564246
3Dsecure VisaCard (african issued)
cvv: 828
Expiry: 09/21
Pin: 3310
otp: 12345
4556052704172643
AVS and 3DSecure VisaCard
cvv: 899
Expiry: 01/21
5143010522339965
Card Declined Test Card
cvv 276
Expiry: 08/21
Pin 3310
5590131743294314
Card Fraudulent Test Card
cvv 887
Expiry: 11/20
Pin 3310
otp 12345
5258585922666506
Card Fraudulent Test Card
cvv 883
Expiry: 09/21
Pin 3310
otp 12345
4242 4242 4242 4242
VisaCard 3DSecure authentication
cvv: 812
Expiry: 01/21
Pin: 3310
otp: 54321

Demo Bank Accounts

CamelotWave Demo Bank Accounts Should never be used for live transactions

Demo Bank Accounts for Transfers

At the moment we are not able to make direct bank debits or charges (we are working as fast as we can to have this implemented), but we can make direct bank transfers. (local and international)

These bank accounts can only be used in TEST environment.

Account Number Should Be in Range 0690000031 to 0690000041



















Copy©Rights Reserved|CamelotWave