Skip to content

Unofficial laravel package for Chapa's Payment api.

License

Notifications You must be signed in to change notification settings

MERQ-Systems/chapa-laravel

 
 

Repository files navigation

Unofficial laravel package for Chapa's API (Laravel 5,6,7,9 )

If your are doing a laravel project and want to integrate chapa's payment solution, this package would help big time.

Go to Chapa to signup and get your public and private key

Documentation

Please visit Chapa for full documentation.

Guide

Please visit Developers Guide for full guide and examples.

Usage

You can check this sample laravel code as a reference.

Configuration

Open your .env file and add your public key, secret keys, and other environment variables like this:

CHAPA_PUBLIC_KEY=FLWPUBK-xxxxxxxxxxxxxxxxxxxxx-X
CHAPA_SECRET_KEY=FLWSECK-xxxxxxxxxxxxxxxxxxxxx-X
CHAPA_WEBHOOK_SECRET='My_webook_secret_key123'

Features

The current features have been implemented

  • Initiate Payment
  • Payment verification

API Reference

Collecting Customer Information

  POST https://api.chapa.co/v1/transaction/initialize
Parameter Type Required Description
key string Yes. This will be your public key from Chapa. When on test mode use the test key, and when on live mode use the live key.
email string Yes. A customer’s email. address.
amount string Yes. The amount you will be charging your customer.
first_name string Yes. A customer’s first name.
last_name string Yes. A customer’s last name.
tx_ref string Yes. A unique reference given to each transaction.
callback_url string Yes. Function that runs when payment is successful. This should ideally be a script that uses the verify endpoint on the Paystack API to check the status of the transaction.
currency string Yes. The currency in which all the charges are made. Currency allowed is ETB.
customization[tiitle] string No. The customizations field (optional) allows you to customize the look and feel of the payment modal. You can set a logo, the store name to be displayed (title), and a description for the payment..
customization[description] string No. The customizations field (optional) allows you to customize the look and feel of the payment modal.

Verify Payments

  GET https://api.chapa.dev/v1/transaction/verify/{tx-ref}
Parameter Type Required Description
key string Yes. This will be your public key from Chapa. When on test mode use the test key, and when on live mode use the live key.

Changelog

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.

About

Unofficial laravel package for Chapa's Payment api.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%