Chpter (Chpter v0.1.1)
Documentation for Chpter
.
Summary
Functions
This function checks for the payment status from the Chpter API This is a recursive function that takes the following parameters
Initiates the Stk Push request to USing Chpter API
This function allows you to withdraw money from a Chpter account to a mobile wallet , in this case mpesa. This function takes the following parameters
Functions
check_for_payment(transaction_reference, api_endpoint)
This function checks for the payment status from the Chpter API This is a recursive function that takes the following parameters:
transaction_reference
- The reference to be used for the payment requestapi_endpoint
- The Chpter API endpoint where all the transactions are stored
Replace the `transaction_reference` with the reference to be used for the payment request
and the `api_endpoint` with the endpoint to be used to check for the payment status
Replace the api_key with your Chpter API key , the phone number with the phone number
to send the payment request to, the name with the name of the person to send the payment request to,
the email with the email of the person to send the payment request to, the amount with the amount to be paid,
the callback_url with the callback url to be used by Chpter to send the payment request response to and the transaction_reference
with the reference to be used for the payment request.
## Examples
iex> Chpter.check_for_payment("transaction_123456", "https://api.chpter.co/v1/transactions")
initiate_payment(api_key, phone_number, name, email, amount, location, callback_url, transaction_reference)
Initiates the Stk Push request to USing Chpter API
This function 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
Replace the api_key with your Chpter API key , the phone number with the phone number to send the payment request to, the name with the name of the person to send the payment request to, the email with the email of the person to send the payment request to, the amount with the amount to be paid, the callback_url with the callback url to be used by Chpter to send the payment request response to and the transaction_reference with the reference to be used for the payment request.
## Examples
iex> Chpter.initiate_payment(
"pk_4aff02227456f6b499820c2621ae181c9e35666d25865575fef47622265dcbb9",
"254740769596",
"Michael Munavu",
"michaelmunavu83@gmail.com",
1,
"Nairobi",
"https://720a-102-135-173-116.ngrok-free.app/api/transactions",
"transaction_123456"
)
withdraw(name, email, phone_number, amount, callback_url, payout_reference, api_key)
This function allows you to withdraw money from a Chpter account to a mobile wallet , in this case mpesa. This function takes the following parameters:
name
- The name of the person to send the payment request toemail
- The email of the person to send the payment request tophone_number
- The phone number to send the payment request toamount
- The amount to be paid as an integercallback_url
- The callback url to be used by Chpter to send the payment request response topayout_reference
- The reference to be used for the payment requestapi_key
- Your Chpter API key
Replace the `payout_reference` with the reference to be used for the payment request
and the `callback_url` with the url that chpter will send the response to .
A successful response will be as follows:
{ "message": "Success", "success": true, "status": 200, "amount": 100, "currency": "KES", "payout_reference": "ABCD123", }
A failed response will be as follows:
{ "message": "Payout failed contact support@chpter.co", "success": false, "status": 200, "payout_reference": "ABCD123", }
Replace the api_key with your Chpter API key for the account you want to withdraw from .
The amount is an integer and has to be a minimum of 20 KES .
## Examples
iex> Chpter.withdraw(
"Michael Munavu",
"michaelmunavu83@gmail.com",
"254740769596",
25,
"https://720a-102-135-173-116.ngrok-free.app/api/transactions",
"ABCD123",
"pk_4aff02227456f6b499820c2621ae181c9e35666d25865575fef47622265dcbb9"
)