Zend Framework: Zend_Service_AuthorizeNet_Cim Component Proposal

Proposed Component Name	Zend_Service_AuthorizeNet_Cim
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Service_AuthorizeNet_Cim
Proposers	Torio Farazdagi
Zend Liaison	TBD
Revision	0.1 - 14 July 2009: Initial Proposal Draft. 0.2 - 16 July 2009: Excluded all APIs except for CIM 0.3 - 18 July 2009: All UCs provided 0.4 - 07 Aug 2009: UC refactored 0.5 - 07 Aug 2009: prepared for review (wiki revision: 29)

Zend_Service_AuthorizeNet_Cim is an interface to Authorize.net's Customer Information Management (CIM) API. At first draft only XML implementation would be provided, with the possible SOAP inclusion at later point (no change to code, except adapter extension would be required - code layout was created with this in mind).

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

This component will provide interface for CIM (XML).
This component will not provide interface for CIM (SOAP). However, all infrastructure for possible extension should be in place.

4. Dependencies on Other Framework Components

Zend_Http_Client
Zend_Http_Client_Adapter_Socket
Zend_Http_Response
Zend_Config
Zend_Loader
Zend_Service_Abstract
Zend_Uri_Http

5. Theory of Operation

Package would provide high-level interface for interaction with CIM API. In a nutshell, client should obtain required service adapter (XML|SOAP), and then interact with CIM API via mapped methods. There are number of container classes that abstract data required to be passed along with RPC calls. Internally, Zend_Http_Client is used as transport, with returned results provided as SimpleXml objects.

6. Milestones / Tasks

Milestone 1: design notes will be published here
Milestone 2: [DONE] Use cases for all 15 methods of CIM API should be prepared
Milestone 3: [DONE] Working prototype for all UCs prepared
Milestone 4: Unit tests exist, work, and are checked into SVN.
Milestone 5: Initial documentation exists.

If a milestone is already done, begin the description with "[DONE]", like this:

Milestone #: [DONE] Unit tests ...

7. Class Index

General
- Zend_Service_AuthorizeNet_Abstract
- Zend_Service_AuthorizeNet_Exception

CIM API
- Zend_Service_AuthorizeNet_Cim - factory
- Zend_Service_AuthorizeNet_Cim_Adapter - general service adapter
- Zend_Service_AuthorizeNet_Cim_Adapter_Xml - XML service adapter

Gateway Response
- Zend_Service_AuthorizeNet_Response
- Zend_Service_AuthorizeNet_Cim_Response - CIM specific reponse extends base *_Response class
- Zend_Service_AuthorizeNet_Cim_Response_Xml - XML adapter specific response

General Data Containers
- Zend_Service_AuthorizeNet_Cim_Data - factory
- Zend_Service_AuthorizeNet_Cim_Data_Abstract - base data class
- Zend_Service_AuthorizeNet_Cim_Data_Profile - represents customer profile
- Zend_Service_AuthorizeNet_Cim_Data_ProfileUpdate - update method requires simplier profile
- Zend_Service_AuthorizeNet_Cim_Data_PaymentProfile - payment profile
- Zend_Service_AuthorizeNet_Cim_Data_PaymentBankAccount
- Zend_Service_AuthorizeNet_Cim_Data_PaymentCreditCard
- Zend_Service_AuthorizeNet_Cim_Data_CustomerAddress - base class for representing address

XML Data Containers (implement abstract General Data Containers)
- Zend_Service_AuthorizeNet_Cim_Data_Xml_Profile
- Zend_Service_AuthorizeNet_Cim_Data_Xml_ProfileUpdate
- Zend_Service_AuthorizeNet_Cim_Data_Xml_PaymentProfile
- Zend_Service_AuthorizeNet_Cim_Data_Xml_CustomerAddress
- Zend_Service_AuthorizeNet_Cim_Data_Xml_ShipToList - extends *_Cim_Data_CustomerAddress
- Zend_Service_AuthorizeNet_Cim_Data_Xml_BillTo - extends *_Cim_Data_CustomerAddress
- Zend_Service_AuthorizeNet_Cim_Data_Xml_PaymentBankAccount
- Zend_Service_AuthorizeNet_Cim_Data_Xml_PaymentCreditCard

General Transaction Containers
- Zend_Service_AuthorizeNet_Cim_Transaction - factory
- Zend_Service_AuthorizeNet_Cim_Transaction_Abstract - base transaction class
- Zend_Service_AuthorizeNet_Cim_Transaction_AuthCapture
- Zend_Service_AuthorizeNet_Cim_Transaction_AuthOnly
- Zend_Service_AuthorizeNet_Cim_Transaction_CaptureOnly
- Zend_Service_AuthorizeNet_Cim_Transaction_PriorAuthCapture
- Zend_Service_AuthorizeNet_Cim_Transaction_Refund
- Zend_Service_AuthorizeNet_Cim_Transaction_Void

XML Transaction Containers (implement abstract General Containers)
- Zend_Service_AuthorizeNet_Cim_Transaction_Xml_AuthCapture
- Zend_Service_AuthorizeNet_Cim_Transaction_Xml_AuthOnly
- Zend_Service_AuthorizeNet_Cim_Transaction_Xml_CaptureOnly
- Zend_Service_AuthorizeNet_Cim_Transaction_Xml_PriorAuthCapture
- Zend_Service_AuthorizeNet_Cim_Transaction_Xml_Refund
- Zend_Service_AuthorizeNet_Cim_Transaction_Xml_Void

Auxillary Transaction Containers
- Zend_Service_AuthorizeNet_Cim_Transaction_ExtendedAmountType - extendedAmountType in ANet schema
- Zend_Service_AuthorizeNet_Cim_Transaction_LineItemType - lineItemType in ANet schema
- Zend_Service_AuthorizeNet_Cim_Transaction_OrderExType - orderExType in ANet schema

SOAP Data Containers (not implemented)
- Zend_Service_AuthorizeNet_Cim_Data_Soap_*

8. Use Cases

UC-01 Obtaining service adapter

// you can set credentials via static method (credentials are valid for all newly created adapter instances)
Zend_Service_AuthorizeNet_Cim::setKeys('API_LOGIN_ID', 'TRANSACTION_KEY');

// constructor pars: $loginId, $tranKey, $serviceUri, Zend_Http_Client $httpClient
// all values are optional/coditional
// $loginId and $tranKey can be set via Zend_Service_AuthorizeNet_Cim::setKeys
// $serviceUri defaults to production (as opp. to sandbox) mode URI for a given adapter
// $httpClient defaults to sockets client
$cim = new Zend_Service_AuthorizeNet_Cim_Adapter_Xml();

UC-02 Obtaining service adapter via factory

// either array or instance of Zend_Config
// again all parameters are optional with default adapter being
// Zend_Service_AuthorizeNet_Cim::ADAPTER_XML
$config = array(
    'adapter' => Zend_Service_AuthorizeNet_Cim::ADAPTER_XML,
    'loginId' => 'API_LOGIN_ID',
    'tranKey' => 'TRANSACTION_KEY',
    'serviceUri' => Zend_Service_AuthorizeNet_Cim_Adapter_Xml::URI_SANDBOX
);
// obtain CIM client (Zend_Service_AuthorizeNet_Cim_Adapter_Xml in this case)
$cim = Zend_Service_AuthorizeNet_Cim::factory($config);

UC-03 Clarifying adapter mode

// you can always switch between modes with sandboxMode method - all it does is swapping service URIs
$cim->sandboxMode(true);

// sandboxMode($flag) returns $this, so you can glue other methods to it
// thus turning sandbox mode on per API call mode is easy
$cim->sandboxMode(true)->createCustomerProfileRequest($profile);

UC-04 Using Data Containers

Each API method expects data object as input, you have several options of initializing data containers (which are wrappers objects for data which implement __toString() - thus they are able to transform raw data into XML|SOAP representation).

You can create data container by using Zend_Service_AuthorizeNet_Cim_Data::factory() directly:

$profileData = array(
    'merchantCustomerId'    => 126,
    'description'           => 'John Willey',
    'email'                 => 'john@gmail.com',
);
// you can pass adapter type as third parameter, if none passed previously created
// adapter is used. If none was created yet, ADAPTER_XML is used
$profile = Zend_Service_AuthorizeNet_Cim_Data::factory('Profile', $profileData);

// all data containers implement __toString() returning either XML or SOAP 
// representation of object (depending on adapter)
Zend_Debug::dump((string)$profile);

The obvious drawback of this method is that you have to remember name of container ('Profile' in this case), even if we have class constant we would still be left with an issue: factory method returns object of abstract class (Zend_Service_AuthorizeNet_Cim_Data_Abstract) so your editor auto-completion features would not be accessible (exact type of returned object is known only at run-time).
To resolve this issue, Zend_Service_AuthorizeNet_Cim_Data provides helper methods, for eg in order to create Profile data container:

// Zend_Service_AuthorizeNet_Cim_Data_Profile is returned
$profile = Zend_Service_AuthorizeNet_Cim_Data::getProfile($profileData);

Now, when exact type of $profile is known, you can use editor auto-complete. The reason I am so pre-occupied with object reflection is simple - you can not only pass data as array into constructor, but use wrapper's getters/setters to manipulate content (so you don't have to remember the exact names of gateway parameters):

$profile = Zend_Service_AuthorizeNet_Cim_Data::getProfile()
                ->setMerchantCustomerId(13)
                ->setDescription('John Willey')
                ->setEmail('john@gmail.com');

UC-05 Processing request responses

All request return SimpleXml object as response (probably should return arrays or dedicated object?).

$response = $cim->createCustomerProfileRequest($profile);
if($response->isSuccessful()) {
    // $response->getParsedData() holds SimpleXMLElement representation of response XML
    echo $response->getParsedData()->customerProfileId; // returns newly created profile ID
} else {
    // echo error message text
    echo $response->getParsedData()->messages->message->text;
}

UC-06 Create simple customer profile - createCustomerProfileRequest()

$profileData = array(
    'merchantCustomerId'    => 126,
    'description'           => 'John Willey',
    'email'                 => 'john@gmail.com',
);
// obtain data container
$profile = Zend_Service_AuthorizeNet_Cim_Data::getProfile($profileData);
// process
$response = $cim->createCustomerProfileRequest($profile);

Using setters:

$profile = Zend_Service_AuthorizeNet_Cim_Data::getProfile()
            ->setMerchantCustomerId(123)
            ->setDescription('John Willey')
            ->setEmail('john@gmail.com');
$response = $cim->createCustomerProfileRequest($profile);

UC-07 Create full customer profile - createCustomerProfileRequest()

// billing and shipping details (here set the same)
$billTo =
$shipToList = array( // set shipping details
    'firstName' => 'John',
    'lastName'  => 'Willey',
    'company'   => 'MyComp',
    'address'   => 'My address',
    'city'      => 'Mozdok',
    'state'     => 'CO',
    'zip'       => '12345',
    'country'   => 'US',
    'phoneNumber'   => '(123)123-1234',
    'faxNumber'     => '(123)123-1234',
);

// CC data
$paymentTypeCreditCard = array('creditCard' => array(
    'cardNumber'        =>  '4111111111111111',
    'expirationDate'    => '2011-05',
    'cardCode'          => '345'
));

// Alternatively you can use echecks
$paymentTypeBankAccount = array('bankAccount' => array(
    'accountType'   => 'checking',      // OPTIONAL. checking, savings, businessChecking
    'routingNumber' => '123456789',
    'accountNumber' => '12345',
    'nameOnAccount' => 'John Willey',
    'echeckType'    => 'CCD',           // OPTIONAL. CCD, PPD, TEL, WEB
    'bankName'      => 'Savings Bank',  // OPTIONAL.
));

// payment profile
$paymentProfile = array(
    'customerType' => 'business',
    'billTo'       => $billTo,
    'payment'      => $paymentTypeCreditCard,
    //'payment'      => $paymentTypeBankAccount
);

// customer profile
$profileData = array(
    'merchantCustomerId'    => 127,
    'description'           =>  'John Willey',
    'email'                 => 'john@gmail.com',
    'paymentProfiles'       => array($paymentProfile),  // paymentProfiles
                                                        // you can have several profiles
    'shipToList'            => array($shipToList)       // shipping details
                                                        // you can have several addresses
);
// obtain data container
$profile = Zend_Service_AuthorizeNet_Cim_Data::getProfile($profileData);
// process
$response = $cim->createCustomerProfileRequest($profile);

Using setters:

// setup billing address
$billTo = Zend_Service_AuthorizeNet_Cim_Data::getCustomerAddress()
                    ->setFirstName('John')
                    ->setLastName('Willey')
                    ->setAddress('My Address')
                    ->setCity('Mozdok')
                    ->setCountry('US');
// payment type
$paymentType = Zend_Service_AuthorizeNet_Cim_Data::getPaymentCreditCard()
                    ->setCardNumber('4111111111111111')
                    ->setExpirationDate('2009-12')
                    ->setCardCode('123');
// payment profile = billing address + payment type
$paymentProfile = Zend_Service_AuthorizeNet_Cim_Data::getPaymentProfile()
                    ->setCustomerType('business')
                    ->setBillTo($billTo)
                    ->setPayment($paymentType);
// complete customer profile = payment profile + ship to address
$profile = Zend_Service_AuthorizeNet_Cim_Data::getProfile()
                    ->setDescription('John Willey')
                    ->setEmail('john@gmail.com')
                    ->addPaymentProfileItem($paymentProfile) // we may add serveral profiles
                    ->addShipToListItem($billTo);   // use billing address as shipping dest.
// process
$response = $cim->createCustomerProfileRequest($profile);

UC-08 Create payment profile for an existing customer profile - createCustomerPaymentProfileRequest()

// payment profile
$paymentTypeCreditCard = array('creditCard' => array(
    'cardNumber'        =>  '342781835011463',
    'expirationDate'    => '2011-05',
    'cardCode'          => '345'
));
$paymentProfile = array(
    'customerType' => 'business',
    'payment'      => $paymentTypeCreditCard,
);
// obtain respective data container
$paymentProfile = Zend_Service_AuthorizeNet_Cim_Data::getPaymentProfile($paymentProfile);
// execute - 627355 is customerProfileId created with createCustomerProfileRequest
$response = $cim->createCustomerPaymentProfileRequest(627355, $paymentProfile);

Using setters:

$paymentType = Zend_Service_AuthorizeNet_Cim_Data::getPaymentCreditCard()
                    ->setCardNumber('342781835011463')
                    ->setExpirationDate('2011-05')
                    ->setCardCode('345');
// payment profile = billing address + payment type
$paymentProfile = Zend_Service_AuthorizeNet_Cim_Data::getPaymentProfile()
                    ->setCustomerType('business')
                    ->setPayment($paymentType);
// process
$response = $cim->createCustomerPaymentProfileRequest(627355, $paymentProfile);

UC-09 Create shipping address for an existing customer profile - createCustomerShippingAddressRequest()

// shipping data
$shipToList = array(
        'firstName'     => 'John',
        'lastName'      => 'Willey',
        'company'       => 'MyComp',
        'address'       => 'My address',
        'city'          => 'Mozdok',
        'state'         => 'CO',
        'zip'           => '12345',
        'country'       => 'US',
        'phoneNumber'   => '(123)123-1234',
        'faxNumber'     => '(123)123-1234',
);
// obtain respective data container
$shipTo = Zend_Service_AuthorizeNet_Cim_Data::getCustomerAddress($shipToList);
// execute - 627355 is customerProfileId created with createCustomerProfileRequest
$response = $cim->createCustomerShippingAddressRequest(627355, $shipTo);

Using setters:

// setup billing address
$shipTo = Zend_Service_AuthorizeNet_Cim_Data::getCustomerAddress()
                    ->setFirstName('John')
                    ->setLastName('Willey')
                    ->setAddress('My Address')
                    ->setCity('Mozdok')
                    ->setCountry('US');
// execute - 627355 is customerProfileId created with createCustomerProfileRequest
$response = $cim->createCustomerShippingAddressRequest(627355, $shipTo);

UC-10 Create transaction (AUTH_ONLY, using config array)

$transactionData = array(
    'amount'                    => 18.5,
    'customerProfileId'         => 627419,
    'customerPaymentProfileId'  => 583014,
    'customerShippingAddressId' => 618321,   // OPTIONAL
    'taxExempt'                 => false,   // OPTIONAL
    'recurringBilling'          => true,    // OPTIONAL
    'cardCode'                  => 123,     // CONDITIONAL - required only if CCV verification is needed

    // other options could be set via methods
    'tax'       => array('amount' => 5.3, 'name' => 'SomeTax', 'description' => 'Tax Description'),
    'shipping'  => array('amount' => 7.3, 'name' => 'SomeShippingName', 'description' => 'Shipping Description'),
    'duty'      => array('amount' => 8.3, 'name' => 'SomeDutyName', 'description' => 'Duty description'),
    // order info
    'order'     => array(
        'invoiceNumber'         => 'MY_INVOICE_NO-123', // merchant assigned invoice number
        'purchaseOrderNumber'   => 'MY_ORDER_NO-1234',  // merchant assigned purchase order number
        'description'           => 'invoice desc'
    ),
    // products
    'lineItems'  => array(
        array(
            'itemId'        => 123,
            'name'          => 'ProductA',
            'quantity'      => 1,
            'unitPrice'     => 12.5,
            'description'   => 'ProdcutA Description',
            'taxable'       => false
        ),
        array(
            'itemId'        => 124,
            'name'          => 'ProductB',
            'quantity'      => 1,
            'unitPrice'     => 6.0,
            'description'   => 'ProdcutB Description',
            'taxable'       => true
        ),
    )
);
// obtain transaction container
$transaction = Zend_Service_AuthorizeNet_Cim_Transaction::getAuthOnly($transactionData);
$response = $cim->createCustomerProfileTransactionRequest($transaction, 'some_param=12&some another param=value', 'some ref');

Using setters:

// obtain transaction container
$transaction = Zend_Service_AuthorizeNet_Cim_Transaction::getAuthOnly()
                ->setAmount(18.5)
                ->setCustomerProfileId(627419)
                ->setCustomerPaymentProfileId(583014)
                ->setCustomerShippingAddressId(618321)
                ->setTaxExempt(false)
                ->setRecurringBilling(false)
                ->setCardCode('312')
                ->setTax(4.5, 'some tax', 'tax description')
                ->setDuty(0.22, 'some duty', 'duty description')
                ->setShipping(0.11, 'some shipping', 'shipping description')
                // itemId, name, quantity, unitPrice, description = null, taxable = null
                ->addLineItem(123, 'ProductA', 1.0, 12.5, 'ProductA Description', false)
                // invoiceNumber, purchaseOrderNumber, description
                ->setOrder('MY_INVOICE_NO-123', 'MY_ORDER_NO-1234', 'invouce desc');
// execute
$response = $cim->createCustomerProfileTransactionRequest($transaction, 'some_param=12&some another param=value', 'some ref');

UC-11 Create AUTH_CAPTURE transaction

// obtain transaction container
$transaction = Zend_Service_AuthorizeNet_Cim_Transaction::getAuthCapture()
                ->setAmount(18.5)
                ->setCustomerProfileId(627419)
                ->setCustomerPaymentProfileId(583014)
                ->setCustomerShippingAddressId(618321)
                ->setTaxExempt(false)
                ->setRecurringBilling(false)
                ->setCardCode('312')
                ->setTax(4.5, 'some tax', 'tax description')
                ->setDuty(0.22, 'some duty', 'duty description')
                ->setShipping(0.11, 'some shipping', 'shipping description')
                // itemId, name, quantity, unitPrice, description = null, taxable = null
                ->addLineItem(123, 'ProductA', 1.0, 12.5, 'ProductA Description', false)
                // invoiceNumber, purchaseOrderNumber, description
                ->setOrder('MY_INVOICE_NO-123', 'MY_ORDER_NO-1234', 'invouce desc');
// execute
$response = $cim->createCustomerProfileTransactionRequest($transaction, 'some_param=12&some another param=value', 'some ref');

UC-12 Create CAPTURE_ONLY transaction

// obtain transaction container
$transaction = Zend_Service_AuthorizeNet_Cim_Transaction::getCaptureOnly()
                ->setApprovalCode('LPSGXB')
                ->setAmount(18.5)
                ->setCustomerProfileId(627419)
                ->setCustomerPaymentProfileId(583014)
                // invoiceNumber, purchaseOrderNumber, description
                ->setOrder('MY_INVOICE_NO-123', 'MY_ORDER_NO-1234', 'invouce desc');
// execute
$response = $cim->createCustomerProfileTransactionRequest($transaction, 'some_param=12&some another param=value', 'some ref');

UC-13 Create PRIOR_AUTH_CAPTURE transaction

// obtain transaction container
$transaction = Zend_Service_AuthorizeNet_Cim_Transaction::getPriorAuthCapture()
                ->setTransId('2150315710')
                ->setAmount(18.5)
                ->setOrder('MY_INVOICE_NO-123', 'MY_ORDER_NO-1234', 'invouce desc');
// execute
$response = $cim->createCustomerProfileTransactionRequest($transaction, 'some_param=12&some another param=value', 'some ref');

UC-14 Create VOID (cancel) transaction

// obtain transaction container
$transaction = Zend_Service_AuthorizeNet_Cim_Transaction::getVoid()
                ->setTransId('2150315710');
// execute
$response = $cim->createCustomerProfileTransactionRequest($transaction, 'some_param=12&some another param=value', 'some ref');

UC-15 Create CREDIT (refund) transaction

// obtain transaction container
$transaction = Zend_Service_AuthorizeNet_Cim_Transaction::getRefund()
                ->setTransId('2150315916')
                ->setAmount(18.5)
                ->setCustomerProfileId(627419)
                ->setCustomerPaymentProfileId(583014);
// alternatively providing creditCardNumberMasked for CC transactions, or
// bankRoutingNumberMasked + bankAccountNumberMasked for eCheck transactions
// should be enough to void the transation
$transaction = Zend_Service_AuthorizeNet_Cim_Transaction::getRefund()
                ->setTransId('2150315916')
                ->setAmount(18.5)
                ->setCreditCardNumberMasked('XXXX1111');
// execute
$response = $cim->createCustomerProfileTransactionRequest($transaction, 'some_param=12&some another param=value', 'some ref');

UC-16 Delete customer profile and all associated data - deleteCustomerProfileRequest()

// $customerProfileId
$response = $cim->deleteCustomerProfileRequest(627355);

UC-17 Delete a customer payment profile from an existing customer profile - deleteCustomerPaymentProfileRequest()

// $customerProfileId, $customerPaymentProfileId
$response = $cim->deleteCustomerPaymentProfileRequest(627355, 582943);

UC-18 Delete a customer shipping address from an existing customer profile - deleteCustomerShippingAddressRequest()

// $customerProfileId, $customerShippingAddressId
$response = $cim->deleteCustomerShippingAddressRequest(627355, 618311);

UC-19 List all customer profile ids - getCustomerProfileIdsRequest()

$response = $cim->getCustomerProfileIdsRequest();
if($response->isSuccessful()) {
    Zend_Debug::dump($response->getParsedData());
    foreach($response->getParsedData()->ids->numericString as $id) {
        Zend_Debug::dump((int)$id);
    }
} else {
    // echo error message text
    echo $response->getParsedData()->messages->message->text;
}

UC-20 Get customer profile data - getCustomerProfileRequest()

// 587194 is customerProfileId created with createCustomerProfileRequest
$response = $cim->getCustomerProfileRequest(587194);

UC-21 Get customer's payment profile data - getCustomerPaymentProfileRequest()

// 587194 - customer profile ID; 543895 - payment profile ID for a given customer;
$response = $cim->getCustomerPaymentProfileRequest(587194, 543895);

UC-22 Get customer's shipping address data - getCustomerShippingAddressRequest()

// 587194 - customer profile ID; 580680 - shipping address ID for a given customer;
$response = $cim->getCustomerShippingAddressRequest(587194, 580680);

UC-23 Update customer profile - updateCustomerProfileRequest()

// customer profile
$profileData = array(
    'merchantCustomerId'    => 127,
    'description'           => 'John Willey - updated profile',
    'email'                 => 'john@gmail.com',
);
// obtain data container
$profile = Zend_Service_AuthorizeNet_Cim_Data::getProfile($profileData);
// 627419 - customer profile ID
$response = $cim->updateCustomerProfileRequest(627419, $profile);

Using setters:

// obtain data container
$profile = Zend_Service_AuthorizeNet_Cim_Data::getProfile()
            ->setMerchantCustomerId(123)
            ->setDescription('John Willer - updated');
// 627419 - customer profile ID
$response = $cim->updateCustomerProfileRequest(627419, $profile);

UC-24 Update payment profile - updateCustomerPaymentProfileRequest()

// payment profile
$paymentTypeCreditCard = array('creditCard' => array(
    'cardNumber'        => '4111111111111111',
    'expirationDate'    => '2011-05',
    'cardCode'          => '543'
));
$paymentProfile = array(
    'customerType' => 'business',
    'payment'      => $paymentTypeCreditCard,
    'customerPaymentProfileId'  => 583014 // payment profile ID
);
// obtain respective data container
$paymentProfile = Zend_Service_AuthorizeNet_Cim_Data::getPaymentProfile($paymentProfile);
// $customerProfileId, $paymentProfile
$response = $cim->updateCustomerPaymentProfileRequest(627419, $paymentProfile);

Using setters:

// payment type
$paymentType = Zend_Service_AuthorizeNet_Cim_Data::getPaymentCreditCard()
                    ->setCardNumber('342955624318368')
                    ->setExpirationDate('2009-12')
                    ->setCardCode('123');
// payment profile = billing address + payment type
$paymentProfile = Zend_Service_AuthorizeNet_Cim_Data::getPaymentProfile()
                    ->setCustomerPaymentProfileId(583014)
                    ->setCustomerType('individual')
                    ->setPayment($paymentType);
// $customerProfileId, $paymentProfile
$response = $cim->updateCustomerPaymentProfileRequest(627419, $paymentProfile);

UC-25 Update shipping data

// shipping data
$shipToList = array(
        'customerShippingAddressId' => 618321, // shipping address ID
        'firstName' => 'John',
        'lastName'  => 'Willey',
        'company'   => 'MyNewComp',
        'address'   => 'My New Address',
        'city'      => 'Mozdok',
        'state'     => 'CO',
        'zip'       => '12345',
        'country'   => 'US',
        'phoneNumber'   => '(123)123-1234',
        'faxNumber'   => '(123)123-1234',
);

// obtain respective data container
$shipTo = Zend_Service_AuthorizeNet_Cim_Data::getCustomerAddress($shipToList);
// $customerProfileId, $address
$response = $cim->updateCustomerShippingAddressRequest(627419, $shipTo);

Using setters:

// setup billing address
$shipTo = Zend_Service_AuthorizeNet_Cim_Data::getCustomerAddress()
                    ->setCustomerShippingAddressId(618321)
                    ->setFirstName('John')
                    ->setLastName('Willey')
                    ->setAddress('My New Address')
                    ->setCity('Mozdok')
                    ->setCountry('US');
// $customerProfileId, $address
$response = $cim->updateCustomerShippingAddressRequest(627419, $shipTo);

UC-26 Validate customer profile

// $customerProfileId, $customerPaymentProfileId, $customerShippingAddressId, $cardCode, $validationMode
// Possible modes: testMode | liveMode
$response = $cim->validateCustomerPaymentProfileRequest(589241, 545831, 582752, '123', 'testMode');

9. Class Skeletons

Working prototype - http://www.phpmag.ru/AuthorizeNet.tar.gz

Page Operations

Browse Space

Zend_Service_AuthorizeNet_Cim - Victor Farazdagi

Labels

Zend Framework: Zend_Service_AuthorizeNet_Cim Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons