PaymentServerRequest

java.lang.Object
- com.ibm.etill.framework.clientapi.PaymentServerRequest

All Implemented Interfaces:

PaymentCommandConstants

Deprecated.
Replaced by WebSphere Commerce Payment Plug-in Specification APIs.
```
public class PaymentServerRequest
extends java.lang.Object
implements PaymentCommandConstants
```
Commerce Payments request class is used by the Commerce Payments client object to prepare the request into the HTTP format.

Field Summary
- Fields inherited from interface com.ibm.etill.framework.clientapi.PaymentCommandConstants
  BATCHSTATE_CLOSED, BATCHSTATE_CLOSING, BATCHSTATE_OPEN, BATCHSTATE_OPENING, BATCHSTATE_PENDING, CREDITSTATE_CLOSED, CREDITSTATE_DECLINED, CREDITSTATE_PENDING, CREDITSTATE_REFUNDED, CREDITSTATE_RESET, CREDITSTATE_VOID, KEY_ACCEPTPAYMENTAUTOAPPROVE, KEY_ACCEPTPAYMENTAUTODEPOSIT, KEY_ACCOUNTNUMBER, KEY_ACCOUNTTITLE, KEY_ADMINHOSTNAME, KEY_AMOUNT, KEY_AMOUNTEXP10, KEY_APPROVALEXPIRATION, KEY_APPROVEFLAG, KEY_APPROVESALLOWED, KEY_BATCHID, KEY_BATCHNUMBER, KEY_BECOME, KEY_BEGINTIME, KEY_BRAND, KEY_CASSETTECOMMAND, KEY_CASSETTENAME, KEY_CLOSEALLOWED, KEY_CLOSEBEGINTIME, KEY_CLOSEENDTIME, KEY_COMMTYPE, KEY_CREATEBEGINTIME, KEY_CREATEENDTIME, KEY_CREDITNUMBER, KEY_CURRENCY, KEY_DELETEORDER, KEY_DEPOSITFLAG, KEY_DTDPATH, KEY_ENABLED, KEY_ENDTIME, KEY_ETAPIVERSION, KEY_ETILLHOSTNAME, KEY_EVENTTYPE, KEY_FILTER, KEY_FINANCIALINSTITUTION, KEY_FORCE, KEY_KEYSONLY, KEY_LISTENERURL, KEY_LOGPATH, KEY_MAXAMOUNT, KEY_MAXAPPROVEAMOUNT, KEY_MAXDEPOSITAMOUNT, KEY_MAXUNAPPROVEDAMOUNT, KEY_MEMBERNAME, KEY_MERCHANTACCOUNT, KEY_MERCHANTNUMBER, KEY_MERCHANTTITLE, KEY_MINAMOUNT, KEY_MINAPPROVEAMOUNT, KEY_MINDEPOSITAMOUNT, KEY_MINUNAPPROVEDAMOUNT, KEY_MODIFYBEGINTIME, KEY_MODIFYENDTIME, KEY_NDHOSTNAME, KEY_NEWPASSWORD, KEY_OBJECTNAME, KEY_OPENBEGINTIME, KEY_OPENENDTIME, KEY_OPERATION, KEY_ORDERDATA1, KEY_ORDERDATA2, KEY_ORDERDATA3, KEY_ORDERDATA4, KEY_ORDERDATA5, KEY_ORDERNUMBER, KEY_ORDERURL, KEY_PASSWORD, KEY_PAYMENTAMOUNT, KEY_PAYMENTGROUPNAME, KEY_PAYMENTNUMBER, KEY_PAYMENTTYPE, KEY_PLEXNAME, KEY_PMAUTHOBJECT, KEY_PURGEALLOWED, KEY_RECEIVEPAYMENTAUTOAPPROVE, KEY_RECEIVEPAYMENTAUTODEPOSIT, KEY_REFERENCENUMBER, KEY_RETURNATMOST, KEY_ROLE, KEY_ROLES, KEY_SOCKSHOST, KEY_SOCKSPORT, KEY_STATE, KEY_STATUS, KEY_SYSPLEXFLAG, KEY_TIMEREGISTERED, KEY_TRACEFILESIZE, KEY_TRACESETTING, KEY_TRANSACTIONID, KEY_USER, KEY_WITHCREDITS, KEY_WITHORDERS, KEY_WITHPAYMENTS, OP_ABOUT, OP_ACCEPTPAYMENT, OP_APPROVE, OP_APPROVEREVERSAL, OP_BATCHCLOSE, OP_BATCHOPEN, OP_BATCHPURGE, OP_CANCELORDER, OP_CASSETTECONTROL, OP_CLOSEORDER, OP_CREATE_ACCOUNT, OP_CREATE_MERCHANT, OP_CREATE_MERCHANTCASSETTEOBJECT, OP_CREATE_MEREVENTLISTENER, OP_CREATE_PAYSYSTEM, OP_CREATE_SNMEVENTLISTENER, OP_CREATE_SYSTEMCASSETTEOBJECT, OP_DELETE_ACCOUNT, OP_DELETE_MERCHANT, OP_DELETE_MERCHANTCASSETTEOBJECT, OP_DELETE_MEREVENTLISTENER, OP_DELETE_PAYSYSTEM, OP_DELETE_SNMEVENTLISTENER, OP_DELETE_SYSTEMCASSETTEOBJECT, OP_DELETEBATCH, OP_DEPOSIT, OP_DEPOSITREVERSAL, OP_MODIFY_ACCOUNT, OP_MODIFY_CASSETTE, OP_MODIFY_MERCHANT, OP_MODIFY_MERCHANTCASSETTEOBJECT, OP_MODIFY_MEREVENTLISTENER, OP_MODIFY_PAYSERVER, OP_MODIFY_PAYSYSTEM, OP_MODIFY_SNMEVENTLISTENER, OP_MODIFY_SYSPLEX, OP_MODIFY_SYSTEMCASSETTEOBJECT, OP_MODIFY_USERSTATUS, OP_QUERY_ACCOUNTS, OP_QUERY_CASSETTES, OP_QUERY_EVENTLISTENERS, OP_QUERY_MERCHANTS, OP_QUERY_PAYSERVER, OP_QUERY_PAYSYSTEMS, OP_QUERY_SYSPLEX, OP_QUERY_USERS, OP_QUERYBATCHES, OP_QUERYCREDITS, OP_QUERYORDERS, OP_QUERYPAYMENTS, OP_RECEIVEPAYMENT, OP_REFUND, OP_REFUNDREVERSAL, OP_SET_USERACCESSRIGHTS, OP_START, OP_STOP, ORDERSTATE_CANCELED, ORDERSTATE_CLOSED, ORDERSTATE_ORDERED, ORDERSTATE_PENDING, ORDERSTATE_REFUNDABLE, ORDERSTATE_REJECTED, ORDERSTATE_REQUESTED, PAYMENTSTATE_APPROVALEXPIRED, PAYMENTSTATE_APPROVED, PAYMENTSTATE_CLOSED, PAYMENTSTATE_DECLINED, PAYMENTSTATE_DEPOSITED, PAYMENTSTATE_PENDING, PAYMENTSTATE_RESET, PAYMENTSTATE_VOID, PD_AUTHCODE, PD_AUXILIARY1, PD_AUXILIARY2, PD_AVS_CITY, PD_AVS_COUNTRYCODE, PD_AVS_LOCATIONID, PD_AVS_POSTALCODE, PD_AVS_PREFIX, PD_AVS_STATEPROV, PD_AVS_STATEPROVINCE, PD_AVS_STREETADDR, PD_AVS_STREETADDRESS, PD_AVSCODE, PD_BATCHCLOSETIME, PD_BILL_CITY, PD_BILL_COUNTRYCOD, PD_BILL_COUNTRYCODE, PD_BILL_POSTALCODE, PD_BILL_PREFIX, PD_BILL_STATEPROV, PD_BILL_STATEPROVINCE, PD_BILL_STREETADDR, PD_BILL_STREETADDRESS, PD_BRAND, PD_BUYERNAME, PD_CARDHOLDERNAME, PD_CARDVERIFYCODE, PD_CHECKINGACCOUNTNUMBER, PD_CHECKROUTINGNUMBER, PD_CITY, PD_COUNTRYCODE, PD_CURRENCY, PD_DECLINECODE, PD_DECLINEREASON, PD_EMAILADDRESS, PD_EXPIRY, PD_FIBATCHID, PD_ITEM_COMMODITYCODE, PD_ITEM_DESCRIPTOR, PD_ITEM_DISCOUNTAMOUNT, PD_ITEM_DISCOUNTINDICATOR, PD_ITEM_LOCALTAXAMOUNT, PD_ITEM_LOCALTAXRATE, PD_ITEM_NATIONALTAXAMOUNT, PD_ITEM_NATIONALTAXRATE, PD_ITEM_NATIONALTAXTYPE, PD_ITEM_NETCOST, PD_ITEM_OTHERTAXAMOUNT, PD_ITEM_PRODUCTCODE, PD_ITEM_QUANTITY, PD_ITEM_SKU, PD_ITEM_TOTALCOST, PD_ITEM_UNITCOST, PD_ITEM_UNITOFMEASURE, PD_MAXBATCHSIZE, PD_METHOD, PD_PAN, PD_PCARD_ALTERNATETAXID, PD_PCARD_CUSTOMERDUTYTARIFFREFERENCE, PD_PCARD_CUSTOMERREFERENCENUMBER, PD_PCARD_CUSTOMERSERVICEPHONE, PD_PCARD_DISCOUNTAMOUNT, PD_PCARD_DUTYAMOUNT, PD_PCARD_DUTYREFERENCE, PD_PCARD_LOCALTAXAMOUNT, PD_PCARD_MERCHANTCITYCODE, PD_PCARD_MERCHANTCOUNTRYCODE, PD_PCARD_MERCHANTDUTYTARIFFREFERENCE, PD_PCARD_MERCHANTLOCATIONID, PD_PCARD_MERCHANTNAME, PD_PCARD_MERCHANTORDERNUMBER, PD_PCARD_MERCHANTPOSTALCODE, PD_PCARD_MERCHANTSTATEPROVINCE, PD_PCARD_MERCHANTTAXID, PD_PCARD_MERCHANTTYPE, PD_PCARD_NATIONALTAXAMOUNT, PD_PCARD_NATIONALTAXINVOICEREFERENCE, PD_PCARD_NATIONALTAXRATE, PD_PCARD_ORDERSUMMARY, PD_PCARD_OTHERTAXAMOUNT, PD_PCARD_PRINTCUSTOMERSERVICEPHONENUMBER, PD_PCARD_SHIPFROMCITYCODE, PD_PCARD_SHIPFROMCOUNTRYCODE, PD_PCARD_SHIPFROMLOCATIONID, PD_PCARD_SHIPFROMPOSTALCODE, PD_PCARD_SHIPFROMSTATEPROVINCE, PD_PCARD_SHIPPINGAMOUNT, PD_PCARD_SHIPPINGNATIONALTAXAMOUNT, PD_PCARD_SHIPPINGNATIONALTAXRATE, PD_PCARD_SHIPTOCITYCODE, PD_PCARD_SHIPTOCOUNTRYCODE, PD_PCARD_SHIPTOLOCATIONID, PD_PCARD_SHIPTOPOSTALCODE, PD_PCARD_SHIPTOSTATEPROVINCE, PD_PCARD_SUMMARYCOMMODITYCODE, PD_PCARD_TAXEXEMPTINDICATOR, PD_PCARD_TOTALTAXAMOUNT, PD_PHONENUMBER, PD_POSTALCODE, PD_SHIP_CITY, PD_SHIP_COUNTRYCOD, PD_SHIP_COUNTRYCODE, PD_SHIP_POSTALCODE, PD_SHIP_PREFIX, PD_SHIP_STATEPROV, PD_SHIP_STATEPROVINCE, PD_SHIP_STREETADDR, PD_SHIP_STREETADDRESS, PD_STATEPROVINCE, PD_STREETADDRESS, PD_STREETADDRESS2

Constructor Summary

Constructors
Constructor and Description
`PaymentServerRequest(java.lang.String destination, java.lang.String command, java.util.Hashtable keywordValuePairs, byte[] pmAuthObject, java.lang.String dtdPath, java.util.Hashtable userHeaderFields)` Deprecated. Create a Commerce Payments request object,
`PaymentServerRequest(java.lang.String destination, java.lang.String command, java.util.Hashtable keywordValuePairs, java.lang.String basicAuthUserid, java.lang.String basicAuthPassword, java.lang.String dtdPath, java.util.Hashtable userHeaderFields)` Deprecated. Create a Commerce Payments request object,

Method Summary

Methods
Modifier and Type	Method and Description
`byte[]`	`getBytes()` Deprecated. Retrun a byte array of the request.
`static java.lang.String`	`urlEncode(java.lang.String s)` Deprecated. Encode the input string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PaymentServerRequest
```
public PaymentServerRequest(java.lang.String destination,
                    java.lang.String command,
                    java.util.Hashtable keywordValuePairs,
                    java.lang.String basicAuthUserid,
                    java.lang.String basicAuthPassword,
                    java.lang.String dtdPath,
                    java.util.Hashtable userHeaderFields)
                     throws java.io.UnsupportedEncodingException
```
    Deprecated.
    
    Create a Commerce Payments request object,
    
    Parameters:
    
    destination - -- hostname.
    
    command - -- command name.
    
    keywordValuePairs - -- keyword and value pairs of the command.
    
    basicAuthUserid - -- user id for the basic authorization.
    
    basicAuthPassword - -- password for the basic authorization.
    
    dtdpath - -- The location of the dtd.
    
    userHeaderFields - -- header field information.
    
    Throws:
    
    java.io.UnsupportedEncodingException - If the encoding is not supported, a Java exception will be thrown.
  - PaymentServerRequest
```
public PaymentServerRequest(java.lang.String destination,
                    java.lang.String command,
                    java.util.Hashtable keywordValuePairs,
                    byte[] pmAuthObject,
                    java.lang.String dtdPath,
                    java.util.Hashtable userHeaderFields)
                     throws java.io.UnsupportedEncodingException
```
    Deprecated.
    
    Create a Commerce Payments request object,
    
    Parameters:
    
    destination - -- hostname.
    
    command - -- command name.
    
    keywordValuePairs - -- keyword and value pairs of the command.
    
    pmAuthObject - -- byte array authentication object
    
    dtdpath - -- The location of the dtd.
    
    userHeaderFields - -- header field information.
    
    Throws:
    
    java.io.UnsupportedEncodingException - If the encoding is not supported, a Java exception will be thrown.
- Method Detail
  - getBytes
```
public byte[] getBytes()
```
    Deprecated.
    
    Retrun a byte array of the request.
  - urlEncode
```
public static java.lang.String urlEncode(java.lang.String s)
```
    Deprecated.
    
    Encode the input string. Encode the input string by the encoding convention descripted in the Commerce Payments Programmer's Guide. The encoding is similar with the URL encoding.

Class PaymentServerRequest

Field Summary

Fields inherited from interface com.ibm.etill.framework.clientapi.PaymentCommandConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentServerRequest

PaymentServerRequest

Method Detail

getBytes

urlEncode