The Bayarcash SDK provides an expressive interface for interacting with Bayarcash's Payment Gateway API. This SDK supports both API v2 and v3, with enhanced features available in v3.
To install the SDK in your project you need to require the package via composer:
composer require webimpian/bayarcash-php-sdkYou can create an instance of the SDK like so:
$bayarcash = new Webimpian\BayarcashSdk\Bayarcash(TOKEN_HERE); $bayarcash->useSandbox(); // call this method to switch to use sandboxFor Laravel user:
// set value for BAYARCASH_API_TOKEN and BAYARCASH_API_SECRET_KEY in the .env file BAYARCASH_API_TOKEN= BAYARCASH_API_SECRET_KEY=$bayarcash = app(\Webimpian\BayarcashSdk\Bayarcash::class); $bayarcash->useSandbox(); // call this method to switch to use sandbox// Optional: Set API version (default is 'v2') $bayarcash->setApiVersion('v3');The SDK supports multiple payment channels:
Bayarcash::FPX // FPX Online Banking Bayarcash::MANUAL_TRANSFER // Manual Bank Transfer Bayarcash::FPX_DIRECT_DEBIT // FPX Direct Debit Bayarcash::FPX_LINE_OF_CREDIT // FPX Line of Credit Bayarcash::DUITNOW_DOBW // DuitNow Online Banking Bayarcash::DUITNOW_QR // DuitNow QR Bayarcash::SPAYLATER // ShopeePayLater Bayarcash::BOOST_PAYFLEX // Boost PayFlex Bayarcash::QRISOB // QRIS Online Banking Bayarcash::QRISWALLET // QRIS Wallet Bayarcash::NETS // NETS Bayarcash::CREDIT_CARD // Credit Card Bayarcash::ALIPAY // Alipay Bayarcash::WECHATPAY // WeChat Pay Bayarcash::PROMPTPAY // PromptPay Bayarcash::TOUCH_N_GO // Touch 'n Go eWallet Bayarcash::BOOST_WALLET // Boost Wallet Bayarcash::GRABPAY // GrabPay Bayarcash::GRABPL // Grab PayLater Bayarcash::SHOPEE_PAY // ShopeePay// Get all available portals $portals = $bayarcash->getPortals(); // Get available payment channels for a specific portal $channels = $bayarcash->getChannels('your_portal_key');// Get list of available FPX banks $banks = $bayarcash->fpxBanksList();Note: The checksum value and checksum validation are optional, but it is recommended for enhanced security.
// Generate checksum for payment intent $paymentIntentRequestChecksum = $bayarcash->createPaymentIntenChecksumValue(API_SECRET_KEY, REQUEST_DATA); // append checksum value to your REQUEST_DATA $data['checksum'] = $paymentIntentRequestChecksum; // Send payment request $response = $bayarcash->createPaymentIntent(REQUEST_DATA); header("Location: " . $response->url); // redirect payer to Bayarcash checkout page.// Verify callbacks // pre-transaction callback $validPreTransaction = $bayarcash->verifyPreTransactionCallbackData(CALLBACK_DATA, API_SECRET_KEY); // transaction callback $validTransaction = $bayarcash->verifyTransactionCallbackData(CALLBACK_DATA, API_SECRET_KEY); // return URL callback $validReturnUrl = $bayarcash->verifyReturnUrlCallbackData(CALLBACK_DATA, API_SECRET_KEY);// Get payment intent details (V3 API only) $paymentIntent = $bayarcash->getPaymentIntent('payment_intent_id');// Get single transaction $transaction = $bayarcash->getTransaction('transaction_id'); // V3 API Features if ($bayarcash->getApiVersion() === 'v3') { // Get all transactions with filters $transactions = $bayarcash->getAllTransactions([ 'order_number' => 'ORDER123', 'status' => '3', 'payment_channel' => Bayarcash::FPX, 'exchange_reference_number' => 'REF123', 'payer_email' => 'customer@example.com' ]); // Specialized transaction queries $orderTransactions = $bayarcash->getTransactionByOrderNumber('ORDER123'); $emailTransactions = $bayarcash->getTransactionsByPayerEmail('customer@example.com'); $statusTransactions = $bayarcash->getTransactionsByStatus('3'); $channelTransactions = $bayarcash->getTransactionsByPaymentChannel(Bayarcash::FPX); $refTransaction = $bayarcash->getTransactionByReferenceNumber('REF123'); }$enrolmentRequestChecksum = $bayarcash->createFpxDirectDebitEnrolmentChecksumValue(API_SECRET_KEY, REQUEST_DATA); // append checksum value to your REQUEST_DATA $data['checksum'] = $enrolmentRequestChecksum; $response = $bayarcash->createFpxDirectDebitEnrollmentIntent($data); header("Location: " . $response->url); // redirect payer to Bayarcash Fpx Direct Debit enrolment page.$maintenanceRequestChecksum = $bayarcash->createFpxDirectDebitMaintenanceChecksumValue(API_SECRET_KEY, REQUEST_DATA); // append checksum value to your REQUEST_DATA $data['checksum'] = $maintenanceRequestChecksum; $response = $bayarcash->createFpxDirectDebitMaintenanceIntent($data); header("Location: " . $response->url); // redirect payer to Bayarcash Fpx Direct Debit maintenance page.$response = $bayarcash->createFpxDirectDebitTerminationIntent($data); header("Location: " . $response->url); // redirect payer to Bayarcash Fpx Direct Debit termination page.- Always use checksums for payment requests when possible
- Verify all callbacks using the provided verification methods
- Store and validate transaction IDs to prevent duplicate processing
- Use HTTPS for all API communications
- Keep your API tokens and secret keys secure
Please refer to the Official Bayarcash API Documentation for detailed information about our API.
For support questions, please contact Bayarcash support or raise an issue in the repository.
Please see CHANGELOG for version update history.
This SDK is open-sourced software licensed under the MIT license.
