mdrazamani/asanpardakht-ipg-rest

There is no license information available for the latest version (1.0.26) of this package.

AsanPardakht IPG REST API integration package

Maintainers

Details

github.com/mdrazamani/AsanPardakhtIpgRest

Source

Issues

Installs: 58

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.0.26 2024-08-25 13:43 UTC

Requires

Requires (Dev)

Unknown License 9d95b9f1347e556d82d310e0fa4345e5a831690b

This package is auto-updated.

Last update: 2025-04-25 15:02:25 UTC

README

This Laravel package provides a seamless integration with AsanPardakht's IPG REST API, allowing you to handle online payments, transaction verifications, and settlements effortlessly.

Features

  • Token Generation: Easily generate payment tokens.
  • Transaction Verification: Verify the status of transactions.
  • Settlement Processing: Manage post-transaction settlements.
  • Seamless Redirection: Redirect users to the AsanPardakht payment gateway with ease.

Installation

To get started with this package, follow these simple steps:

1. Install via Composer

Run the following command in your Laravel project:

composer require mdrazamani/asanpardakht-ipg-rest

2. Publish Configuration

Publish the package configuration file using the following Artisan command:

php artisan vendor:publish --provider="mdrazamani\AsanPardakhtIpgRest\AsanPardakhtIpgRestServiceProvider"

3. Update Environment Variables

Add the following variables to your .env file to configure the package:

ASANPARDAKHT_USERNAME=your_username
ASANPARDAKHT_PASSWORD=your_password
ASANPARDAKHT_MERCHANT_CONFIG_ID=your_merchant_config_id
ASANPARDAKHT_CALLBACK_URL=your_callback_url

Usage

1. Generate Token and Redirect

Initiate a payment by generating a token and redirecting the user to AsanPardakht's payment gateway:

$gateway = app('asanpardakht')->init($invoiceId, $amount);
$response = $gateway->token();
$gateway->redirect($response['token']);

2. Verify Transaction

After the user returns to your site, verify the transaction:

$verifyResponse = app('asanpardakht')->verify($transactionId);

3. Process Settlement

Once the transaction is verified, you can process the settlement:

$settlementResponse = app('asanpardakht')->settlement($transactionId);

Methods Overview

  • init($invoiceId, $amount): Initializes the payment with the given invoice ID and amount.
  • token(): Generates a payment token.
  • verify($transactionId): Verifies the transaction.
  • settlement($transactionId): Processes the settlement for the given transaction.
  • redirect($token, $mobile = null): Redirects the user to the payment gateway.