README

Project Description

Telebirr Laravel Integration Package is a Laravel helper package for integrating Telebirr H5 Web payment functionality into Laravel applications. This package facilitates payment via the web, allowing third-party systems to invoke the interface upon payment issues by the customer. A redirect page is returned to the third-party system from the Telebirr platform upon payment completion.

Logical Specification

Platform Authentication Rule

• Telebirr platform allocates appId and appKey to corresponding third-party clients, uniquely identifying them.
• Third-party source IP addresses must be added to the trust list. IP addresses not on the trust list won't access the Telebirr system.
• The timestamp must be consistent with the server time (within one minute). Inconsistent access is considered illegal.
• Client-entered signatures must match the system-generated signatures. Inconsistent access is considered illegal.

Interface Description

Response Message Elements

Getting Started

Install the Telebirr Laravel Integration Package:

composer require dagim/telebirr-api:dev-main

Usage Example

use Dagim\TelebirrApi\Telebirr;

$telebirr = new Telebirr(
    env('TELEBIRR_APP_ID'),
    env('TELEBIRR_APP_KEY'),
    env('TELEBIRR_PUBLIC_KEY'),
    env('TELEBIRR_PRIVATE_KEY'),
    env('TELEBIRR_API_URL'),
    env('TELEBIRR_SHORT_CODE'),
    env('TELEBIRR_NOTIFY_URL'),
    env('TELEBIRR_RETURN_URL'),
    env('TELEBIRR_TIMEOUT_EXPRESS'),
    env('TELEBIRR_RECEIVE_NAME')
);

$title = 'Product Purchase';
$amount = 100.00;
$orderResult = $telebirr->createOrder($title, $amount);

if ($orderResult['success']) {
    // Payment creation successful
    $paymentId = $orderResult['payment_id'];
   
} else {
    // Payment creation failed
    $errorMessage = $orderResult['message'];
  
}