Download the PHP package digikraaft/velvpay-php without Composer
On this page you can find all versions of the php package digikraaft/velvpay-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download digikraaft/velvpay-php
More information about digikraaft/velvpay-php
Files in digikraaft/velvpay-php
Package velvpay-php
Short Description PHP Implementation of VelvPay API
License MIT
Homepage https://github.com/digikraaft/velvpay-php
Informations about the package velvpay-php
Introduction
This package provides an expressive and convenient way to interact with the Velvpay API.
Installation
You can install the package via composer:
Usage
All APIs documented in Velvpay's Developer Reference are currently supported by this package.
Authentication
You must first authenticate with Velvpay before any of the endpoints and available methods can be used. To do so, set your secret, public and encryption keys:
A note on Request Reference and Idempotency
VelvPay requires that each request made to their endpoint has a unique reference. This package automatically generates this unique reference for each request. If you need to access the reference that is generated, do this after each call:
If you however want to generate your own unique reference, just call the setRequestReference
method like this before calling the endpoint:
Some endpoints also require an Idempotency key. This package automatically generates this for you. You can get the key that was generated for the request by calling the getIdempotencyKey
function immediately after making the request like this:
API Responses
This package returns exact responses from the Velvpay API but as the stdClass
type such that responses can be accessed like this:
Please check the API documentation at VelvPay to know what response values are returned. Each of the available methods below have been linked to the exact documentation page on their site.
Available Methods
A list of the available methods are documented below:
Bank
accountDetails(string $bankAccountNumber, string $bankCode) : Array|Object
list() : Array|Object
Bill
categoryList(string $bankAccountNumber, string $bankCode) : Array|Object
details(string $category = null) : Array|Object
list(string $billerId, string $divisionId, string $productId) : Array|Object
pay(string $billerId, string $amount, string $productId, string $paymentItem, string $category, string $billId, string $division) : Array|Object
status(string $reference) : Array|Object
CashCraft
confirmFee() : Array|Object
details(string $transactionId) : Array|Object
initiate(string $amount, string $email, array $beneficiaries, string $description, int $validityTime = 20, bool $isNaira = false) : Array|Object
manualResolve(string $transactionId) : Array|Object
Payment
createVirtualAccount(int|float $amount, string $customerEmail, int $validityTime = 20, bool $isNaira = false) : Array|Object
details(array $parameters) : Array|Object
requestFund(int|float $amount, string $type, string $senderEmail, string $receiverEmail, string $paymentName, string $description, array $metadata = null, string $idempotencykey = null, bool $isNaira = false) : Array|Object
requestFundStatus(string $reference) : Array|Object
Payout
balance() : Array|Object
resolveStatus(string $transactionId) : Array|Object
transfer(int|float $amount, string $bankCode, string $bankName, string $accountNumber, string $accountName, string $description, int $transactionPin, string $idempotencykey = null, bool $isNaira = false) : Array|Object
VelvPay
authorizationToken() : string
getEncryptionKey() : string
getPublicKey() : string
getRequestReference() : string
getSecretKey() : string
setEncryptionKey(string $encryptionKey) : void
setKeys(string $secretKey, string $publicKey, string $encryptionKey) : void
setPublicKey(string $publicKey) : void
setRequestReference(string $requestReference) : void
setSecretKey(string $secretKey) : void
Wallet
accountDetails(string $accountId) : Array|Object
create(string $email, string $bvn, string $username, string $gender, string $dateOfBirth, bool $referralCode = false) : Array|Object
customers(array $parameters = null) : Array|Object
transactions(array $parameters = null) : Array|Object
Testing
More Good Stuff
Check here for more awesome free stuff!
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Tim Oladoyinbo
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of velvpay-php with dependencies
guzzlehttp/guzzle Version ^7.2.0
ext-json Version *
ext-openssl Version *