https://github.com/beamkenya/ex_mpesa
Daraja API(Mpesa) Payment Library for Elixir
https://github.com/beamkenya/ex_mpesa
daraja-api elixir elixir-lang mpesa-api payment
Last synced: 6 months ago
JSON representation
Daraja API(Mpesa) Payment Library for Elixir
- Host: GitHub
- URL: https://github.com/beamkenya/ex_mpesa
- Owner: beamkenya
- Created: 2021-04-23T10:41:50.000Z (about 5 years ago)
- Default Branch: develop
- Last Pushed: 2021-04-27T12:35:54.000Z (about 5 years ago)
- Last Synced: 2025-09-27T01:35:09.863Z (9 months ago)
- Topics: daraja-api, elixir, elixir-lang, mpesa-api, payment
- Language: Elixir
- Homepage:
- Size: 51.8 KB
- Stars: 8
- Watchers: 6
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
Awesome Lists containing this project
README
[](https://github.com/beamkenya/ex_mpesa/actions)   [](https://coveralls.io/github/beamkenya/ex_mpesa?branch=develop)
# ExMpesa
> Payment Library For Most Mpesa(Daraja) Payment API's in Kenya. Let us get this :moneybag:
## Table of contents
- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
- [Documentation](#documentation)
- [Contribution](#contribution)
- [Contributors](#contributors)
- [Licence](#licence)
## Features
- [x] STK Transaction Validation
- [x] B2C
- [x] B2B
- [x] C2B
- [x] Reversal
- [x] Transaction Status
- [x] Account Balance
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `ex_mpesa` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ex_mpesa, "~> 0.1.0"}
]
end
```
## Configuration
Create a copy of `config/dev.exs` or `config/prod.exs` from `config/dev.sample.exs`
Use the `sandbox` key to `true` when you are using sandbox credentials, chnage to `false` when going to `:prod`
### Mpesa (Daraja)
Mpesa Daraja API link: https://developer.safaricom.co.ke
Add below config to dev.exs / prod.exs files
This asumes you have a clear understanding of how [Daraja API works](https://developer.safaricom.co.ke/get-started).
You can also refer to this Safaricom Daraja API Tutorial: https://peternjeru.co.ke/safdaraja/ui/ by Peter Njeru
```elixir
config :ex_mpesa,
consumer_key: "72yw1nun6g1QQPPgOsAObCGSfuimGO7b",
consumer_secret: "vRzZiD5RllMLIdLD",
mpesa_short_code: "174379",
mpesa_passkey: "bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919",
mpesa_callback_url: "http://91eb0af5.ngrok.io/api/payment/callback"
```
## Documentation
The docs can be found at [https://hexdocs.pm/ex_mpesa](https://hexdocs.pm/ex_mpesa).
### Quick Examples
#### Mpesa Express (STK)
```elixir
iex> ExMpesa.Stk.request(%{amount: 10, phone: "254724540000", reference: "reference", description: "description"})
{:ok,
%{
"CheckoutRequestID" => "ws_CO_010320202011179845",
"CustomerMessage" => "Success. Request accepted for processing",
"MerchantRequestID" => "25558-10595705-4",
"ResponseCode" => "0",
"ResponseDescription" => "Success. Request accepted for processing"
}}
```
## Contribution
If you'd like to contribute, start by searching through the [issues](https://github.com/beamkenya/ex_mpesa/issues) and [pull requests](https://github.com/beamkenya/ex_mpesa/pulls) to see whether someone else has raised a similar idea or question.
If you don't see your idea listed, [Open an issue](https://github.com/beamkenya/ex_mpesa/issues).
Check the [Contribution guide](contributing.md) on how to contribute.
## Contributors
Auto-populated from:
[contributors-img](https://contributors-img.firebaseapp.com/image?repo=beamkenya/ex_mpesa)
## Licence
ExPesa is released under [MIT License](https://github.com/appcues/exsentry/blob/master/LICENSE.txt)
[](#)