Class RecurringDetailRequest

Abstract with setters for recurring billing profiles

OpenDNS\MES\Request

Extended by

OpenDNS\MES\Recurring\Request

Extended by

OpenDNS\MES\Recurring\RecurringDetailRequest

Direct known subclasses

OpenDNS\MES\Recurring\Create, OpenDNS\MES\Recurring\Update

Abstract
Namespace: OpenDNS\MES\Recurring
Located at Recurring/RecurringDetailRequest.php

Methods summary

`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setRecurringAmount( integer $recurringAmount )` Sets Amount to charge each billing cycle Sets Amount to charge each billing cycle Parameters `$recurringAmount` Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining
`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setRecurringStartDate( DateTime $startDate )` Sets starting date of the recurring payments Sets starting date of the recurring payments Parameters `$startDate` Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining
`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setNumberofPayments( integer $payments )` Sets number of payments to process over the lifespan of the profile, or 0 for infinite Sets number of payments to process over the lifespan of the profile, or 0 for infinite Parameters `$payments` Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining
`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setClientReferenceNumber( integer\|string $referenceNumber )` Sets a reference number that's of significance to the client. Sets a reference number that's of significance to the client. This might be an order number or some other value that you the merchant would like to be able to refer to. It can't contain '&' or '=' for some reason Parameters `$referenceNumber` A number of some interest to you. Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining
`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setCardId( string $cardId )` Sets a card ID from a previous 'Store Card' operation to charge. Sets a card ID from a previous 'Store Card' operation to charge. This is mutually exclusive of setting the card number. Setting a Card ID will unset any previously set card number. Parameters `$cardId` 32-character card ID Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining
`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setCardNumber( string $cardNumber )` Sets the credit card number to charge. Sets the credit card number to charge. This is mutually exclusive of setting the card id. Setting a card number will unset any previously set card id. Parameters `$cardNumber` 15 or 16 digit credit card number Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining
`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setCardExpiration( integer\|string\|DateTime $month, integer\|string\|null $year )` Sets the credit card expiration date. Sets the credit card expiration date. Accepts strings because that's most commonly how they're implemented in web forms. You can also pass a \DateTime instance as a single argument Parameters `$month` Either the expiration month or a datetime representing the whole expiration date `$year` Expiration year (2 or 4 digits) or omit if using a \DateTime Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining
`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setStreetAddress( string $streetAddress )` Sets the cardholder's street address for verification Sets the cardholder's street address for verification Just the first line ('123 Fake Street', for example) Parameters `$streetAddress` Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining
`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setZipCode( integer $zipCode )` Sets the cardholder's ZIP code (or postal code) for verification Sets the cardholder's ZIP code (or postal code) for verification Can be either 5 or 9 digits long. Parameters `$zipCode` Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining
`public OpenDNS\MES\Recurring\RecurringDetailRequest`	# `setTaxAmount( integer $taxAmount )` Sets the amount of tax to charge on the transaction Sets the amount of tax to charge on the transaction Parameters `$taxAmount` Returns `OpenDNS\MES\Recurring\RecurringDetailRequest` The current class instance for chaining

Methods inherited from OpenDNS\MES\Recurring\Request

setAuthenticationInfo(), setCustomerId()

Methods inherited from OpenDNS\MES\Request

__construct(), execute(), factory(), getApiUrl(), getClient(), processResponse(), removeField(), setDefaults(), setField()

Magic methods summary

Constants summary

Constants inherited from OpenDNS\MES\Recurring\Request

FREQUENCY_ANNUALLY, FREQUENCY_MONTHLY, FREQUENCY_QUARTERLY

Constants inherited from OpenDNS\MES\Request

ENV_CERT, ENV_PROD, ENV_TEST

Properties summary

Properties inherited from OpenDNS\MES\Recurring\Request

$apiBasePath, $httpMethod

Properties inherited from OpenDNS\MES\Request

$apiBaseDomain, $apiEndpointPath, $apiEnvironment, $defaultFieldValues