Download the PHP package optiosteam/payconiq-client-php without Composer
On this page you can find all versions of the php package optiosteam/payconiq-client-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download optiosteam/payconiq-client-php
More information about optiosteam/payconiq-client-php
Files in optiosteam/payconiq-client-php
Package payconiq-client-php
Short Description Payconiq API client library for PHP developed by Optios.
License MIT
Informations about the package payconiq-client-php
PHP Payconiq API Client (unofficial)
Supported API version: v3
Development sponsored by Optios
API Documentation: https://developer.payconiq.com/online-payments-dock/#payment-api-version-3-v3-
Supported API functions
This library provides support for the following Payconiq API (v3) functions:
- Payconiq Instore (V3) - Terminal & Display
- Payconiq Instore (V3) - Static QR Sticker
- Payconiq Instore (V3) - Receipt
- Payconiq Invoice (V3) - Invoice
- Payconiq Online (V3) - Custom Online
- Payconiq Online (V3) - Checkout Flow Online
- Payconiq Online (V3) - App2App Linking
- Payconiq Online (V3) - Top-up
Not supported yet:
- Loyalty Integration
- Payout Reconciliation API
Installation
Requirement: PHP version >=7.2
Description
This library provides 3 main classes:
PayconiqApiClient
PayconiqCallbackSignatureVerifier
PayconiqQrCodeGenerator
PayconiqApiClient
This is the main class for performing REST calls to the Payconiq API, e.g. create payments, cancel payments, search payments & refund payments.
In the constructor you have to pass your Payconiq API key, optionally you can also inject your own Guzzle Client and specify if you want to use the production environment of the Payconiq API or the testing (Ext) environment.
PayconiqCallbackSignatureVerifier
This class is used for TLS Two-way TLS Encryption Support (TLS-Mutual Authentication). It verifies the callback body, JSON Web Signature (JWS) and the header fields in the JOSE header.
In the constructor you have to pass your Payconiq Payment Profile Id, optionally you can also inject your own Guzzle Client and Symfony Cache Adapter and specify if you want to use the production environment of the Payconiq API or the testing (Ext) environment.
The cache adapter is used to cache Payconiq's JWKS (JSON Web Key Set).
By default this library will use the FilesystemAdapter
which will use the file system for caching.
If you'd like to use another caching system, like Redis for example, you can inject your own (e.g. RedisAdapter
).
List of Symfony's Cache Adapters: https://symfony.com/doc/current/components/cache.html#available-cache-adapters
Note: when using the PayconiqCallbackSignatureVerifier
, make sure your server time is correct because the verifier checks the issued-at header timestamp.
PayconiqQrCodeGenerator
This class offers static functions to:
- Customize (color, size, format) QR code links (Used for
Terminal & Display
&Custom Online
) - Generate static QR code stickers links (Used for
Static QR Sticker
) - Generate QR code links with metadata, like: description, amount & reference (Used for
Receipt
,Invoice
&Top-up
)
Some examples
Request payment
Get payment
Cancel payment
Search payments
Refund payment
Verify callback (JWS)
QR link generation
Contributing
Feel free to submit pull requests for improvements & bug fixes.
please ensure your pull request adheres to the following guidelines:
- Enter a meaningful pull request description.
- Put a link to each library in your pull request ticket so it's easier to review.
- Use the following format for libraries: LIBRARY - DESCRIPTION.
- Make sure your text editor is set to remove trailing whitespace.
MIT License
All versions of payconiq-client-php with dependencies
composer/ca-bundle Version ^1.1
ext-json Version *
guzzlehttp/guzzle Version ^6.0|^7.0
league/url Version ^3.3
nesbot/carbon Version ^2.41
symfony/cache Version ^3.4|^4.0|^5.0|^6.0
web-token/jwt-checker Version ^2.2
web-token/jwt-signature Version ^2.2
web-token/jwt-signature-algorithm-ecdsa Version ^2.2