BeanStream

cancel() _v5

Cancel subscription
PARAMETERS:
NONE
RETURN VALUE:
array = Cancel subscription response

checkBillingAllowed() _v5

Checks if billing payment is allowed.
PARAMETERS:
NONE
RETURN VALUE:
bool = True if the billing payment is allowed, throws error if no payment processor setup or billing agreement already paid

cleanCreditCard(string $cardNumber) _v5

Format credit card number to make it valid
PARAMETERS:
$cardNumber = string, Credit card number
RETURN VALUE:
string = Formated credit card number

static createBeanStreamProfile($merchantID, $merchantPasscode, $cardNumber, $expirationMonth, $expirationYear, $email, $phone, $firstName, $lastName, $address, $city, $state, $zipcode, $country) _v5

Create a new BeanStream profile
PARAMETERS:
$merchantID = string, BeanStream Merchant ID
$merchantPasscode = string, BeanStream passcode
$cardNumber = string, Credit card number
$expirationMonth = string, Card expiration month
$expirationYear = string, Card expiration year
$email = string, buyer email address
$phone = string, buyer phone number
$firstName = string, card holder first name (on card)
$lastName = string, card holder last name (on card)
$address = string, buyer address
$city = string, buyer city
$state = string, buyer state
$zipcode = string, buyer zipcode
$country = string, buyer country
RETURN VALUE:
array = Beanstream response as an array

static deleteBeanStreamProfile($merchantID, $merchantPasscode, $profileID) _v5

Remove Beanstream profile integration
PARAMETERS:
$merchantID = string, BeanStream Merchant ID
$merchantPasscode = string, BeanStream passcode
$profileID = string, BeanStream Profile ID
RETURN VALUE:
array = Beanstream response as an array

static getBeanStreamProfile($merchantID, $merchantPasscode, $profileID) _v5

Gets BeanStream profile integration
PARAMETERS:
$merchantID = string, BeanStream Merchant ID
$merchantPasscode = string, BeanStream passcode
$profileID = string, BeanStream Profile ID
RETURN VALUE:
array = BeanStream response as an array

getBilling() _v5

Gets billing object for the loaded abstract billing object
PARAMETERS:
NONE
RETURN VALUE:
object = \WMT\SQL\Billing\Billing

getBlankCreditCardArray() _v5

Gets a blank credit card array including name on card, expiration date, card type and card number
PARAMETERS:
NONE
RETURN VALUE:
array = a blank credit card array including name on card, expiration date, card type and card number

getButtonIMG() _v5

Gets button image URL
PARAMETERS:
NONE
RETURN VALUE:
string = button image URL

getCancelURL() _v5

Gets cancel payment URL
PARAMETERS:
NONE
RETURN VALUE:
string = cancel payment URL

getCreditCardArray() _v5

Gets credit card details as an array
PARAMETERS:
NONE
RETURN VALUE:
array = credit card details as an array

getCreditCardToken() _v5

Gets credit card token key as an array
PARAMETERS:
NONE
RETURN VALUE:
array = credit card token key

getCreditCardType(string $str) _v5

Gets credit card type. like (Visa, Mastercard... etc)
PARAMETERS:
$str = string, Credit card number
RETURN VALUE:
string = Credit card type

getIsAwaiting() _v5

Gets manual payment status (approved | is awaiting approval)
PARAMETERS:
NONE
RETURN VALUE:
bool = True if the payment is awaiting approval, false otherwise

getPaymentProcessorSetup() _v5

Gets payment processor setup object for the loaded object
PARAMETERS:
NONE
RETURN VALUE:
object = \WMT\SQL\Billing\PaymentProcessorSetup

getRecurMonths() _v5

Gets number of recur months for the loaded billing object
PARAMETERS:
NONE
RETURN VALUE:
int = number of recur months for the loaded billing object

getRedirectURL() _v5

Gets payment redirect URL
PARAMETERS:
NONE
RETURN VALUE:
string = payment redirect URL

getSubscriptionID() _v5

Gets payment subscription ID
PARAMETERS:
NONE
RETURN VALUE:
string = payment subscription ID

getUpdateCreditCardButton() _v5

Gets update credit card button as HTML
PARAMETERS:
NONE
RETURN VALUE:
string = update credit card button as HTML

getVisitorID() _v5

Gets payment visitor ID
PARAMETERS:
NONE
RETURN VALUE:
int = Visitor ID

static payBeanStream($merchantID, $apiUsername, $apiPassword, $profileID, $amount, $orderNumber) _v5

Process a payment using BeanStream payment processor
PARAMETERS:
$merchantID = string, BeanStream Merchant ID
$apiUsername = string, BeanStream API username
$apiPassword = string, BeanStream API password
$profileID = string, BeanStream Profile ID
$amount = float, Payment money amount
$orderNumber = string, BeanStream Order Number
RETURN VALUE:
array = BeanStream payment response as an array

static refundBeanStream($merchantID, $apiUsername, $apiPassword, $amount, $orderNumber) _v5

Refund a payment paid using BeanStream
PARAMETERS:
$merchantID = string, BeanStream Merchant ID
$apiUsername = string, BeanStream API username
$apiPassword = string, BeanStream API password
$amount = float, BeanStream payment amount
$orderNumber = string, BeanStream order number
RETURN VALUE:
array = Refund payment response as an array

setBilling() _v5

Set billing object for the abstract billing
PARAMETERS:
NONE
RETURN VALUE:
void

setBillingPayment() _v5

Set billing payment object for the abstract billing
PARAMETERS:
NONE
RETURN VALUE:
void

setPaymentProcessorSetup() _v5

Sets payment processor setup
PARAMETERS:
NONE
RETURN VALUE:
void

status() _v5

Gets payment status
PARAMETERS:
NONE
RETURN VALUE:
string = payment status

__construct(\WMT\Container $container, \WMT\SQL\Billing\BillingAgreementPayment $billingAgreementPayment) _v5

Initialize abstract billing utility object
PARAMETERS:
$container = object
$billingAgreementPayment = object
RETURN VALUE:
void