PHPackages                             gitplus/payfluid - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. gitplus/payfluid

ActiveLibrary[Payment Processing](/categories/payments)

gitplus/payfluid
================

A wrapper around PayFluid's API

v1.0.0(3y ago)21192MITPHPPHP >=7.4

Since Feb 14Pushed 3y ago2 watchersCompare

[ Source](https://github.com/gitplus-apps/payfluid)[ Packagist](https://packagist.org/packages/gitplus/payfluid)[ Docs](https://github.com/gitplus-apps/payfluid)[ RSS](/packages/gitplus-payfluid/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (2)Versions (3)Used By (0)

A package that wraps eTranzact's [PayFluid payment API](https://documenter.getpostman.com/view/1587357/SWDzdLcg#3b4e3a30-4714-4d21-a53a-1ca938618ede)
=====================================================================================================================================================

[](#a-package-that-wraps-etranzacts-payfluid-payment-api)

📌 Overview
----------

[](#-overview)

This package simplifies the process of integrating PayFluid's payment into your application. It supports all the endpoints exposed by PayFluid.

- Generate secure credentials.
- Generate a payment link to collect payments.
- Verify payment details sent to your redirect url and callback url.
- Get the status of a previously made payment.
- Customize the payment page and also customize how the payment link behaves.

🚜 How it works
--------------

[](#-how-it-works)

Here is how the process usually flows:

1. Create a payment link
2. Redirect user to the payment page
3. User completes payment
4. User gets redirected to your redirect url with the status of the payment
5. Verify payment status
6. Offer value to your user if the payment is successful

That's it!!

📚 Contents
----------

[](#-contents)

- [📌 Overview](#-overview)
- [🚜 How it works](#-how-it-works)
- [️❗️ Notice](#-notice)
- [⏳ Installation](#-installation)
- [👼🏽 Basic Usage](#-basic-usage)
    - [Quick Start - Generate Payment Link](#1-generate-payment-link)
    - [Verify Payment - (Redirect URL)](#2-verify-transaction-on-your-redirect-url)
    - [Verify Payment - (Callback/Webhook URL)](#3-verify-transaction-on-your-callbackwebhook-url)
    - [Get Payment Status](#4-check-or-confirm-the-status-of-a-previous-payment)
- [💪🏽 Advanced Usage](#-advanced-usage)
    - [Customize Payment Page and Link](#1-customize-payment-page-and-link-behaviour)
- [✌🏽️ Tips and Tricks](#-tips)
    - [Pass and retrieve session values from urls](#1-pass-and-retrieve-session-value-from-redirect-or-callback-url)
- [⚠️ Issues](#-issues)
- [👊🏽 Contributions](#-contributions)

❗️ Notice
---------

[](#️-notice)

#### NB: Please note that the IP address of your host device (where you are making requests from) must be whitelisted by PayFluid for any of these to work.

[](#nb-please-note-that-the-ip-address-of-your-host-device-where-you-are-making-requests-from-must-be-whitelisted-by-payfluid-for-any-of-these-to-work)

⏳ Installation
--------------

[](#-installation)

You will need composer to install this package. You can [get it here](https://getcomposer.org/)

```
composer require gitplus/payfluid
```

👼🏽 Basic Usage
--------------

[](#-basic-usage)

> #### Kindly note that error handling has been intentionally left out of these examples for brevity.
>
> [](#kindly-note-that-error-handling-has-been-intentionally-left-out-of-these-examples-for-brevity)

### 1. Generate payment link.

[](#1-generate-payment-link)

Here a quick start to get you going quickly.

```