moathdev/tap

Tap payment API for Laravel

1.1.0 2021-03-08 21:15 UTC

Requires

• php: ^7.3|^8.0
• guzzlehttp/guzzle: ^7.2
• illuminate/support: ~7.0 || ~8.0

MIT

• Moathdev

• payment
• laravel
• tap

README

Pay payment API for Laravel 7.x & 8.x

You need to create an Account and create your access token in the Tap Payment website.

Installation

composer require  moathdev/tap

Configuration

Just set the below environment variables in your .env.

TAP_SECRET_KEY_LIVE=
TAP_SECRET_KEY_SANDBOX=

Advanced configuration

Run php artisan vendor:publish --provider="Moathdev\Tap\TapServiceProvider"

/config/tap.php

Usage

Functions

Charges

• getCharge() - Retrieves the details of a charge that has previously been created. Supply the unique charge id that was returned from your previous request, and Tap will return the corresponding charge information. The same information is returned when creating the charge.
• createCharge() - To charge a credit card or debit card (Knet, mada, Visa, MasterCard) or an existing authorized transactions, you create a charge request. If your API key is in test mode, the card won't actually be charged, though everything else will occur as if in live mode.
• updateCharge() - Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
• getAllCharges() - Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

Refunds

• getRefund() - Retrieves the details of an existing refund.
• createRefund() - Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the card that was originally charged.
• UpdateRefund() - Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
• getAllRefunds() - Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first.

Examples

• Retrieve a Charge

Route::get('/getCharge/{charge_id}', function($charge_id)
{
	$res = Tap::getCharge(['charge_id' => $charge_id]);

    dd($res);
});

• Create a Charge

Route::get('/createCharge', function()
{
	    $res  = Tap::createCharge([
            'amount'=> 1,
            'currency' => 'SAR',
            'threeDSecure' => true,
            'save_card' => false,
            'description' => 'Test Description',
            'statement_descriptor' => 'Sample',
            'metadata' => [
                'udf1' => 'test 1',
                'udf2' => 'test 2',
            ],
            'reference' => [
                'transaction' => 'txn_0001',
                'order' => 'ord_0001',
            ],
            'receipt' => [
                'email' => false,
                'sms' => false,
            ],
            'customer' => [
                'first_name' => "test",
                'middle_name' => "test",
                'last_name' => "test",
                'email' => "[e-mail]",
                'phone' => [
                    'country_code' => "965",
                    'number' => "50000000",
                ],
            ],
            'merchant' => [
                'id' => ''
            ],
            'source' => [
                'id' => 'src_all',
            ],
            'post' => [
                'url' => 'http://your_website.com/post_url'
            ],
            'redirect' => [
                'url' => 'http://your_website.com/post_url'
            ]
        ]);
        
        dd($res);
});

• Retrieve a Refund

Route::get('/getCharge/{refund_id}', function($refund_id)
{
	$res = Tap::getRefund(['refund_id' => $refund_id]);

    dd($res);
});

• Create a Refund

Route::get('/createRefund', function()
{
    $res  = Tap::createRefund([
        'charge_id' => 'chg_TS022520210006x9R20903398',
        'amount' => 1,
        'currency' => 'SAR',
        'description' => 'Test Description',
        'reason' => 'requested by customer',
        'reference' => [
            'merchant' => 'txn_0001'
        ],
        'metadata' => [
            'udf1' => 'test1',
            'udf2' => 'test2',
        ]
    ]);

    dd($res);

});