abdallahmohammed/laravel-telr

Pay online with Telr payment gateway through Laravel

v1.0.1 2024-03-24 02:49 UTC

Requires

• php: ^7.4|^8.0
• illuminate/http: ^6.0|^7.0|^8.0|^9.0
• illuminate/support: ^6.0|^7.0|^8.0|^9.0
• orchestra/testbench: ~3.0|^4.0|^5.0|^6.0|^7.0|^8.0
• phpunit/phpunit: ^6.0|^8.0|^9.0

MIT

• AbdallahMohammed

• payment
• laravel
• telr
• telr payment

README

Installation

You can install the package via composer:

composer require abdallahmohammed/laravel-telr

In Laravel starting from 6.x the service provider will automatically get registered. In older versions of the framework just add the service provider in config/app.php file:

'providers' => [
    // ...
    TelrGateway\TelrServiceProvider::class,
];

You can publish using the following provider

php artisan vendor:publish --provider="TelrGateway\TelrServiceProvider"

After that you can create the telr transaction table by running the migrations command:

php artisan migrate

When published, the config/telr.php config file contains:

return [
    // The current mode is live|production or test
    'test_mode' => env('TELR_TEST_MODE', true),

    // The currency of store

    'currency' => 'SAR',

    // The sale endpoint that receive the params
    // @see https://telr.com/support/knowledge-base/hosted-payment-page-integration-guide
    'sale' => [
        'endpoint' => 'https://secure.telr.com/gateway/order.json',
    ],

    // The hosted payment page use the following params as it explained in the integration guide
    // @see https://telr.com/support/knowledge-base/hosted-payment-page-integration-guide/#request-method-and-format
    'create' => [
        'ivp_method' => "create",
        'ivp_store' => env('TELR_STORE_ID', null),
        'ivp_authkey' => env('TELR_STORE_AUTH_KEY', null),
        'return_auth' => '/handle-payment/success',
        'return_can' => '/handle-payment/cancel',
        'return_decl' => '/handle-payment/declined',
    ]
];

Usage

After creating the route place the following code to redirect to bank page

$telrManager = new \TelrGateway\TelrManager();

$billingParams = [
        'first_name' => 'John',
        'sur_name' => 'Doe',
        // optional
        // 'address_1' => '',
        // 'address_2' => '',
        // 'city' => '',
        // 'region' => '',
        // 'zip' => '',
        'country' => 'EG',
        'email' => '[e-mail]',
    ];

return $telrManager->pay('ORDER_ID_GOES_HERE', 'TOTAL_AMOUNT', 'DESCRIPTION ...', $billingParams)->redirect();


> - note that if you want to avoid sending billing params while creating token to process the payment its applicable and the `Telr hosted payment page` will require it and will get the customer information on**check**request.

And on telr callback **(Success|Cancel|Declined)** to handle response put the following code:
```php
use \TelrGateway\TelrManager;

$telrManager = new TelrManager();
$telrManager->handleTransactionResponse($request);