WEBCentralizedShoppingCartGetPaymentOptions

Initial Build	2008.01
xWEB	Web Method
Response Type	XML Results

This method can be used to get a list of potential payment methods for the shopping cart.

Only payment methods of these general payment type will be returned, and only if they are configured in netFORUM to show online:

• Credit Card
• Telecheck
• ACH
• PayPal

Important! Payment methods are not fixed for a netFORUM site. They can vary by the Business Unit associated with the order. In most cases, the business unit is derived from the Batch which is contained in <Invoice.inv_bat_key> in the Shopping Cart Object. Therefore, to reduce the frequency that you need to call this method, your application can cache locally the payments methods associated with a particular inv_bat_key. It is safe to say that once you pass one Shopping Cart Object with a particular batch key, then the results from this web method will be the same for any other Shopping Cart Object with the same batch key.

Parameters

Name	Type	Occurs	Description
oCentralizedOrderEntry	CentralizedOrderEntryType	0(R)..1	The active shopping cart object.

Return

XML Results containing a list of Payment Methods.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>?</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBCentralizedShoppingCartGetPaymentOptions>
<ns:oCentalizedOrderEntry> 
            [[Shopping Cart Object]]
</ns:oCentalizedOrderEntry>
</ns:WEBCentralizedShoppingCartGetPaymentOptions>
</soapenv:Body>
</soapenv:Envelope>

Sample Response

Name	Description	Datatype	Notes
apm_key	Key	string	The primary key (in the format of a Guid Type) of the payment method. This key will be needed to pass into other methods.
apm_type	Type	string	The general type of the payment method (credit cart, telectheck, ACH, PayPal, etc.
apm_method	Method	string	The name of the method such as Visa, American Express, etc. This is the value that you would show to an end user if you are giving them a choice of which payment method to use.

Troubleshooting: All Payment Methods

The following GetQuery will give you a list of all payment methods, both "electronic" and non-electronic.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>*************************</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:GetQuery>
<ns:szObjectName>PaymentMethod</ns:szObjectName>
<ns:szColumnList>atc_code, pma_atc_key, apm_method, apm_type, apm_eweb_flag, apm_atc_key, gtw_name, pma_config_option, gtw_assembly, gtw_type_name, apm_gateway_is_frozen_flag, pma_gateway_is_frozen_flag, gtw_gateway_is_frozen_flag</ns:szColumnList>
<ns:szWhereClause>pma_delete_flag=0</ns:szWhereClause>
<ns:szOrderBy>ac_payment_gateway.gtw_name,pma_config_option,apm_method</ns:szOrderBy>
</ns:GetQuery>
</soapenv:Body>
</soapenv:Envelope>