View Source Chpter
Phoenix(Elixir) wrapper for chpter API implimentatio for Mpesa Payments in Kenya.
Installation
The package can be installed
by adding chpter
to your list of dependencies in mix.exs
:
def deps do
[
{:chpter, "~> 0.1.0"}
]
end
Run mix deps.get
to fetch from Hex
Usage
This is broken down into two parts:
1. Initiation
There is a function called initiate_payment
that takes in the following parameters:
api_key
- Your Chpter API keyphone_number
- The phone number to send the payment request toname
- The name of the person to send the payment request toemail
- The email of the person to send the payment request toamount
- The amount to be paidcallback_url
- The callback url to be used by Chpter to send the payment request response totransaction_reference
- The reference to be used for the payment request
iex> Chpter.initiate_payment(
"pk_4aff02227456f6b499820c2621ae181c9e35666d25865575fef47622265dcbb9",
"254740769596",
"Michael Munavu",
"michaelmunavu83@gmail.com",
1,
"https://720a-102-135-173-116.ngrok-free.app/api/transactions",
"123456")
2. Checking Transaction Status
There is a function called check_for_payment
that takes in the following parameters:
api_endpoint
- The Chpter API endpoint where all the transactions are storedtransaction_reference
- The reference to be used for the payment request
iex> Chpter.check_for_payment(
"https://api.chpter.co/v1/transactions",
"123456")
Documentation
AUthor
Licence
Chpter is released under MIT License