pytekcoopbank

Co-operative Bank of Kenya Python SDK

Intuitive Python SDK for the Co-operative Bank of Kenya developer APIs.

Pre-requisites

Create an application

Create or login to your account at https://developer.co-opbank.co.ke:9443/store/

On the left panel, you can see a list of menus. Click on Applications to access the list of available applications in which case you can choose to use the default ones or create your own.

Subscribe to API(s)

• Select the application or create your own application using steps described earlier.
• Click “Subscribe”. A pop up message appears as shown:

Generate Keys

• Click on “Applications” on the left panel.
• Choose the application for which you want to generate keys
• Choose the appropriate environment from the tabs(production or sandbox ).
• Specify Callback URL and then click “Generate keys”. Leave other fields have default values;

Installation

Via PIP on pypi

# In terminal do:
$ pip install pytekcoopbank

Building from Source for Developers

$ git clone https://github.com/TralahM/pytekcoopbank.git
$ cd pytekcoopbank
$ python setup.py install

Documentation

Setup

import tekcoopbank

config=dict(
        env                 = "sandbox",
        consumerKey         = "ss0sD2ANhjvhx_rHU0a6Xf8ROdYa",
        consumerSecret      = "zOfReXCIwn1TfnEYJJJGNP6l3Tka",
        accountNumber       = "54321987654321",
        bankCode            = "011",
        branchCode          = "00011001",
        callbackURL         = "/coop/callback",
        transactionCurrency = "KES",
)

COOP=tekcoopbank.setup_coop(config)

Usage

By default all methods return a requests.HTTPResponse object. To get a python dict you can pass a callback to the send functions.

Example Callback Function To Pass to Send

callback=lambda x: x.json()

Check Account Balance

balance=COOP.balance.send(messageReference,accountNumber=None,callback=lambda x: x.json())

{
    "MessageReference": "wotfhPpsbxWY",
    "MessageDateTime": "2020-10-05 06:20:01",
    "MessageCode": "-8",
    "MessageDescription": "ACCOUNT AUTHORIZATION FAILURE"
}

Check Account Transactions

transactions=COOP.transactions.send(messageReference,accountNumber,NoOfTransactions=2,callback=lambda x: x.json())

{
    "MessageReference": "kRaiNxCTtgbV",
    "MessageDateTime": "2020-10-05 06:20:09",
    "MessageCode": "-8",
    "MessageDescription": "ACCOUNT AUTHORIZATION FAILURE"
}

Account MiniStatement

mini_statement=COOP.mini_statement.send(messageReference,accountNumber,callback=lambda x: x.json())

{
    "MessageReference": "xdpdBdEdCdYdAdOdudtdDdw",
    "MessageDateTime": "2020-10-05 07:45:54",
    "MessageCode": "-8",
    "MessageDescription": "ACCOUNT AUTHORIZATION FAILURE"
}

Account FullStatement

full_statement=COOP.full_statement.send(messageReference,accountNumber,callback=lambda x: x.json())

{
    "MessageReference": "MdKdNdYdzdAdydQdtdpdedH",
    "MessageDateTime": "2020-10-05 07:45:59",
    "MessageCode": "-8",
    "MessageDescription": "ACCOUNT AUTHORIZATION FAILURE"
}

Account Validation

validation=COOP.validation.send(messageReference,accountNumber,callback=lambda x: x.json())

{
    "MessageReference": "eDyClhTgirbw",
    "MessageDateTime": "2020-10-05 06:33:04",
    "MessageCode": "-1",
    "MessageDescription": "INVALID ACCOUNT NUMBER"
}

Get Exchange Rates

exchange_rate=COOP.exchange_rate.send(messageReference,
    fromCurrencyCode="KES",
    toCurrencyCode="USD",
    callback=lambda x: x.json())

{
    "MessageReference": "HdKdAdidLdtdGdadFdydxdS",
    "MessageDateTime": "2020-10-05 07:33:16",
    "MessageCode": "0",
    "MessageDescription": "Success",
    "FromCurrencyCode": "KES",
    "ToCurrencyCode": "USD",
    "RateType": "SPOT",
    "Rate": "104.35",
    "Tolerance": "23",
    "MultiplyDivide": "D"
}

IFT Account to Account Transfer

ift_to_account=COOP.ift_to_account.send(messageReference,
    accountNumber,
    amount,
    transactionCurrency="KES",
    narration="Payment",
    destinations=[{},],
    callback=lambda x: x.json())

{
    "MessageReference": "sdkdddIdUdndpdxdcdedodr",
    "MessageDateTime": "2020-10-05T06:10:29",
    "MessageCode": "-5",
    "MessageDescription": "DEBIT AND CREDITS AMOUNTS NOT BALANCING"
}

PesaLink Account to Account Transfer

pesalink_to_account=COOP.pesalink_to_account.send(messageReference,
    accountNumber,
    amount,
    transactionCurrency="KES",
    narration="Payment",
    destinations=[{},],
    callback=lambda x: x.json())

{
    "MessageReference": "rdhdjdvdYdKdidkdQdFdDdg",
    "MessageDateTime": "2020-10-05T07:10:05",
    "MessageCode": "-5",
    "MessageDescription": "DEBIT AND CREDIT(S) AMOUNTS NOT BALANCING"
}

PesaLink Account to Phone Transfer

pesalink_to_phone=COOP.pesalink_to_phone.send(messageReference,
    phoneNumber,
    amount,
    transactionCurrency="KES",
    narration="Payment",
    destinations=[{},],
    callback=lambda x: x.json())

{
    "MessageReference": "tdUdXdOdJdVdgdsdNdddhdw",
    "MessageDateTime": "2020-10-05T07:10:09",
    "MessageCode": "-5",
    "MessageDescription": "DEBIT AND CREDIT(S) AMOUNTS NOT BALANCING"
}

Send to Mpesa

to_mpesa=COOP.to_mpesa.send(messageReference,
    mobileNumber,
    amount,
    transactionCurrency="KES",
    narration="Payment",
    destinations=[{},],
    callback=lambda x: x.json())

{
    "MessageReference": "gdBdJdPdudOdpdLdndidrdj",
    "MessageDateTime": "2020-10-05T07:10:13",
    "MessageCode": "-5",
    "MessageDescription": "DEBIT AND CREDIT(S) AMOUNTS NOT BALANCING"
}

Transaction Status

transaction_status=COOP.transaction_status.send(messageReference,callback=lambda x: x.json())

{
    "MessageReference": "XHJaVzZGOsjB",
    "MessageDateTime": "2020-10-05 06:20:06",
    "MessageCode": -13,
    "MessageDescription": "MESSAGE REFERENCE DOES NOT EXIST",
    "Source": {
        "AccountNumber": null,
        "Amount": null,
        "TransactionCurrency": null,
        "Narration": null,
        "ResponseCode": null,
        "ResponseDescription": null
    },
    "Destinations": null
}

Test Cases

As a developer, the test cases will be available to you for download as you are creating the sandbox app.

The test cases are in place to ensure that you have well understood the API structure for requests and responses for our different APIs. These test cases are in an excel spreadsheet that you should fill in with the results from each of the test scenarios that you want to consume.

As the Test cases will cover all the APIs available, you will only be required to carry out the test cases for the APIs you had initially selected.

Go - Live

Once you have already tried out the APIs on our platform and have tested these against our test cases provided, you can make a formal request to go to production.

You will need to have the test cases duly filled, then send an email request, together with these filled in test cases, to our support team who will guide you on the next steps to enable you to get to production.

Send the email request and the test cases to digitalbanking@co-opbank.co.ke

Contributing

See the Contributing File

See the Pull Request File

Support

LICENCE

Read the license here

Self-Promotion