PHPackages crayfi/cray-laravel - 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. [API Development](/categories/api) 4. / 5. crayfi/cray-laravel ActiveLibrary[API Development](/categories/api) crayfi/cray-laravel =================== First-class Laravel Composer package for integrating Cray Finance APIs 031PHP Since Feb 22Pushed 2mo agoCompare [ Source](https://github.com/noibilism/crayfi)[ Packagist](https://packagist.org/packages/crayfi/cray-laravel)[ RSS](/packages/crayfi-cray-laravel/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) Cray Finance Laravel SDK ======================== [](#cray-finance-laravel-sdk) A first-class Laravel Composer package for integrating Cray Finance APIs. This package abstracts authentication, HTTP calls, validation, retries, and error handling, providing a clean and expressive API for developers. Requirements ------------ [](#requirements) - PHP 8.1+ - Laravel 9.0+ Installation ------------ [](#installation) Install the package via Composer: ``` composer require crayfi/cray-laravel ``` Configuration ------------- [](#configuration) Publish the configuration file: ``` php artisan vendor:publish --tag=cray-config ``` This will create a `config/cray.php` file. Configure your API credentials in your `.env` file: ``` CRAY_API_KEY=your_api_key_here CRAY_ENV=sandbox CRAY_TIMEOUT=30 CRAY_RETRIES=2 ``` ### Environment Switching [](#environment-switching) Set `CRAY_ENV` to `live` for production or `sandbox` for development/staging. - `sandbox`: Uses `https://dev-gateman.v3.connectramp.com` - `live`: Uses `https://pay.connectramp.com` You can also explicitly set `CRAY_BASE_URL` if needed. Usage ----- [](#usage) The package provides a `Cray` facade for easy access to all modules. ### 1. Cards [](#1-cards) Handle card transactions including initiation, charging, and querying. ``` use Cray\Laravel\Facades\Cray; // Initiate a card transaction // 'reference': A unique reference for this transaction (generated by you) // 'amount': The amount to charge (in the smallest currency unit or standard unit as per API docs) // 'currency': The currency code (e.g., USD, NGN) // 'card_data': Sensitive card details (PAN, CVV, Expiry) // 'customer_information': Details about the customer initiating the transaction $response = Cray::cards()->initiate([ 'reference' => '4aeb118e-5009-450a-94fc-d74f6cd88646', 'amount' => '100', 'currency' => 'USD', 'card_data' => [ 'pan' => '5399832641760090', 'cvv' => '146', 'expiryMonth' => '05', 'expiryYear' => '50', ], 'customer_information' => [ 'email' => 'test@testmail.com', 'firstName' => 'John', 'lastName' => 'Doe', ], // ... other required fields like 'callback_url' or 'return_url' might be needed depending on API ]); // Process payment (Charge) // 'transaction_id': The ID received from the initiate response or webhook $charge = Cray::cards()->charge([ 'transaction_id' => 'SRK4NC92PFHLGZW78A3E' ]); // Query transaction status // 'customer_reference_id': The unique reference you provided during initiation $status = Cray::cards()->query('customer_reference_id'); ``` ### 2. Mobile Money (MoMo) [](#2-mobile-money-momo) Process mobile money payments. ``` // Initiate MoMo payment // 'payment_provider': The mobile money provider (e.g., MTN, Airtel) // 'phone_no': The customer's phone number registered with the provider $momo = Cray::momo()->initiate([ 'customer_reference' => 'e4d7c3b8-5f29-4b46-81a6-8d98c1e75812', 'amount' => '3950', 'currency' => 'XOF', 'phone_no' => '2290161248277', 'payment_provider' => 'MTN', 'country' => 'benin', 'firstname' => 'Cray', 'lastname' => 'Momo', ]); // Requery MoMo transaction // Check the status of a transaction using your reference $status = Cray::momo()->requery('customer_reference_id'); ``` ### 3. Wallets [](#3-wallets) Fetch wallet balances. ``` // Get all wallet balances // Returns a list of balances for all currencies in your merchant wallet $balances = Cray::wallets()->balances(); // Get subaccounts // Returns a list of subaccounts created under your merchant account $subaccounts = Cray::wallets()->subaccounts(); ``` ### 4. FX & Conversions [](#4-fx--conversions) Handle exchange rates and currency conversions. ``` // Get specific exchange rate // Check the current rate between two currencies $rate = Cray::fx()->rates([ 'source_currency' => 'USD', 'destination_currency' => 'NGN' ]); // Get rates by destination // Get all available rates for a specific destination currency $rates = Cray::fx()->ratesByDestination([ 'destination_currency' => 'NGN' ]); // Generate a quote // Lock in a rate for a conversion (valid for a limited time) $quote = Cray::fx()->quote([ 'source_currency' => 'NGN', 'destination_currency' => 'USD', 'source_amount' => 1500 ]); // Execute conversion // Finalize the conversion using the quote ID received from the quote step $conversion = Cray::fx()->convert([ 'quote_id' => 'quote:98a5d6d3-7cbc-4c7d-b4f6-d3bbbbe340b6' ]); // Query conversions history // Get a list of past conversions $history = Cray::fx()->conversions(); ``` ### 5. Payouts [](#5-payouts) Manage disbursements and transfers. ``` // Get payment methods for a country // Returns available payout methods (e.g., bank_transfer, mobile_money) for a specific country $methods = Cray::payouts()->paymentMethods('NG'); // Get banks (optionally filter by country code) // Returns a list of supported banks and their codes $banks = Cray::payouts()->banks('GH'); // Validate account name // Verify that an account number belongs to a specific user before disbursing $account = Cray::payouts()->validateAccount([ 'account_number' => '0112345678', 'bank_code' => '058', 'country_code' => 'GH' // if applicable ]); // Disburse funds // Send money to a beneficiary $transfer = Cray::payouts()->disburse([ 'customer_reference' => 'ref-123', 'account_number' => '898789', 'bank_code' => '78978', 'amount' => '10', 'currency' => 'NGN', 'narration' => 'Payment for services', 'sender_info' => ['name' => 'My Business'], 'recipient_name' => 'John Doe' ]); // Requery payout // Check the status of a payout transaction $status = Cray::payouts()->requery('transaction_id'); ``` ### 6. Refunds [](#6-refunds) Initiate and track refunds. ``` // Initiate a refund (full or partial) // 'pan': Masked PAN or token of the card to be refunded // 'subaccount_id': The subaccount that received the original payment (if applicable) $refund = Cray::refunds()->initiate([ 'pan' => '4696660001638370', 'subaccount_id' => '9999999999', 'amount' => '1.2' // Optional, for partial refund ]); // Check refund status $status = Cray::refunds()->query('refund_reference_id'); ``` ### 7. Virtual Accounts [](#7-virtual-accounts) Create and manage NGN virtual collection accounts (Monnify, Wema, etc.). ``` // Create a virtual account $va = Cray::virtualAccounts()->create([ 'bvn' => '22192474887', 'type' => 'Corporate', // 'Corporate' or 'Individual' 'nin' => '11111122221', 'virtual_account_type' => 'Permanent', // 'Permanent' or 'Onetime' 'account_name' => 'BOlaOla', 'rc_number' => '99988828822', // Required for Corporate type 'currency' => 'NGN', 'reference' => 'cbf0d060-1544-4a53-a00b-7cb75a3eb59d', 'customer_email' => 'hello@gmail.com', 'provider' => 'monnify', ]); // Initiate a virtual account request (pre-create step) $initiated = Cray::virtualAccounts()->initiate([ 'provider' => 'wema', 'bvn' => '22192474887', ]); // List all virtual accounts for the merchant $list = Cray::virtualAccounts()->list(); // Get available virtual account providers $providers = Cray::virtualAccounts()->providers(); // Submit OTP to complete the two-step Wema flow $result = Cray::virtualAccounts()->submitOtp([ 'merchant_id' => '123', 'otp' => '768238', 'customer_email' => 'hello@gmail.com', ]); ``` Error Handling -------------- [](#error-handling) The package throws specific exceptions for different error scenarios. You should catch these exceptions to handle errors gracefully. ``` use Cray\Laravel\Exceptions\CrayApiException; use Cray\Laravel\Exceptions\CrayAuthenticationException; use Cray\Laravel\Exceptions\CrayValidationException; use Cray\Laravel\Exceptions\CrayTimeoutException; try { $response = Cray::cards()->initiate($payload); } catch (CrayAuthenticationException $e) { // Handle invalid API key or unauthorized access return response()->json(['error' => 'Unauthorized'], 401); } catch (CrayValidationException $e) { // Handle validation errors (400/422) // $e->getErrors() contains the validation details return response()->json(['errors' => $e->getErrors()], 422); } catch (CrayTimeoutException $e) { // Handle timeouts return response()->json(['error' => 'Request timed out'], 504); } catch (CrayApiException $e) { // Handle other API errors (5xx, etc.) return response()->json(['error' => $e->getMessage()], 500); } ``` License ------- [](#license) The MIT License (MIT). ### Health Score 20 — LowBetter than 14% of packages Maintenance56 Moderate activity, may be stable Popularity4 Limited adoption so far Community9 Small or concentrated contributor base Maturity12 Early-stage or recently created project Bus Factor1 Top contributor holds 55.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/ed7ec6b7a648d5c6e429304a17b75a54458e4570b05a8d92a4096d05d8eaafae?d=identicon)[noibilism](/maintainers/noibilism) --- Top Contributors [![noibilism](https://avatars.githubusercontent.com/u/6907522?v=4)](https://github.com/noibilism "noibilism (5 commits)")[![Jamilamasa](https://avatars.githubusercontent.com/u/95282243?v=4)](https://github.com/Jamilamasa "Jamilamasa (4 commits)") ### Embed Badge ![Health badge](/badges/crayfi-cray-laravel/health.svg) ``` [![Health](https://phpackages.com/badges/crayfi-cray-laravel/health.svg)](https://phpackages.com/packages/crayfi-cray-laravel) ``` ### Alternatives [stripe/stripe-php Stripe PHP Library 4.0k143.3M478](/packages/stripe-stripe-php)[twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M271](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax Google API Core for PHP 263103.1M454](/packages/google-gax) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)