Index | OVAC Hubtel Payment API

A

Api — Class in namespace OVAC\HubtelPayment\Api: Api Class
ApiInterface — Class in namespace OVAC\HubtelPayment\Api: Enforce implementation rules on all classes that need to implement and access the API Methods
MassAssignable::assignOnSendMoneyInstance() — Method in class MassAssignable
MassAssignable::assignOnReceiveMoneyInstance() — Method in class MassAssignable
Transactable::amount() — Method in class Transactable: This method serves as an entry to a transaction class instane. It creates a new transaction class by first starting with the required amount value of the transaction to be created.
$Transaction — Property in class Transaction: The mobile money transaction amount
$Config — Property in class Config: The Hubtel Merchant Account Number to bill from.
CanCleanParameters::accessPropertyByKey() — Method in class CanCleanParameters: This method calls the accessors for keys passed in and returns back the value it receives from the class instance

B

$Api — Property in class Api: The Default Hubtel Base url for merchant payment
BadRequestException — Class in namespace OVAC\HubtelPayment\Exception: Class BadRequestException throws OVAC\HubtelPayment\Exception\BadRequestException

C

$Api — Property in class Api: The Config repository instance.
Api::createHandler() — Method in class Api: Create the client handler.
ReceiveMoney::customerName() — Method in class ReceiveMoney: Sets the customer name as required by the Hubtel Receive Api (requred by the Hubtel ReceiveMoney Api)
ReceiveMoney::customerEmail() — Method in class ReceiveMoney: Sets the customer email (Optional)
SendMoney::customerName() — Method in class SendMoney: This api method sets the receiver's name (requred by the Hubtel SendMoney Api)
SendMoney::customerEmail() — Method in class SendMoney: This api method sets the receiver's email (requred by the Hubtel SendMoney Api)
Transactable::channel() — Method in class Transactable: Sets the channel (Mobile Network) (requred by the Hubtel ReceiveMoney|SendMoney Api)
$Transaction — Property in class Transaction: The name of the customer.
$Transaction — Property in class Transaction: The customer email address
$Transaction — Property in class Transaction: The customer mobile money number.
$Transaction — Property in class Transaction: The mobile money provider channel
$Transaction — Property in class Transaction: The reference number that is provided by you to reference a transaction from your end.
Transaction::callback() — Method in class Transaction: This method sests a single callback for both the success and Error
Transaction::callbackOnFail() — Method in class Transaction: Sets the URL to call when the payment fails or is unsuccessfull
Transaction::callbackOnSuccess() — Method in class Transaction: Set the URL to call when the payment is been confirmed successful (requred by the Hubtel ReceiveMoney Api)
Config — Class in namespace OVAC\HubtelPayment: Config Class
$Config — Property in class Config: The Hubtel Developer Applicaton Client Id.
$Config — Property in class Config: The Hubtel Developer Applicaton Client Secret.
ConfigInterface — Class in namespace OVAC\HubtelPayment
$Pay — Property in class Pay: The Config repository instance.
CanCleanParameters — Class in namespace OVAC\HubtelPayment\Utility: Trait CanCleanParameters
$HubtelHandler — Property in class HubtelHandler: Holds the configuration object
HubtelHandler::createHandler() — Method in class HubtelHandler: Create the client handler.

D

ReceiveMoney::description() — Method in class ReceiveMoney: Set the description of the transaction (requred by the Hubtel ReceiveMoney Api)
Refund::description() — Method in class Refund: Sets the description of the transaction to be carried out
SendMoney::description() — Method in class SendMoney: This method sets the description of the transaction. Best used to describe why the money is being sent for future reference and book keeping.
$Transaction — Property in class Transaction: The short description of the transaction.
HubtelHandler::decider() — Method in class HubtelHandler: Function $decider callable
HubtelHandler::delay() — Method in class HubtelHandler: Function $delay

E

Api::execute() — Method in class Api: Executes the HTTP request.
ApiInterface::execute() — Method in class ApiInterface: Executes the HTTP request.
$Handler — Property in class Handler: List of mapped exceptions and their corresponding status codes.
$HubtelException — Property in class HubtelException: The error code returned by Hubtel.
$HubtelException — Property in class HubtelException: The error type returned by Hubtel.

F

$ReceiveMoney — Property in class ReceiveMoney: This allows the fees of the transaction to be charged on the customer. If set to true the AmountCharged = Amount + Charges.
ReceiveMoney::from() — Method in class ReceiveMoney: The phone number of the customer you want to bill (Send Pompt) (requred by the Hubtel ReceiveMoney Api)
ReceiveMoney::feesOnCustomer() — Method in class ReceiveMoney: Sets if the hubtel and mobile money fees is charged on the customer or client
$Refund — Property in class Refund: Specify if you want to make a full or a partial refund.
Refund::full() — Method in class Refund: Specifies if the transaction is to be a full or a partial refund

G

Api::getBaseUrl() — Method in class Api: Get the Hubtel payment Base Url from the Api Instance
Api::getClient() — Method in class Api: Returns an Http client instance.
Api::getConfig() — Method in class Api
ApiInterface::getBaseUrl() — Method in class ApiInterface: Returns the API base url.
ReceiveMoney::getToken() — Method in class ReceiveMoney
ReceiveMoney::getFeesOnCustomer() — Method in class ReceiveMoney
Refund::getTransactionId() — Method in class Refund
Refund::getReason() — Method in class Refund
Refund::getFull() — Method in class Refund
Transaction::getCustomerName() — Method in class Transaction: returnes the name of the give customer
Transaction::getCustomerEmail() — Method in class Transaction: get the customer's email address.
Transaction::getCustomerMsisdn() — Method in class Transaction: gets the msisdn (Customer's phone number)
Transaction::getChannel() — Method in class Transaction: returns the transaction channel (Mobile Network)
Transaction::getAmount() — Method in class Transaction: Gets the money value for the transaction.
Transaction::getPrimaryCallbackURL() — Method in class Transaction: Returns the primary callback URL that has been set on the instance.
Transaction::getSecondaryCallbackURL() — Method in class Transaction: Returns the callback url on the transaction
Transaction::getClientReference() — Method in class Transaction: get the transaction reference.
Transaction::getDescription() — Method in class Transaction: gets the description of the transaction.
Config::getAccountNumber() — Method in class Config: Get the Merchant Client Account Number from the configuration
Config::getClientId() — Method in class Config: Returns the Hubtel API Merchant Client ID.
Config::getClientSecret() — Method in class Config: Returns the Hubtel API Merchant Client Secret.
Config::getPackageVersion() — Method in class Config: Returns the current package version.
ConfigInterface::getAccountNumber() — Method in class ConfigInterface: Get the Merchant Client Account Number from the configuration
ConfigInterface::getClientId() — Method in class ConfigInterface: Returns the Hubtel API Merchant Client ID.
ConfigInterface::getClientSecret() — Method in class ConfigInterface: Returns the Hubtel API Merchant Client Secret.
ConfigInterface::getPackageVersion() — Method in class ConfigInterface: Returns the current package version.
Handler::getMissingParameters() — Method in class Handler
HubtelException::getErrorCode() — Method in class HubtelException: Returns the error type returned by Hubtel.
HubtelException::getErrorType() — Method in class HubtelException: Returns the error type returned by Hubtel.
HubtelException::getMissingParameter() — Method in class HubtelException: Returns missing parameter returned by Hubtel with the error.
HubtelException::getRawOutput() — Method in class HubtelException: Returns raw output returned by Hubtel in case of exception.
Pay::getConfig() — Method in class Pay: Returns the Config repository instance.
Pay::getAccountNumber() — Method in class Pay: Get the Merchant Client Account Number from the configuration
Pay::getClientId() — Method in class Pay: Returns the Hubtel API Merchant Client ID.
Pay::getClientSecret() — Method in class Pay: Returns the Hubtel API Merchant Client Secret.
Pay::getPackageVersion() — Method in class Pay: Returns the current package version.
Pay::getApiInstance() — Method in class Pay: Returns the Api class instance for the given method.

H

Handler — Class in namespace OVAC\HubtelPayment\Exception: Class Handler
Handler::handleException() — Method in class Handler: Guesses the FQN of the exception to be thrown.
HubtelException — Class in namespace OVAC\HubtelPayment\Exception: Class HubtelException throws OVAC\HubtelPayment\Exception\HubtelException
HubtelHandler — Class in namespace OVAC\HubtelPayment\Utility: Hubtel Handler Class

I

Api::injectConfig() — Method in class Api: Injects the configuration tot he Api Instance
ReceiveMoney::isFeesOnCustomer() — Method in class ReceiveMoney
Refund::isFull() — Method in class Refund
InvalidRequestException — Class in namespace OVAC\HubtelPayment\Exception: Class InvalidRequestException throws OVAC\HubtelPayment\Exception\InvalidRequestException

M

MassAssignable — Class in namespace OVAC\HubtelPayment\Api\Transaction: Trait MassAssignable
MassAssignable::make() — Method in class MassAssignable: This method exposes the mass assignment method.
MassAssignable::massAssign() — Method in class MassAssignable: This method is used to mass assign the properties required by the Hubtel ReceiveMoney and SendMoney Api
$HubtelException — Property in class HubtelException: The missing parameter returned by Hubtel.
MissingParameterException — Class in namespace OVAC\HubtelPayment\Exception: Class MissingParameterException throws OVAC\HubtelPayment\Exception\MissingParameterException
Pay::make() — Method in class Pay: Create a new OVAC\HubtelPayment instance.

N

NotFoundException — Class in namespace OVAC\HubtelPayment\Exception: Class NotFoundException throws OVAC\HubtelPayment\Exception\NotFoundException

P

$ReceiveMoney — Property in class ReceiveMoney: {@inheritdoc}
$ReceiveMoney — Property in class ReceiveMoney: {@inheritdoc}
$Refund — Property in class Refund: {@inheritdoc}
Refund::partial() — Method in class Refund: Specifies if the transaction is to be a full or a partial refund
$SendMoney — Property in class SendMoney: {@inheritdoc}
$SendMoney — Property in class SendMoney: {@inheritdoc}
$Transaction — Property in class Transaction: A callback URL to receive the transaction status from Hubtel to your API request.
$Transaction — Property in class Transaction: Defines an array of required properties
$Transaction — Property in class Transaction: Defines an array of the names of optional properties/parameters names
Pay — Class in namespace OVAC\HubtelPayment: Pay Class
CanCleanParameters::propertiesPassRequired() — Method in class CanCleanParameters: This method checks that all properties marked as required have been assigned a value.
CanCleanParameters::propertiesToArray() — Method in class CanCleanParameters: This method picks up all the defined properties the $parameterRequired|$parameterOptional property array list from the class object and returns an array containing each list item name as a key and the matching property value from the class
HubtelHandler::pushHeaderMiddleware() — Method in class HubtelHandler: Push the Header Middleware to the Handler Stack
HubtelHandler::pushBasicAuthMiddleware() — Method in class HubtelHandler: Push the Header Middleware to the Handler Stack containing the bacic authentication in base64
HubtelHandler::pushRetryMiddleware() — Method in class HubtelHandler: Pushes a Retry Middleware to the Guzzle Client Handler Stack.

R

$Api — Property in class Api: This is the response received from the hubtel server if no exception was thrown.
ReceiveMoney — Class in namespace OVAC\HubtelPayment\Api\Transaction: Class ReceiveMoney
ReceiveMoney::reference() — Method in class ReceiveMoney: Sets a reference to reference a transaction from your end.
ReceiveMoney::run() — Method in class ReceiveMoney: The method runs the transaction
Refund — Class in namespace OVAC\HubtelPayment\Api\Transaction: Class Refund
$Refund — Property in class Refund: A short description of your reason for refunding the mobile money wallet
Refund::reason() — Method in class Refund: Sets the reason for the refund
Refund::reference() — Method in class Refund: Sets a reference for the transaction to be processed id from your end.
Refund::run() — Method in class Refund: The method runs the transaction
SendMoney::recepientName() — Method in class SendMoney: This api method sets the receiver's name (requred by the Hubtel SendMoney Api)
SendMoney::reference() — Method in class SendMoney: Sets a reference to reference a transaction from your end.
SendMoney::run() — Method in class SendMoney: The method runs the transaction
$HubtelException — Property in class HubtelException: The raw output returned by Hubtel in case of exception.

S

Api::setBaseUrl() — Method in class Api: Change the Default baseUrl defined by hubtel
Api::setConfig() — Method in class Api
MassAssignable::setCustomer() — Method in class MassAssignable: This function sets the customer data (name, email and msisdn|number|phone)
MassAssignable::setAmount() — Method in class MassAssignable: sets the money value (Amount) to be sent or received
MassAssignable::setDescription() — Method in class MassAssignable: sets a description for the transaction.
MassAssignable::setClientReference() — Method in class MassAssignable: Set's a reference on the transaction for easy identification and transaction tracking.
MassAssignable::setChannel() — Method in class MassAssignable: sets the transaction channel (Mobile Network)
MassAssignable::setCallback() — Method in class MassAssignable: This method sets the callbacks for the Hubtel Payments
ReceiveMoney::setToken() — Method in class ReceiveMoney
ReceiveMoney::setFeesOnCustomer() — Method in class ReceiveMoney
Refund::setTransactionId() — Method in class Refund
Refund::setReason() — Method in class Refund
Refund::setFull() — Method in class Refund
SendMoney — Class in namespace OVAC\HubtelPayment\Api\Transaction: Class SendMoney
$Transaction — Property in class Transaction: The second URL for callback response in the event of failure of primary callback URL.
Transaction::setCustomerName() — Method in class Transaction: Sets the name of the customer.
Transaction::setCustomerEmail() — Method in class Transaction: sets the customer's email address.
Transaction::setCustomerMsisdn() — Method in class Transaction: Sets the customer's phone number to be billed or funded.
Transaction::setChannel() — Method in class Transaction: sets the transaction channel (Mobile Network)
Transaction::setAmount() — Method in class Transaction: sets the money value (Amount) to be sent or received
Transaction::setPrimaryCallbackURL() — Method in class Transaction: set the callback url to callback if the transaction was successful.
Transaction::setSecondaryCallbackURL() — Method in class Transaction: Sets the URL to call back if he transaction is unsuccesful.
Transaction::setClientReference() — Method in class Transaction: Set's a reference on the transaction for easy identification and transaction tracking.
Transaction::setDescription() — Method in class Transaction: sets a description for the transaction.
Transaction::setCustomer() — Method in class Transaction: This function sets the customer data (name, email and msisdn|number|phone)
Transaction::setCallback() — Method in class Transaction: This method sets the callbacks for the Hubtel Payments
Config::setAccountNumber() — Method in class Config: Sets the Hubter API Merchant Account Number.
Config::setClientId() — Method in class Config: Sets the Hubtel API Merchant ID.
Config::setClientSecret() — Method in class Config: Sets the Hubtel API Merchant Client Secret.
Config::setPackageVersion() — Method in class Config: Set the current package version
ConfigInterface::setAccountNumber() — Method in class ConfigInterface: Sets the Hubter API Merchant Account Number.
ConfigInterface::setClientId() — Method in class ConfigInterface: Sets the Hubtel API Merchant ID.
ConfigInterface::setClientSecret() — Method in class ConfigInterface: Sets the Hubtel API Merchant Client Secret.
ConfigInterface::setPackageVersion() — Method in class ConfigInterface: Set the current package version
HubtelException::setErrorCode() — Method in class HubtelException: Sets the error type returned by Hubtel.
HubtelException::setErrorType() — Method in class HubtelException: Sets the error type returned by Hubtel.
HubtelException::setMissingParameter() — Method in class HubtelException: Sets the missing parameter returned by Hubtel with the error.
HubtelException::setRawOutput() — Method in class HubtelException: Sets the raw output parameter returned by Hubtel in case of exception.
ServerErrorException — Class in namespace OVAC\HubtelPayment\Exception: Class ServerErrorException throws OVAC\HubtelPayment\Exception\ServerErrorException
Pay::setConfig() — Method in class Pay: Sets the Config repository instance.
Pay::setAccountNumber() — Method in class Pay: Sets the Hubter API Merchant Account Number.
Pay::setClientId() — Method in class Pay: Sets the Hubtel API Merchant ID.
Pay::setClientSecret() — Method in class Pay: Sets the Hubtel API Merchant Client Secret.
Pay::setPackageVersion() — Method in class Pay: Set the current package version
$HubtelHandler — Property in class HubtelHandler: Property for holding the handler stack on the instance

T

$ReceiveMoney — Property in class ReceiveMoney: The 6 digit unique token required to debit a Vodafone Cash customer. This token has to be generated and provided by the Vodafone customer. The customer dials *110# and selects menu item 6 to create the voucher. It expires after 5 minutes if unused
ReceiveMoney::token() — Method in class ReceiveMoney: Sets the 6 digit unique token required to debit a Vodafone Cash
$Refund — Property in class Refund: The unique ID of the mobile money transaction you want to refund
Refund::transactionId() — Method in class Refund: Sets the transaction ID
SendMoney::to() — Method in class SendMoney: This api method sets the rceiver's phone number.
Transactable — Class in namespace OVAC\HubtelPayment\Api\Transaction: This trait encapsulates the accessor required to create a new transaction instance
Transaction — Class in namespace OVAC\HubtelPayment\Api\Transaction: Transaction Class

U

UnauthorizedException — Class in namespace OVAC\HubtelPayment\Exception: Class UnauthorizedException throws OVAC\HubtelPayment\Exception\UnauthorizedException

V

$Config — Property in class Config: This OVAC/Hubtel-Payment Package Version.

_

Api::__construct() — Method in class Api: Constructor.
Api::_get() — Method in class Api: Send a GET request.
Api::_head() — Method in class Api: Send a HEAD request.
Api::_delete() — Method in class Api: Send a DELETE request.
Api::_put() — Method in class Api: Send a PUT request.
Api::_patch() — Method in class Api: Send a PATCH request.
Api::_post() — Method in class Api: Send a POST request.
Api::_options() — Method in class Api: Send an OPTIONS request.
ApiInterface::_get() — Method in class ApiInterface: Send a GET request.
ApiInterface::_head() — Method in class ApiInterface: Send a HEAD request.
ApiInterface::_delete() — Method in class ApiInterface: Send a DELETE request.
ApiInterface::_put() — Method in class ApiInterface: Send a PUT request.
ApiInterface::_patch() — Method in class ApiInterface: Send a PATCH request.
ApiInterface::_post() — Method in class ApiInterface: Send a POST request.
ApiInterface::_options() — Method in class ApiInterface: Send an OPTIONS request.
ReceiveMoney::__construct() — Method in class ReceiveMoney: Construct for creating a new instance of the ReceiveMoney Api class
Refund::__construct() — Method in class Refund: Construct for creating a new instance of the Refund Api class
SendMoney::__construct() — Method in class SendMoney: Construct for creating a new instance of the SendMoney Api class
Transactable::__callStatic() — Method in class Transactable: Dynamically handle missing Static Api Call to Amount.
Transactable::__call() — Method in class Transactable: Dynamically handle missing public method call on Amount.
Config::__construct() — Method in class Config: Constructor
Handler::__construct() — Method in class Handler: Constructor.
Pay::__construct() — Method in class Pay: Constructor.
Pay::__callStatic() — Method in class Pay: Dynamically handle missing Static Api Classes and Methods.
Pay::__call() — Method in class Pay: Dynamically handle missing Api Classes and Methods.
HubtelHandler::__construct() — Method in class HubtelHandler: Constructor for the HubtelHandler class