PHPackages viciremittance/vici-php-sdk - 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. viciremittance/vici-php-sdk ActiveLibrary[API Development](/categories/api) viciremittance/vici-php-sdk =========================== An easy to use Vici PHP API using Guzzle library. v1.1.0(4y ago)07MITPHPPHP ^5.6|^7.4 Since Oct 26Pushed 4y ago1 watchersCompare [ Source](https://github.com/viciremittance/vici-php-sdk)[ Packagist](https://packagist.org/packages/viciremittance/vici-php-sdk)[ RSS](/packages/viciremittance-vici-php-sdk/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (2)Dependencies (2)Versions (3)Used By (0) vici-php-sdk ============ [](#vici-php-sdk) [![Latest Stable Version](https://camo.githubusercontent.com/16fa43f71ee4af2c9cd7a3d70469ebada1972168c3555f748c90105b767a1f5a/68747470733a2f2f706f7365722e707567782e6f72672f7669636972656d697474616e63652f766963692d7068702d73646b2f762f737461626c65)](https://packagist.org/packages/viciremittance/vici-php-sdk)[![Total Downloads](https://camo.githubusercontent.com/f1b6c03445f51add4a4fb04b2d9381bd5bdaf6eb7bcb8eef685581bffb84775c/68747470733a2f2f706f7365722e707567782e6f72672f7669636972656d697474616e63652f766963692d7068702d73646b2f646f776e6c6f616473)](https://packagist.org/packages/viciremittance/vici-php-sdk)[![License](https://camo.githubusercontent.com/82ca6ed73ba63e0b5d2cb6c7a64f8735c818f11b05e19f4f10f954f338d2f4ff/68747470733a2f2f706f7365722e707567782e6f72672f7669636972656d697474616e63652f766963692d7068702d73646b2f6c6963656e7365)](https://packagist.org/packages/viciremittance/vici-php-sdk)[![composer.lock](https://camo.githubusercontent.com/22da8a813461955eb0d4bc673c3d9ed7bc1720b5ecbb20bb08dce640532aac37/68747470733a2f2f706f7365722e707567782e6f72672f7669636972656d697474616e63652f766963692d7068702d73646b2f636f6d706f7365726c6f636b)](https://packagist.org/packages/viciremittance/vici-php-sdk) PHP library for calling Vici Remittance API using GuzzleHttp. Dependencies ============ [](#dependencies) - [Guzzle](http://docs.guzzlephp.org/en/stable/quickstart.html) Development ----------- [](#development) ### Quick Start Guide [](#quick-start-guide) 1. Install the package with Composer: `composer require viciremittance/vici-php-sdk` 2. Use the service you need in your application class - I.e. you are using the Disbursement service (*assuming you're using PSR-4*): ``` use ViciApi\Services\Disbursement; ``` 3. Create a new instance of the class (`Disbursement`): ``` $disbursement = new Disbursement(); ``` 4. Set Api Base Url: ``` $disbursement->setBaseUrl($apiBaseUrl); ``` 5. Set Api Credentials: ``` $disbursement->setCredentials($clientId, $clientSecret, $signingKey); ``` 6. Refresh/set `accessToken`: ``` $accessToken = $disbursement->refreshAccessToken()['access_token']; $disbursement->setAccessToken($accessToken); ``` 7. Use one of the class method to query the API - this example will request the bank list: ``` $banks = $disbursement->bankList(); ``` Tips: all of the API response has been formatted into associative array. ``` // extracting bank id $bankId = $banks['banks'][0]['bank_id']; ``` Usage ----- [](#usage) ### ViciApi\\ViciApi [](#viciapiviciapi) `ViciApi` class provides the functions that is needed to configure your API calls and signature generation. ``` // initialize ViciApi class $vici = new ViciApi(); // set API base url $vici->setBaseUrl($apiBaseUrl); // set API credentials $vici->setCredentials($clientId, $clientSecret, $signingKey); // request API access token, this also calls setAccessToken // you should store the access token in your system and refresh when it expires $accessToken = $vici->refreshAccessToken()['access_token']; // set access token that will be used to create API calls $vici->setAccessToken($accessToken); // request Disbursements Bank List API using createRequest $vici->createRequest('GET', '/dg/v1/banks'); // comparing and proccessing signature from your callbacks $isValid = $vici->isValidSignature($signatureToCompare, $method, $path, $timestamp, $body); if ($isValid) { // ... code when signature is valid } else { // ... code when signature is not valid } ``` ### ViciApi\\Services\\Disbursement [](#viciapiservicesdisbursement) `Disbursement` class extends `ViciApi` class and simplify clients request for calling Disbursement API services. You'll be able to use some of `ViciApi` method such as `requestToken` to ease your development. ``` $disbursement = new Disbursement(); $disbursement->setBaseUrl($apiBaseUrl); $disbursement->setCredentials($clientId, $clientSecret, $signingKey); // request /dg/v1/bank-account-inquiry API $disbursement->bankAccountInquiry($accountNo, $bankId, $customerName, $withValidation); // request /dg/v1/banks API $disbursement->bankList(); // request ​/dg​/v1​/disbursements API $disbursement->executeDisbursement($accountNo, $amount, $bankId, $customerName, $referenceId, $description); // request /dg/v1/disbursements/reference-id/{reference_id} API $disbursement->checkDisbursementByReferenceId($referenceId); // request /dg/v1/disbursements/{disbursement_id} API $disbursement->checkDisbursementByDisbursementId($disbursementId); // request /cash/me/balance API $disbursement->checkBalance(); ``` ### ViciApi\\Services\\PaymentGateway [](#viciapiservicespaymentgateway) Same as `Disbursement` class, `PaymentGateway` class also extends `ViciApi` class. ``` $paymentGateway = new PaymentGateway(); $paymentGateway->setCredentials($clientId, $clientSecret, $signingKey); // request /pg/v1/payment/reference-id/{reference_id} API $paymentGateway->checkPaymentByReferenceId($referenceId); // request /pg/v1/payment/{payment_id} API $paymentGateway->checkPaymentByPaymentId($paymentId); ``` ### Examples [](#examples) See `examples`. ### Health Score 23 — LowBetter than 27% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity4 Limited adoption so far Community7 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% 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. ### Release Activity Cadence Every ~7 days Total 2 Last Release 1648d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/ce81fdbbcffae852516590e835ccb0187f7955b3f630e20fecbe13b121a879e9?d=identicon)[viciremittance](/maintainers/viciremittance) --- Top Contributors [![viciremittance](https://avatars.githubusercontent.com/u/93174612?v=4)](https://github.com/viciremittance "viciremittance (2 commits)") ### Code Quality Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/viciremittance-vici-php-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/viciremittance-vici-php-sdk/health.svg)](https://phpackages.com/packages/viciremittance-vici-php-sdk) ``` ### Alternatives [tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi Kit PHP SDK for the Kit API 2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk Rest Client SDK for hydra API 1125.9k2](/packages/mapado-rest-client-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)