README

KuraimiBank Payment Gateway

The KuraimiBank-Payment Gateway is a comprehensive library designed to facilitate seamless transactions between domestic e-commerce suppliers and the Kuraimi bank applications, namely KJ and Mfloos. This API solution serves as a bridge, connecting the supplier's portal with the bank's applications, enabling efficient and secure payment processing.

By leveraging the KuraimiBank-Payment Gateway, suppliers can achieve enhanced integration with their front systems and platforms through the utilization of Web API technology. This integration empowers suppliers and their partners to conduct transactions effortlessly, ensuring a smooth user experience for their customers.

With its robust features and functionalities, the KuraimiBank-Payment Gateway simplifies the payment process for e-commerce suppliers. It enables them to securely manage and process payments, ensuring reliable and efficient financial transactions.

Overall, the KuraimiBank-Payment Gateway serves as a vital component in Kuraimi's E-Pay API solution, offering domestic e-commerce suppliers a powerful tool to seamlessly integrate their systems with Kuraimi bank applications, ultimately enhancing their payment processing capabilities.

Installation

You can install the package via Composer:

composer require al-saloul/kuraimibank-payment

Usage

Create these .env variables in your project:

KURAIMI_USERNAME=
KURAIMI_PASSWORD=
KURAIMI_BASE_URL=
KURAIMI_CURRENCY_ZONE=old # Ex: all, old, new
KURAIMI_WEBHOOK_URL=webhooks/kuraimibank/check-user # You can add your own webhook url here which should not exist in your project routes
KURAIMI_MODEL='\App\Models\User' # The model with namespace
KURAIMI_COLUMN_NAME='mobile'

The currency zone variable represent North Yemen Coin (old) , South Yemen Coin (new) or all Yemen coins (all).