README

Chapa Package for Laravel

Chapa is one of the payment gateways in Ethiopia. This laravel package will help you integrate chapa with your next/existing laravel project.Install via

composer require semernur/chapa

This package has functionalities that will help you to easily initialize payment,verify payment at the moment and other functionalities will be added very soon .

Docs

First thing is first before you start using this package you need to have Chapa API key which you can get one from

Chapa

Once you get your API key add your secret key inside .env file or You can pass it directly to the constructor.if you are using the former method which is accessing via .env file the variable should have name CHAPA_SECRET_KEY . After successful installation you need to run php artisan migrate in order to setup database table for the package.

Available Methods

initializePayment(array $details, bool $will_redirect = FALSE, string $custom_ref = NULL)

$details, details you need to initialize in chapa's API. You don't need to pass authorization tokens! $will_redirect, if set to true it will redirect customer to the checkout_url automatically if the payment initialization was successful.

$custom_ref if not NULL initializePayment will use $custom_ref for chapa`s tx_ref field.

if $custom_ref is not defined and $ref_prefix is defined initializePayment will generate unique tx_ref with prefix $ref_prefix. Note:- initializePayment will return Chapa`s response/object whether you set $will_redirect to TRUE or FALSE.

verifyPayment(string $tx_ref, bool $only_status = FALSE)

This method will verify payment require $tx_ref transaction reference to the transaction need to be verified.If $only_status set to true it only return the status of the transaction TRUE if the transaction status is success false otherwise.

Enjoy!