Payze

<a href="https://github.com/payzeio/laravel-payze">This package</a> allows you to process payments with Payze.io from your Laravel application. <a href="https://github.com/payzeio/laravel-payze">https://github.com/payzeio/laravel-payze</a>

Laravel Payze.io Integration Package

<pre><code class="language-plaintext">composer require payzeio/laravel-payze
</code></pre> For Laravel &lt;= 5.4 If you're using Laravel 5.4 or lower, you have to manually add a service provider in your <code>config/app.php</code> file. Open <code>config/app.php</code> and add <code>PayzeServiceProvider</code> to the <code>providers</code> array. <pre><code class="language-php">'providers' =&gt; [
 # Other providers
 PayzeIO\LaravelPayze\PayzeServiceProvider::class,
],</code></pre> Publish migrations and config by running: <pre><code class="language-plaintext">php artisan vendor:publish --provider="PayzeIO\LaravelPayze\PayzeServiceProvider"
</code></pre> And run migrations: <pre><code class="language-plaintext">php artisan migrate</code></pre> <h5>API Keys</h5> Go to Payze.io website and generate an API key. Place key and secret to .env file: <pre><code class="language-plaintext">PAYZE_API_KEY=PayzeApiKey
PAYZE_API_SECRET=PayzeApiSecret
</code></pre>

Installation

You have to define success and fail routes in your application in order to finalize transactions. Go to your web.php (or wherever you store routes) and add the following: routes() function takes 3 optional parameters: Controller: Controller name, default: <code>App\Http\Controller\PayzeController</code> Success Method: Success method name, default: <code>success</code> Fail Method: Fail method name, default: fail <pre><code class="language-php">use PayzeIO\LaravelPayze\Facades\Payze;
// Other routes...
Payze::routes();</code></pre> These routes will have the names <code>payze.success</code> and <code>payze.fail</code>. If you have defined them under some namespace, then you can update names in config. For example, if you defined payze routes in api.php and that file has the name <code>api</code>., then your routes will be <code>api.payze.success</code> and <code>api.payze.fail.</code> Update them in config/payze.php file, stored in routes array.

Define Routes

The general variables are stored in <code>config/payze.php</code> file. More details: <h5>Log</h5> Enable/disable database detailed logging on every request/transaction. By default, the log is enabled on the local environment only. You can override the value from <code>.env</code> or directly from the config file. <h5>SSL Verification</h5> Enable/Disable SSL verification in Guzzle client to avoid SSL problems on some servers. Enabled by default. <h5>Routes</h5> Success and fail routes names, which are used to identify the finished transactions and update transaction status in the database. Update route names only if you have defined routes in a different namespace (like <code>api</code>). For example you will have <code>api.payze.success</code> and <code>api.payze.fail</code> URLs. <h5>Views</h5> Success and fail view names, which are displayed after a transaction is complete. You can override them and use your own pages with your own layout. By default, it uses an empty page with just status text (green/red colors) and a "return home" button. <h5>Transactions Table</h5> The name of the table in the database, which is used to store all of the transactions. <h5>Logs Table</h5> The name of the table in the database, which is used to store detailed logs about transactions and API requests. <h5>Card Tokens Table</h5> The name of the table in the database, which is used to store all of the saved card tokens. <h5>API Key</h5> API key of your <a href="https://payze.io/">Payze.io</a> account. <h5>API Secret</h5> API secret of your <a href="https://payze.io/">Payze.io</a> account.

Config

All of the requests are sent by corresponding classes, which extends the same class (PayzeIO\LaravelPayze\Concerns\ApiRequest). All requests are called statically by request() function (passing constructor data), then chain all of the needed data and then process(). Detailed instructions about needed data and options are in the next section.

Payments and Requests

If you need a one-time payment, then you should use the function. Parameters: <ul><li><code>Amount</code> - <code>float</code>, required</li></ul> Return: <code>Illuminate\Http\RedirectResponse</code> <pre><code class="language-php">use PayzeIO\LaravelPayze\Requests\JustPay;

return JustPay::request(1)
 -&gt;for($order) // optional
 -&gt;preauthorize() // optional
 -&gt;process();</code></pre>

Just Pay

Saving a card gives you a card token that you use for further manual charges without customer interaction. You can charge any amount and also save a card in one action, or you can set the amount to 0 to just save a card (Some banks may charge 0.1GEL and refund for saving a card). Card tokens are saved in <a href="https://github.com/payzeio/laravel-payze#card-tokens-table">database</a> and can be accessed by <a href="https://github.com/payzeio/laravel-payze/blob/master/src/Models/PayzeCardToken.php">PayzeCardToken</a> model or <a href="https://github.com/payzeio/laravel-payze#cards-relationship">cards relationship</a>. After requesting a payment, a card token is created in a database with an inactive status. After a successful charge, the card token becomes active automatically. IMPORTANT! If you want to associate a card token with the user and a transaction with an order, then you should use <code>assignTo</code> method, which receives a model instance of the owner of a card token. Parameters: <ul><li><code>Amount</code> - <code>float</code>, optional, default: <code>0</code></li></ul> Methods: <ul><li><code>assignTo</code> - <code>Illuminate\Database\Eloquent\Model</code>, optional, default: <code>null</code></li></ul> Return: <code>Illuminate\Http\RedirectResponse</code> <pre><code class="language-php">use PayzeIO\LaravelPayze\Requests\AddCard;

return AddCard::request(1)
 -&gt;for($order) // transaction will be assigned to order
 -&gt;assignTo($user) // optional: card token will be assigned to user. if not present, then will be assigned to order
 -&gt;process();</code></pre>

Add (Save) Card

You can pay with a saved card token anytime without customer interaction. Card tokens can be accessed by <a href="https://github.com/payzeio/laravel-payze/blob/master/src/Models/PayzeCardToken.php">PayzeCardToken</a> model or <a href="https://github.com/payzeio/laravel-payze#cards-relationship">cards relationship</a>. Filter tokens by active status (with <a href="https://github.com/payzeio/laravel-payze#active-scope"><code>active()</code> scope</a>) Parameters: <ul><li><code>CardToken</code> - <code>PayzeIO\LaravelPayze\Models\PayzeCardToken</code>, required</li><li><code>Amount</code> - <code>float</code>, optional, default: <code>0</code></li></ul> Return: <code>PayzeIO\LaravelPayze\Models\PayzeTransaction</code> <pre><code class="language-php">use PayzeIO\LaravelPayze\Requests\PayWithCard;

// Get user's latest saved card
$card = $user-&gt;cards()-&gt;active()-&gt;latest()-&gt;firstOrFail();

return PayWithCard::request($card, 15)
 -&gt;for($order) // optional
 -&gt;process();</code></pre>

Pay with a Saved Card

(charge) a blocked (<a href="https://github.com/payzeio/laravel-payze#preauthorize">preauthorized</a>) transaction. Parameters: <ul><li><code>TransactionId</code> - <code>string|PayzeIO\LaravelPayze\Models\PayzeTransaction</code>, required</li><li><code>Amount</code> - <code>float</code>, optional, default: <code>0</code>, (can be partially charged). 0 will charge full amount</li></ul> Return: <code>PayzeIO\LaravelPayze\Models\PayzeTransaction</code> <pre><code class="language-php">use PayzeIO\LaravelPayze\Requests\Commit;

return Commit::request($transaction)-&gt;process();</code></pre>

Commit

a <a href="https://github.com/payzeio/laravel-payze#refundable-scope">refundable</a> transaction. Parameters: <ul><li><code>TransactionId</code> - <code>string|PayzeIO\LaravelPayze\Models\PayzeTransaction</code>, required</li><li><code>Amount</code> - <code>float</code>, optional, default: <code>0</code>, (can be partially refunded). 0 will refund full amount</li></ul> Return: <code>PayzeIO\LaravelPayze\Models\PayzeTransaction</code> <pre><code class="language-php">use PayzeIO\LaravelPayze\Models\PayzeTransaction;
use PayzeIO\LaravelPayze\Requests\Refund;

$transaction = PayzeTransaction::refundable()-&gt;latest()-&gt;firstOrFail();

return Refund::request($transaction)-&gt;process();</code></pre>

Refund

Get transaction info and update in the database. Parameters: <ul><li><code>TransactionId</code> - <code>string|PayzeIO\LaravelPayze\Models\PayzeTransaction</code>, required</li></ul> Return: <code>PayzeIO\LaravelPayze\Models\PayzeTransaction</code> <pre><code class="language-php">use PayzeIO\LaravelPayze\Models\PayzeTransaction;
use PayzeIO\LaravelPayze\Requests\GetTransactionInfo;

$transaction = PayzeTransaction::latest()-&gt;firstOrFail();
</code></pre>

Transaction Info

Get balance info from the merchant's account. Return: <code>array</code> <pre><code class="language-php">use PayzeIO\LaravelPayze\Requests\GetBalance;

return GetBalance::request()-&gt;process();</code></pre>

Merchant's Balance

You can pass these parameters to all of the payment requests in Payze package.

Payment Request Options

All payment requests have an amount in the constructor, but also there is a separate method for changing the amount. <pre><code class="language-php">use PayzeIO\LaravelPayze\Requests\JustPay;

// Request 1 GEL originally
$request = JustPay::request(1);

// Some things happened, updating amount
return $request-&gt;amount(10)-&gt;process();</code></pre>

Amount

You can change your payment's currency by calling <code>currency()</code> function on the request. Default: <code>GEL</code> See supported currencies in <a href="https://github.com/payzeio/laravel-payze/blob/master/src/Enums/.php">currencies enum file</a>. Recommended: Pass currency by using an enum instead of directly passing a string. <pre><code class="language-php">use PayzeIO\LaravelPayze\Enums\Currency;
use PayzeIO\LaravelPayze\Requests\JustPay;

return JustPay::request(1)-&gt;currency(Currency::USD)-&gt;process();</code></pre>

Currency

Default controller should be published after running publish command from <a href="https://github.com/payzeio/laravel-payze#installation">Installation section</a>. You can add your custom logic to your controller in <code>successResponse</code> and <code>failResponse</code> methods. For example, you can set flash message, send notifications, mark order as complete or anything you want from that methods. IMPORTANT! If you return any non-NULL value from <code>successResponse</code> and <code>failResponse</code> methods, then that response will be used on success/fail routes. Otherwise <a href="https://github.com/payzeio/laravel-payze#views">default logic</a> will be used.

Controller

are fired after successful or failed transactions. You can <a href="https://laravel.com/docs/8.x/events#defining-listeners">define listeners</a> in your application in order to mark an order as paid, notify a customer or whatever you need. Both events have <code>$transaction</code> property. Paid Event: <code>PayzeIO\LaravelPayze\Events\PayzeTransactionPaid</code> Failed Event: <code>PayzeIO\LaravelPayze\Events\PayzeTransactionFailed</code>

Events

You can access all transactions logged in the database by <code>PayzeIO\LaravelPayze\\PayzeTransaction</code> model. Get all transactions: <pre><code class="language-php">use PayzeIO\LaravelPayze\Models\PayzeTransaction;

PayzeTransaction::all();</code></pre> <h5>Paid Scope</h5> Filter paid transactions with <code>paid()</code> scope. <pre><code class="language-php">use PayzeIO\LaravelPayze\Models\PayzeTransaction;

PayzeTransaction::paid()-&gt;get();</code></pre> <h5>Unpaid Scope</h5> Filter unpaid transactions with <code>unpaid()</code> scope. <pre><code class="language-php">use PayzeIO\LaravelPayze\Models\PayzeTransaction;

PayzeTransaction::unpaid()-&gt;get();</code></pre> <h5>Completed Scope</h5> Filter completed transactions with <code>completed()</code> scope. <pre><code class="language-php">use PayzeIO\LaravelPayze\Models\PayzeTransaction;

PayzeTransaction::completed()-&gt;get();</code></pre> <h5>Incomplete Scope</h5> Filter incomplete transactions with <code>incomplete()</code> scope. <pre><code class="language-php">use PayzeIO\LaravelPayze\Models\PayzeTransaction;

PayzeTransaction::incomplete()-&gt;get();</code></pre> <h5>Refundable Scope</h5> Filter refundable transactions with <code>refundable()</code> scope. <pre><code class="language-php">use PayzeIO\LaravelPayze\Models\PayzeTransaction;

PayzeTransaction::refundable()-&gt;get();</code></pre> <h5>Non-Refundable Scope</h5> Filter non-refundable transactions with <code>nonrefundable()</code> scope. <pre><code class="language-php">use PayzeIO\LaravelPayze\Models\PayzeTransaction;

PayzeTransaction::nonrefundable()-&gt;get();Section content</code></pre>

Models

Abandoned transactions with status <code>Created</code> are automatically reject after about 10 minutes, so you have to run a scheduler to update those transactions' statuses. If you don't already have a scheduler configured, read <a href="https://laravel.com/docs/scheduling#running-the-scheduler">how to configure</a> here. Register our console command in <code>app/Console/Kernel.php</code>'s <code>$commands</code> variable: <pre><code class="language-php">use PayzeIO\LaravelPayze\Console\Commands\UpdateIncompleteTransactions;

protected $commands = [
 // Other commands
 UpdateIncompleteTransactions::class,
];</code></pre> Then add a command in a schedule in <code>app/Console/Kernel.php</code>'s <code>schedule</code> function. We recommend to run a job every 30 minutes, but it's totally up to you and your application needs. <pre><code class="language-php">use PayzeIO\LaravelPayze\Console\Commands\UpdateIncompleteTransactions;

protected function schedule(Schedule $schedule)
{
 // Other commands
 $schedule-&gt;command(UpdateIncompleteTransactions::class)-&gt;everyThirtyMinutes();
}</code></pre>

Abandoned Transactions

Laravel

<a class="slate-a" href="https://github.com/payzeio/laravel-payze" target="_blank">This package</a> allows you to process payments with Payze.io from your Laravel application. <a class="slate-a" href="https://github.com/payzeio/laravel-payze" target="_blank">https://github.com/payzeio/laravel-payze</a>

<pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line">composer require payzeio/laravel-payze</div><div class="slate-code_line"></div></code></pre> For Laravel &lt;= 5.4 If you&apos;re using Laravel 5.4 or lower, you have to manually add a service provider in your <code class="slate-code">config/app.php</code> file. Open <code class="slate-code">config/app.php</code> and add <code class="slate-code">PayzeServiceProvider</code> to the <code class="slate-code">providers</code> array. <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line">&apos;providers&apos; =&gt; [</div></code></pre><pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json" selected="">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code class="language-json"><div class="slate-code_line">&lt;span class=&quot;hljs&quot;&gt;# Other providers&lt;/span&gt;</div><div class="slate-code_line">PayzeIO\LaravelPayze\PayzeServiceProvider::class,</div></code></pre>], Publish migrations and config by running: <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>php artisan vendor😛ublish --provider=&quot;PayzeIO\LaravelPayze\PayzeServiceProvider&quot; And run migrations: <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>php artisan migrate <div class="slate-h5"></div>API Keys Go to Payze.io website and generate an API key. Place key and secret to .env file: <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>PAYZE_API_KEY😛ayzeApiKey PAYZE_API_SECRET😛ayzeApiSecret

Publish migrations and config by running:

php artisan vendor😛ublish --provider="PayzeIO\LaravelPayze\PayzeServiceProvider"


Go to Payze.io website and generate an API key. Place key and secret to .env file:

PAYZE_API_KEY😛ayzeApiKey
PAYZE_API_SECRET😛ayzeApiSecret


The general variables are stored in <code class="slate-code">config/payze.php</code> file. More details: <div class="slate-h5">Log</div> Enable/disable database detailed logging on every request/transaction. By default, the log is enabled on the local environment only. You can override the value from <code class="slate-code">.env</code> or directly from the config file. <div class="slate-h5">SSL Verification</div> Enable/Disable SSL verification in Guzzle client to avoid SSL problems on some servers. Enabled by default. <div class="slate-h5">Routes</div> Success and fail routes names, which are used to identify the finished transactions and update transaction status in the database. Update route names only if you have defined routes in a different namespace (like <code class="slate-code">api</code>). For example you will have <code class="slate-code">api.payze.success</code> and <code class="slate-code">api.payze.fail</code> URLs. <div class="slate-h5">Views</div> Success and fail view names, which are displayed after a transaction is complete. You can override them and use your own pages with your own layout. By default, it uses an empty page with just status text (green/red colors) and a &quot;return home&quot; button. <div class="slate-h5">Transactions Table</div> The name of the table in the database, which is used to store all of the transactions. <div class="slate-h5">Logs Table</div> The name of the table in the database, which is used to store detailed logs about transactions and API requests. <div class="slate-h5">Card Tokens Table</div> The name of the table in the database, which is used to store all of the saved card tokens. <div class="slate-h5">API Key</div> API key of your <a class="slate-a" href="https://payze.io/" target="_blank">Payze.io</a> account. <div class="slate-h5">API Secret</div> API secret of your <a class="slate-a" href="https://payze.io/" target="_blank">Payze.io</a> account.

All of the requests are sent by corresponding classes, which extends the same class (PayzeIO\LaravelPayze\Concerns\ApiRequest). All requests are called statically by request() function (passing constructor data), then chain all of the needed data and then process(). Detailed instructions about needed data and options are in the next section.

You can pass these parameters to all of the payment requests in Payze package.

Default controller should be published after running publish command from <a class="slate-a" href="https://github.com/payzeio/laravel-payze#installation" target="_blank">Installation section</a>. You can add your custom logic to your controller in <code class="slate-code">successResponse</code> and <code class="slate-code">failResponse</code> methods. For example, you can set flash message, send notifications, mark order as complete or anything you want from that methods. IMPORTANT! If you return any non-NULL value from <code class="slate-code">successResponse</code> and <code class="slate-code">failResponse</code> methods, then that response will be used on success/fail routes. Otherwise <a class="slate-a" href="https://github.com/payzeio/laravel-payze#views" target="_blank">default logic</a> will be used.

are fired after successful or failed transactions. You can <a class="slate-a" href="https://laravel.com/docs/8.x/events#defining-listeners" target="_blank">define listeners</a> in your application in order to mark an order as paid, notify a customer or whatever you need. Both events have <code class="slate-code">$transaction</code> property. Paid Event: <code class="slate-code">PayzeIO\LaravelPayze\Events\PayzeTransactionPaid</code> Failed Event: <code class="slate-code">PayzeIO\LaravelPayze\Events\PayzeTransactionFailed</code>

You can access all transactions logged in the database by <code class="slate-code">PayzeIO\LaravelPayze\\PayzeTransaction</code> model. Get all transactions: <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line">use PayzeIO\LaravelPayze\Models\PayzeTransaction;</div></code></pre>PayzeTransaction::all(); <div class="slate-h5"></div>Paid Scope Filter paid transactions with paid() scope. <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>use PayzeIO&lt;span class=&quot;hljs&quot;&gt;LaravelPayze&lt;span class=&quot;hljs&quot;&gt;Models&lt;span class=&quot;hljs&quot;&gt;PayzeTransaction;PayzeTransaction::paid()-&gt;get(); <div class="slate-h5"></div>Unpaid Scope Filter unpaid transactions with unpaid() scope. <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>use PayzeIO&lt;span class=&quot;hljs&quot;&gt;LaravelPayze&lt;span class=&quot;hljs&quot;&gt;Models&lt;span class=&quot;hljs&quot;&gt;PayzeTransaction;PayzeTransaction::unpaid()-&gt;get(); <div class="slate-h5"></div>Completed Scope Filter completed transactions with completed() scope. <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>use PayzeIO&lt;span class=&quot;hljs&quot;&gt;LaravelPayze&lt;span class=&quot;hljs&quot;&gt;Models&lt;span class=&quot;hljs&quot;&gt;PayzeTransaction;PayzeTransaction::completed()-&gt;get(); <div class="slate-h5"></div>Incomplete Scope Filter incomplete transactions with incomplete() scope. <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>use PayzeIO&lt;span class=&quot;hljs&quot;&gt;LaravelPayze&lt;span class=&quot;hljs&quot;&gt;Models&lt;span class=&quot;hljs&quot;&gt;PayzeTransaction;PayzeTransaction::incomplete()-&gt;get(); <div class="slate-h5"></div>Refundable Scope Filter refundable transactions with refundable() scope. <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>use PayzeIO&lt;span class=&quot;hljs&quot;&gt;LaravelPayze&lt;span class=&quot;hljs&quot;&gt;Models&lt;span class=&quot;hljs&quot;&gt;PayzeTransaction;PayzeTransaction::refundable()-&gt;get(); <div class="slate-h5"></div>Non-Refundable Scope Filter non-refundable transactions with nonrefundable() scope. <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>use PayzeIO&lt;span class=&quot;hljs&quot;&gt;LaravelPayze&lt;span class=&quot;hljs&quot;&gt;Models&lt;span class=&quot;hljs&quot;&gt;PayzeTransaction;PayzeTransaction::nonrefundable()-&gt;get();Section content

PayzeTransaction::nonrefundable()->get();Section content

Abandoned transactions with status <code class="slate-code">Created</code> are automatically reject after about 10 minutes, so you have to run a scheduler to update those transactions&apos; statuses. If you don&apos;t already have a scheduler configured, read <a class="slate-a" href="https://laravel.com/docs/scheduling#running-the-scheduler" target="_blank">how to configure</a> here. Register our console command in <code class="slate-code">app/Console/Kernel.php</code>&apos;s <code class="slate-code">$commands</code> variable: <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line">use PayzeIO\LaravelPayze\Console\Commands\UpdateIncompleteTransactions;</div></code></pre>protected $commands = [ // Other commands UpdateIncompleteTransactions::class, ]; Then add a command in a schedule in app/Console/Kernel.php&apos;s schedule function. We recommend to run a job every 30 minutes, but it&apos;s totally up to you and your application needs. <pre class="slate-code_block"><select style="float:right" contenteditable="false"><option value="">Plain text</option><option value="antlr4">ANTLR4</option><option value="bash">Bash</option><option value="c">C</option><option value="csharp">C#</option><option value="css">CSS</option><option value="coffeescript">CoffeeScript</option><option value="cmake">CMake</option><option value="dart">Dart</option><option value="django">Django</option><option value="docker">Docker</option><option value="ejs">EJS</option><option value="erlang">Erlang</option><option value="git">Git</option><option value="go">Go</option><option value="graphql">GraphQL</option><option value="groovy">Groovy</option><option value="html">HTML</option><option value="java">Java</option><option value="javascript">JavaScript</option><option value="json">JSON</option><option value="jsx">JSX</option><option value="kotlin">Kotlin</option><option value="latex">LaTeX</option><option value="less">Less</option><option value="lua">Lua</option><option value="makefile">Makefile</option><option value="markdown">Markdown</option><option value="matlab">MATLAB</option><option value="markup">Markup</option><option value="objectivec">Objective-C</option><option value="perl">Perl</option><option value="php">PHP</option><option value="powershell">PowerShell</option><option value="properties">.properties</option><option value="protobuf">Protocol Buffers</option><option value="python">Python</option><option value="r">R</option><option value="ruby">Ruby</option><option value="sass">Sass (Sass)</option><option value="scss">Sass (Scss)</option><option value="scheme">Scheme</option><option value="sql">SQL</option><option value="shell">Shell</option><option value="swift">Swift</option><option value="svg">SVG</option><option value="tsx">TSX</option><option value="typescript">TypeScript</option><option value="wasm">WebAssembly</option><option value="yaml">YAML</option><option value="xml">XML</option></select><code ><div class="slate-code_line"></div></code></pre>use PayzeIO&lt;span class=&quot;hljs&quot;&gt;LaravelPayze&lt;span class=&quot;hljs&quot;&gt;Console&lt;span class=&quot;hljs&quot;&gt;Commands&lt;span class=&quot;hljs&quot;&gt;UpdateIncompleteTransactions;protected function schedule(Schedule $schedule) { // Other commands $schedule-&gt;command(UpdateIncompleteTransactions::class)-&gt;everyThirtyMinutes(); }

 function. We recommend to run a job every 30 minutes, but it's totally up to you and your application needs.

UpdateIncompleteTransactions

->command(UpdateIncompleteTransactions::class)->everyThirtyMinutes();
}

Sections