Develop > Controller layer > Integrate with back-end systems and external applications > Customize WebSphere Commerce Payments > Cashier function in WebSphere Commerce Payments > Cashier profiles


Cashier profile for the CustomOffline cassette (COD payment method)

The following XML code is the sample cashier profile provided in WebSphere Commerce for the CustomOffline cassette Cash-On-Delivery (C.O.D) payment method. "COD" is the internal keyword value for the $METHOD protocol data parameter required by the cassette:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Profile SYSTEM "profile.dtd"> 
<!--
==================================================================
This is the Standard WebSphere Commerce Cashier profile for the
CustomOffline Cassette 
for the "COD" payment method ($METHOD="COD")
==================================================================
--> 
<Profile useWallet="false" enableTrace="true" > 
<CollectPayment> 
<!--
==================================================================
Parameters required by WebSphere Commerce Payments for order
creation
==================================================================
-->
<Parameter
name="PAYMENTTYPE"><CharacterText>CustomOffline</CharacterText></Parameter>
<Parameter
name="MERCHANTNUMBER"><CharacterText>{storeId}</CharacterText></Parameter>
<Parameter
name="ORDERNUMBER"><CharacterText>{orderId}</CharacterText></Parameter>
<Parameter
name="CURRENCY"><CharacterText>{CURRENCY}</CharacterText></Parameter>
<Parameter
name="AMOUNT"><CharacterText>{AMOUNT}</CharacterText></Parameter>
<Parameter
name="AMOUNTEXP10"><CharacterText>{AMOUNTEXP10}</CharacterText></Parameter> 
<!-- Indicates how automatic approval of the order should be
attempted
Supported values are: 
0 - no automatic approval
1 - synchronous automatic approval - WebSphere Commerce Payments
attempts approval as
part of order creation operation
2 - asynchronous automatic approval - WebSphere Commerce Payments
schedules an approval
operations after order is created
The default value is 0.
-->
<Parameter
name="APPROVEFLAG"><CharacterText>0</CharacterText></Parameter> 
<!-- The amount which should be used when approving an order.
Typically
this will be the same as the order amount. This field is required
if the APPROVEFLAG is set to 1 or 2. -->
<Parameter
name="PAYMENTAMOUNT"><CharacterText></CharacterText></Parameter> 
<!-- The payment number which should be used when approving an
order.
Typically this will be 1. This field is required if the APPROVEFLAG
is set to 1 or 2. -->
<Parameter
name="PAYMENTNUMBER"><CharacterText></CharacterText></Parameter> 
<!-- Indicates whether the deposit should be attempted
automatically. 
This flag is only valid if APPROVEFLAG is set to 1 or 2.
Supported values are: 0 - Funds should not be automatically deposited. 
1 - Funds should be automatically deposited. 
The default value is 0.

Automatic Deposit can also be controled via the Account Advanced
Setting
-->
<Parameter
name="DEPOSITFLAG"><CharacterText></CharacterText></Parameter> 
<!-- The following two parameters are optional. Either one could
be used to pass the 
Buyer Purchase Order number to WebSphere Commerce Payments. The
first Parameter takes only 
ASCII Text. If Buyer Purchase Order numbers on the system may
contain non-ASCII 
Strings, use parameter ORDERDATA2 instead. 
-->
<Parameter name="TRANSACTIONID" maxBytes="128"
encoding="ASCII"><CharacterText>{PONumber}</CharacterText></Parameter>
<Parameter
name="ORDERDATA2"><CharacterText></CharacterText></Parameter> 

<!--
==================================================================
Parameters required by the cassette
==================================================================
--> 
<!-- Indicates the manual payment method to be used. Must match
one of the
methods configured for the CustomOffline Accounts for the Merchant.
This is an ASCII String from 1 to 32 characters long.
-->
<Parameter
name="$METHOD"><CharacterText>COD</CharacterText></Parameter> 

<!--
==================================================================
Optional parameters for the CustomOffline Cassette
==================================================================
--> 
<!-- Use the $AUXILIARY1 and $AUXILIARY2 fields for anything you
like.
Can be any String from 0 to 254 Characters long. 
-->
<Parameter
name="$AUXILIARY1"><CharacterText>{$AUXILIARY1}</CharacterText></Parameter>
<Parameter
name="$AUXILIARY2"><CharacterText>{$AUXILIARY2}</CharacterText></Parameter> 
<Parameter
name="$STREETADDRESS"><CharacterText>{billto_address1}</CharacterText></Parameter>
<Parameter
name="$CITY"><CharacterText>{billto_city}</CharacterText></Parameter>
<Parameter
name="$STATEPROVINCE"><CharacterText>{billto_state}</CharacterText></Parameter>
<Parameter
name="$POSTALCODE"><CharacterText>{billto_zipcode}</CharacterText></Parameter>
<Parameter
name="$COUNTRYCODE"><CharacterText>{billto_country}</CharacterText></Parameter> 
</CollectPayment> 
<Command name="DEPOSIT">
<!--
==================================================================
Parameters required by WebSphere Commerce Payments for the DEPOSIT
Command
==================================================================
-->
<Parameter
name="MERCHANTNUMBER"><CharacterText>{storeId}</CharacterText></Parameter>
<Parameter
name="ORDERNUMBER"><CharacterText>{orderId}</CharacterText></Parameter>
<Parameter
name="PAYMENTNUMBER"><CharacterText>{payment_number}</CharacterText></Parameter>
<Parameter
name="AMOUNT"><CharacterText>{AMOUNT}</CharacterText></Parameter>
</Command> 


</Profile>

You can find the WC51_CustomOffline_COD.profile file in the following directory:

WC_EAR/xml/payment/

The PAYMENTTYPE parameter specifies the name of this profile's cassette.

WebSphere Commerce does not use the <BuyPageInformation> element of the Cashier profile. Comparable function is provided with the attrPageName property of the payment policy.

A payment policy is not included for this sample Cashier profile. Credit line is a more appropriate payment method rather than "COD".

To add a payment policy for this Cashier profile, refer to adding a new payment policy.


Related concepts

Cashier profiles

Related reference

Cashier profiles


+

Search Tips   |   Advanced Search