cleanup + readme

README.md

@@ -1,8 +1,8 @@
 # زرین پال | Zarinpal
 
-Zarinpal library for Laravel
+Zarinpal library for Laravel based on Zarinpal API v4
 
-کتابخانه زرین پال برای لاراول
+کتابخانه زرین پال برای لاراول براساس نسخه 4 ای‌پی‌آی زرین پال
 
 ## روش نصب - Installation
 
@@ -13,6 +13,7 @@ Use composer to install this package
 ```bash
 composer require pishran/zarinpal
 ```
+
 ## تنظیمات - Configuration
 
 Add your merchant id to .env file
@@ -23,6 +24,22 @@ Add your merchant id to .env file
 ZARINPAL_MERCHANT_ID=00000000-0000-0000-0000-000000000000
 ```
 
+To change currency to Toman (Default) 
+
+برای تغییر واحد پول به تومان (مقدار پیشفرض)
+
+```dotenv
+ZARINPAL_CURRENCY=IRT
+```
+
+To change currency to Rial
+
+برای تغییر واحد پول به ریال
+
+```dotenv
+ZARINPAL_CURRENCY=IRR
+```
+
 To enable sandbox mode
 
 برای فعالسازی حالت تست
@@ -33,17 +50,16 @@ ZARINPAL_SANDBOX_ENABLED=true
 
 ## روش استفاده | How to use
 
-### ارسال مشتری به درگاه پرداخت
+### ارسال مشتری به درگاه پرداخت | Send customer to payment gateway
 
 ```php
 $response = zarinpal()
-    ->amount(100) // مبلغ تراکنش به تومان
+    ->amount(100) // مبلغ تراکنش
     ->request()
-    ->zarin() // فعالسازی زرین گیت - اختیاری
-    ->callback('https://domain.com/verification') // آدرس برگشت پس از پرداخت
     ->description('transaction info') // توضیحات تراکنش
-    ->email('name@domain.com') // ایمیل مشتری - اختیاری
+    ->callbackUrl('https://domain.com/verification') // آدرس برگشت پس از پرداخت
     ->mobile('09123456789') // شماره موبایل مشتری - اختیاری
+    ->email('[email protected]') // ایمیل مشتری - اختیاری
     ->send();
 
 if (!$response->success()) {
@@ -57,10 +73,11 @@ if (!$response->success()) {
 return $response->redirect();
 ```
 
-### بررسی وضعیت تراکنش
+### بررسی وضعیت تراکنش | Verify payment status
 
 ```php
 $authority = request()->query('Authority'); // دریافت کوئری استرینگ ارسال شده توسط زرین پال
+$status = request()->query('Status'); // دریافت کوئری استرینگ ارسال شده توسط زرین پال
 
 $response = zarinpal()
     ->amount(100)
@@ -72,7 +89,13 @@ if (!$response->success()) {
     return $response->error()->message();
 }
 
+// دریافت هش شماره کاتری که مشتری برای پرداخت استفاده کرده است
+// $response->cardHash();
+
+// دریافت شماره کارتی که مشتری برای پرداخت استفاده کرده است (بصورت ماسک شده)
+// $response->cardPan();
+
 // پرداخت موفقیت آمیز بود
 // دریافت شماره پیگیری تراکنش و انجام امور مربوط به دیتابیس
 return $response->referenceId();
-```
+```

src/VerificationResponse.php

@@ -40,11 +40,6 @@ public function success(): bool
         return $this->code === 100;
     }
 
-    public function alreadyVerified(): bool
-    {
-        return $this->code === 101;
-    }
-
     public function cardHash(): string
     {
         return $this->cardHash;