farzai/promptpay

PromptPay QR Code Generator

2.0.0 2024-07-01 14:58 UTC

Requires

• php: ^8.1
• endroid/qr-code: ^5.0.0
• symfony/console: ^6.0

Requires (Dev)

• farzai/transport: ^1.3
• laravel/pint: ^1.2
• pestphp/pest: ^2.34.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• spatie/ray: ^1.28

MIT

• parsilver

• qr
• qr-code
• Promptpay
• farzai
• promptpay-qr

README

This library that allows you to create PromptPay QR codes. You can generate a QR code for receiving payments through PromptPay, which is a popular payment method in Thailand.

Requirements

• PHP 8.0 or higher

Installation (For CLI)

You can install the package globally via composer:

composer global require farzai/promptpay

Make sure to place Composer's system-wide vendor bin directory in your $PATH so the promptpay executable can be located by your system. This directory exists in different locations based on your operating system; however, some common locations include:

For macOS

$HOME/.composer/vendor/bin

For GNU / Linux Distributions

GNU / Linux Distributions: $HOME/.config/composer/vendor/bin

For Windows

%USERPROFILE%\AppData\Roaming\Composer\vendor\bin

Usage

$ promptpay <phone-number> <amount>

For example, to generate a QR code for receiving 100 THB from the phone number 0988888888:

$ promptpay 0988888888 100

Installation (For PHP Application)

You can install the package via composer:

composer require farzai/promptpay

Usage

For example, to generate a QR code for receiving 100 THB from the phone number 0988888888:

use Farzai\PromptPay\PromptPay;

$qrCode = PromptPay::create('0988888888', 100);

$imageUri = $qrCode->toDataUri('png');

echo '<img src="' . $imageUri . '" />';

Or you can save the QR code to a file:

use Farzai\PromptPay\PromptPay;

$qrCode = PromptPay::create('0988888888', 100):

$imagePath = $qrCode->toFile('qr-code.png');

echo 'QR code saved to ' . $imagePath;

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• parsilver
• All Contributors

License

The MIT License (MIT). Please see License File for more information.