com.ezic.direct
Class V3Client.Request

java.lang.Object
  |
  +--java.util.Dictionary
        |
        +--java.util.Hashtable
              |
              +--com.ezic.util.StringHash
                    |
                    +--com.ezic.direct.V3Client.Request

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map, java.io.Serializable

Enclosing class:

V3Client

public static class V3Client.Request

extends StringHash

This class defines a Request object, used to send transaction parameters to the server. All parameters are stored as String attributes, with String values. Use the set(attr,val) method to set attributes. All currently defined parameters are made available as String constants, Request.ACCOUNT_ID etc. Future or custom parameter names can be specified as plain Strings without upgrading the client software if necessary. For example, the following 2 statements:

request.set (Request.ACCOUNT_ID, "123456789012");
request.set ("account_id", "123456789012");

are functionally identical. It's a good idea to use the predefined String constants, to avoid hard-to-find errors due to misspelled parameter names.

See Also:

V3Client.doTrans(com.ezic.direct.V3Client.Request, com.ezic.direct.V3Client.Response), Serialized Form

Inner classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

static java.lang.String	ACCOUNT_ID "account_id" protocol parameter.
static java.lang.String	ACH_ACCOUNT "account_number" protocol parameter.
static java.lang.String	AMOUNT "amount" protocol parameter.
static java.lang.String	BILL_BIRTH_DATE "bill_birth_date" protocol parameter.
static java.lang.String	BILL_CITY "bill_city" protocol parameter.
static java.lang.String	BILL_COUNTRY "bill_country" protocol parameter.
static java.lang.String	BILL_NAME1 "bill_name1" protocol parameter.
static java.lang.String	BILL_NAME2 "bill_name2" protocol parameter.
static java.lang.String	BILL_PHOTO_ID_NUMBER "bill_photo_id_no" protocol parameter.
static java.lang.String	BILL_PHOTO_ID_STATE "bill_photo_id_state" protocol parameter.
static java.lang.String	BILL_STATE "bill_state" protocol parameter.
static java.lang.String	BILL_STREET "bill_street" protocol parameter.
static java.lang.String	BILL_TAX_ID_NUMBER "bill_tax_id_no" protocol parameter.
static java.lang.String	BILL_ZIP "bill_zip" protocol parameter.
static java.lang.String	CARD_CVV2 "card_cvv2" protocol parameter.
static java.lang.String	CARD_EXPIRE "card_expire" protocol parameter.
static java.lang.String	CARD_NUMBER "card_number" protocol parameter.
static java.lang.String	CARD_TRACK1 "card_track1" protocol parameter.
static java.lang.String	CARD_TRACK2 "card_track2" protocol parameter.
static java.lang.String	CISP_STORAGE "cisp_storage" protocol parameter.
static java.lang.String	COURIER_TRACKING "courier_tracking" protocol parameter.
static java.lang.String	CUSTOMER_BROWSER "cust_browser" protocol parameter.
static java.lang.String	CUSTOMER_EMAIL "cust_email" protocol parameter.
static java.lang.String	CUSTOMER_HOST "cust_host" protocol parameter.
static java.lang.String	CUSTOMER_IP "cust_ip" protocol parameter.
static java.lang.String	CUSTOMER_PHONE "cust_phone" protocol parameter.
static java.lang.String	DESCRIPTION "description" protocol parameter.
static java.lang.String	DISABLE_AVS "disable_avs" protocol parameter.
static java.lang.String	DISABLE_CVV2 "disable_cvv2" protocol parameter.
static java.lang.String	DISABLE_FRAUD_CHECKS "disable_fraud_checks" protocol parameter.
static java.lang.String	DISABLE_NEGATIVE_DB "disable_negative_db" protocol parameter.
static java.lang.String	DYNIP_SEC_CODE "dynip_sec_code" protocol parameter.
static java.lang.String	FORCE_CODE "force_code" protocol parameter.
static java.lang.String	HOTEL_CHECKIN_DATE "hotel_checkin_date" protocol parameter.
static java.lang.String	HOTEL_CHECKOUT_DATE "hotel_checkout_date" protocol parameter.
static java.lang.String	HOTEL_FLAGS "hotel_flags" protocol parameter.
static java.lang.String	HOTEL_ROOM_RATE "hotel_room_rate" protocol parameter.
static java.lang.String	MCC_OVERRIDE "mcc_override" protocol parameter.
static java.lang.String	MEMBER_DURATION "member_duration" protocol parameter.
static java.lang.String	MEMBER_MEMO "member_memo" protocol parameter.
static java.lang.String	MEMBER_PASSWORD "member_password" protocol parameter.
static java.lang.String	MEMBER_USERNAME "member_username" protocol parameter.
static java.lang.String	MISC_INFO "misc_info" protocol parameter.
static java.lang.String	ORIG_ID "orig_id" protocol parameter.
static java.lang.String	PAY_TYPE "pay_type" protocol parameter.
static java.lang.String	PURCHASE_ORDER "purch_order" protocol parameter.
static java.lang.String	RECURRING_AMOUNT "recurring_amount" protocol parameter.
static java.lang.String	RECURRING_COUNT "recurring_count" protocol parameter.
static java.lang.String	RECURRING_PERIOD "recurring_period" protocol parameter.
static java.lang.String	RECURRING_PRORATE "recurring_prorate" protocol parameter.
static java.lang.String	SHIP_AMOUNT "ship_amount" protocol parameter.
static java.lang.String	SHIP_CITY "ship_city" protocol parameter.
static java.lang.String	SHIP_COUNTRY "ship_country" protocol parameter.
static java.lang.String	SHIP_NAME "ship_name1" protocol parameter.
static java.lang.String	SHIP_NAME2 "ship_name2" protocol parameter.
static java.lang.String	SHIP_STATE "ship_state" protocol parameter.
static java.lang.String	SHIP_STREET "ship_street" protocol parameter.
static java.lang.String	SHIP_ZIP "ship_zip" protocol parameter.
static java.lang.String	SITE_TAG "site_tag" protocol parameter.
static java.lang.String	TAX_AMOUNT "tax_amount" protocol parameter.
static java.lang.String	THREE_3_SEC_XID "3ds_xid" protocol parameter.
static java.lang.String	THREE_D_SEC_CAVV "3ds_cavv" protocol parameter.
static java.lang.String	TRAN_TYPE "tran_type" protocol parameter.
static java.lang.String	TRANS_ID "trans_id" protocol parameter.
static java.lang.String	USER_DATA "user_data" protocol parameter.

Constructor Summary

V3Client.Request()

V3Client.Request(V3Client.Request copy_me)

Methods inherited from class com.ezic.util.StringHash

get, nvl, set

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PAY_TYPE

public static final java.lang.String PAY_TYPE

"pay_type" protocol parameter. Required for new transactions. 1 letter code: "C" for credit cards, "K" for ach/checks, "S" for stored value cards

TRAN_TYPE

public static final java.lang.String TRAN_TYPE

"tran_type" protocol parameter. Always Required. 1 letter code: "A"uth, "S"ale, "R"efund, "C"redit, "D"=Convert prior Auth to Sale

ACCOUNT_ID

public static final java.lang.String ACCOUNT_ID

"account_id" protocol parameter. Always Required. 12 digit account id (assigned to you)

SITE_TAG

public static final java.lang.String SITE_TAG

"site_tag" protocol parameter. Recommended. Alpha numeric, upper case. Additional site tags can be setup within online administration system. When using subscription/membership a list of multiple comma separated site tags can be specified. The first one will be the primary site tag.

DYNIP_SEC_CODE

public static final java.lang.String DYNIP_SEC_CODE

"dynip_sec_code" protocol parameter. Required only for clients with dynamic IP. Used to authenticate client when the IP address is unknown.

TRANS_ID

public static final java.lang.String TRANS_ID

"trans_id" protocol parameter. Recommended. 12 digit id, obtained using obtainNewId().

This parameter is optional, but highly recommended. If you do not send it, you will be unable to check the status of a transaction in case you fail to receive a response immediately due to network problems.

NOTE: You must NEVER send a value that you did not previously obtain using obtainNewId(). The same value cannot be used more than once.

See Also:

V3Client.obtainNewId()

ORIG_ID

public static final java.lang.String ORIG_ID

"orig_id" protocol parameter. Required for refunds and auth conversion. 12 digit id, returned in response to original transaction.

CARD_NUMBER

public static final java.lang.String CARD_NUMBER

"card_number" protocol parameter. Required for new card transactions (unless card track data is sent instead.) Numeric card number, no spaces or dashes.

CARD_TRACK1

public static final java.lang.String CARD_TRACK1

"card_track1" protocol parameter. Recommended for retail applications. Full card data read from magnetic stripe (including leading '%' and trailing '?')

CARD_TRACK2

public static final java.lang.String CARD_TRACK2

"card_track2" protocol parameter. Recommended for retail applications, but use track1 instead if available. Full card data read from magnetic stripe (including leading ';' and trailing '?')

CARD_EXPIRE

public static final java.lang.String CARD_EXPIRE

"card_expire" protocol parameter. Required for new card transactions (unless card track data is sent instead.) 4 digit MMYY format, no slash or spaces.

CARD_CVV2

public static final java.lang.String CARD_CVV2

"card_cvv2" protocol parameter. Recommended for new card transactions. 3 or 4 digits. For retail aoplications, the lowercase litteral "none" can be sent to indicate that there is no code inprinted on the card. "gone" can be sent to indicate that the code has rubbed off.

THREE_D_SEC_CAVV

public static final java.lang.String THREE_D_SEC_CAVV

"3ds_cavv" protocol parameter. Required when using Verified by Visa(tm), aka 3D Secure. Format: 40 hexadecimal digits in ASCII, encoding a 20 byte binary value, or 28 characters of Base64 code.

THREE_3_SEC_XID

public static final java.lang.String THREE_3_SEC_XID

"3ds_xid" protocol parameter. Optional. Format: 40 hexadecimal digits in ASCII, encoding a 20 byte binary value, or 28 characters of Base64 code.

FORCE_CODE

public static final java.lang.String FORCE_CODE

"force_code" protocol parameter. Optional. Used when processing a voice authorized transaction.

ACH_ACCOUNT

public static final java.lang.String ACH_ACCOUNT

"account_number" protocol parameter. Required for new ACH transactions. Format: 9 digit routing/ABA number, a colon, and the account number as printed on the bottom of a check.

CISP_STORAGE

public static final java.lang.String CISP_STORAGE

"cisp_storage" protocol parameter. Set this flag to "1" to indicate that this transactions should be stored securely, and be accessible for future repeat billing. In order to issue another transaction on this card in the future, use "CS:trans_id:last5digits" as the card number for the future transaction, where trans_id is the id returned for the original transaction, and last5digits (optional) is the last 5 digits of the card number.

DISABLE_AVS

public static final java.lang.String DISABLE_AVS

"disable_avs" protocol parameter. Set this flag to "1" to disable AVS (Address Verification System) for this transaction.

DISABLE_CVV2

public static final java.lang.String DISABLE_CVV2

"disable_cvv2" protocol parameter. Set this flag to "1" to disable CVV2 (Card Verification Value 2) for this transaction.

DISABLE_FRAUD_CHECKS

public static final java.lang.String DISABLE_FRAUD_CHECKS

"disable_fraud_checks" protocol parameter. Set this flag to "1" to disable all fraud protoection other than AVS/CVV2. This implies "disable_negative_db" = 1.

DISABLE_NEGATIVE_DB

public static final java.lang.String DISABLE_NEGATIVE_DB

"disable_negative_db" protocol parameter. Set this flag to "1" to disable only the negative database component of the fraud protoection system.

AMOUNT

public static final java.lang.String AMOUNT

"amount" protocol parameter. Required for new transactions, optional for Refunds and Conversions. Only digits and a decimal point is allowed. No commas, currency signs or negative signs.

TAX_AMOUNT

public static final java.lang.String TAX_AMOUNT

"tax_amount" protocol parameter. Optional, but required for Level-2 commercial card processing.

SHIP_AMOUNT

public static final java.lang.String SHIP_AMOUNT

"ship_amount" protocol parameter. Optional, but required for Level-2 commercial card processing.

PURCHASE_ORDER

public static final java.lang.String PURCHASE_ORDER

"purch_order" protocol parameter. Optional, but required for Level-2 commercial card processing. Commercial purchase order. 17 characters maximum.

BILL_NAME1

public static final java.lang.String BILL_NAME1

"bill_name1" protocol parameter. Required for new transactions. The first name of the paying party,

BILL_NAME2

public static final java.lang.String BILL_NAME2

"bill_name2" protocol parameter. Required for new transactions. The last name of the paying party,

BILL_STREET

public static final java.lang.String BILL_STREET

"bill_street" protocol parameter. Required for new transactions. The street address of the paying party.

BILL_CITY

public static final java.lang.String BILL_CITY

"bill_city" protocol parameter. Recommended for new transactions. The city of the paying party. This along with other components of the address are used for propriatary address validation by the fraud protection system.

BILL_STATE

public static final java.lang.String BILL_STATE

"bill_state" protocol parameter. Recommended for new transactions. The 2 letter US state code, or foreign province names of the paying party.

BILL_ZIP

public static final java.lang.String BILL_ZIP

"bill_zip" protocol parameter. Required for new transactions. The 5 or 9 digit US zip code or foreign postal code of the paying party. Format: "55555" or "55555-4444" for US zip codes.

BILL_COUNTRY

public static final java.lang.String BILL_COUNTRY

"bill_country" protocol parameter. Recommended for new transactions. The 2 letter ISO3166 country code. "US" for the United States, "GB" for the United Kingdom, etc. See http://www.iso.org/iso/en/prods-services/iso3166ma/index.html

BILL_PHOTO_ID_NUMBER

public static final java.lang.String BILL_PHOTO_ID_NUMBER

"bill_photo_id_no" protocol parameter. Recommended for new ACH transactions. State driver's license or photo ID number, used for ACH verification.

BILL_PHOTO_ID_STATE

public static final java.lang.String BILL_PHOTO_ID_STATE

"bill_photo_id_state" protocol parameter. Recommended for new ACH transactions. The 2 letter state code of the state that issued the ID card. "US" for Federal IDs.

BILL_TAX_ID_NUMBER

public static final java.lang.String BILL_TAX_ID_NUMBER

"bill_tax_id_no" protocol parameter. Recommended for new ACH transactions. Tax ID or Social Security number of the paying party. Format: 333-22-4444 for SS#, 22-7777777 for TID#.

BILL_BIRTH_DATE

public static final java.lang.String BILL_BIRTH_DATE

"bill_birth_date" protocol parameter. Recommended for new ACH transactions. YYYY-MM-DD format.

SHIP_NAME

public static final java.lang.String SHIP_NAME

"ship_name1" protocol parameter. Optional. The first name of the shipping recipient.

SHIP_NAME2

public static final java.lang.String SHIP_NAME2

"ship_name2" protocol parameter. Optional. The last name of the shipping recipient.

SHIP_STREET

public static final java.lang.String SHIP_STREET

"ship_street" protocol parameter. Optional. The 2 letter US state code, or foreign province names of the shipping recipient.

SHIP_CITY

public static final java.lang.String SHIP_CITY

"ship_city" protocol parameter. Optional. The city of the shipping recipient.

SHIP_STATE

public static final java.lang.String SHIP_STATE

"ship_state" protocol parameter. Optional. The 2 letter US state code, or foreign province names of the shipping recipient.

SHIP_ZIP

public static final java.lang.String SHIP_ZIP

"ship_zip" protocol parameter. Optional. The 5 or 9 digit US zip code or foreign postal code of the shipping recipient. Format: "55555" or "55555-4444" for US zip codes.

SHIP_COUNTRY

public static final java.lang.String SHIP_COUNTRY

"ship_country" protocol parameter. Optional. The 2 letter ISO3166 country code. "US" for the United States, "GB" for the United Kingdom, etc. See http://www.iso.org/iso/en/prods-services/iso3166ma/index.html

COURIER_TRACKING

public static final java.lang.String COURIER_TRACKING

"courier_tracking" protocol parameter. Optional. The courier FEDEX, UPS, USPS, TNT, or DHL followed by a colon, and the tracking number (no spaces)

CUSTOMER_EMAIL

public static final java.lang.String CUSTOMER_EMAIL

"cust_email" protocol parameter. Recommended for new transactions. The email address of the customer in user@domain.com format.

CUSTOMER_PHONE

public static final java.lang.String CUSTOMER_PHONE

"cust_phone" protocol parameter. Recommended for new transactions. The phone number of the customer.

CUSTOMER_IP

public static final java.lang.String CUSTOMER_IP

"cust_ip" protocol parameter. Recommended for new transactions. The IP address of the customer for web originating transactions.

CUSTOMER_HOST

public static final java.lang.String CUSTOMER_HOST

"cust_host" protocol parameter. Optional. The resolved DNS host name of the customer for web originating transactions.

CUSTOMER_BROWSER

public static final java.lang.String CUSTOMER_BROWSER

"cust_browser" protocol parameter. Optional. The User-Agent customer browser header for web originating transactions.

DESCRIPTION

public static final java.lang.String DESCRIPTION

"description" protocol parameter. Recommended for new transactions. A description or order reference for the order. 4000 characters max.

USER_DATA

public static final java.lang.String USER_DATA

"user_data" protocol parameter. Optional. Arbitrary user data that will be stored by the system. 4000 characters max. It can be used to store attribute value pairs, separated by newline (\n) characters. For example:

Customer-Number: 1234
Order-Number: 123

MISC_INFO

public static final java.lang.String MISC_INFO

"misc_info" protocol parameter. Optional. Arbitrary miscellaneous information that will be stored by the system. 4000 characters max.

HOTEL_CHECKIN_DATE

public static final java.lang.String HOTEL_CHECKIN_DATE

"hotel_checkin_date" protocol parameter. Required for hotel transactions. Checkin or reservation date in YYYY-MM-DD format.

HOTEL_CHECKOUT_DATE

public static final java.lang.String HOTEL_CHECKOUT_DATE

"hotel_checkout_date" protocol parameter. Required for hotel transactions. Checkout or expected checkout date in YYYY-MM-DD format.

MCC_OVERRIDE

public static final java.lang.String MCC_OVERRIDE

"mcc_override" protocol parameter. Optional. A 4 digit MCC code (merchant catagory code), if different from the default MCC of the account for hotel transactions, such as a gift store purchase.

HOTEL_FLAGS

public static final java.lang.String HOTEL_FLAGS

"hotel_flags" protocol parameter. Optional. Use of more of the following flags to specify additional information for a hotel transaction.

"G" - This transaction includes Gift ship purchases
"L" - This transaction includes payment for Laundry services
"M" - This transaction includes payment for Mini-bar purchases
"T" - This transaction includes payment for Telephone charges
"R" - This transaction includes payment for Restaurant purchases
"O" - This transaction includes payment for other services, such as Spa or Room service.
"N" - This transaction was for a No-show reservation

When specifying multiple codes, simply group them together without spaces. The order is not important.

HOTEL_ROOM_RATE

public static final java.lang.String HOTEL_ROOM_RATE

"hotel_room_rate" protocol parameter. Required for hotel transactions. The daily room rate. No commas or spaces.

MEMBER_USERNAME

public static final java.lang.String MEMBER_USERNAME

"member_username" protocol parameter. Required when initiating a new subscriber/member.

MEMBER_PASSWORD

public static final java.lang.String MEMBER_PASSWORD

"member_password" protocol parameter. The password the new subscriber will use to access your membership website. Required if this subscription is for a website. Examples of non-web based subscriptions include magazines and club memberships.

MEMBER_DURATION

public static final java.lang.String MEMBER_DURATION

"member_duration" protocol parameter. Required when initiating a new subscriber/member. Specified in number of days. Fractional days are allowed, for example 1.5 days equals 36 hours.

MEMBER_MEMO

public static final java.lang.String MEMBER_MEMO

"member_memo" protocol parameter. Optional memo field to attach to a new subscriber/member record.

RECURRING_AMOUNT

public static final java.lang.String RECURRING_AMOUNT

"recurring_amount" protocol parameter. Required when initiating a new subscriber/member with recurring billing.

RECURRING_PERIOD

public static final java.lang.String RECURRING_PERIOD

"recurring_period" protocol parameter. Required when initiating a new subscriber/member with recurring billing. Normally this is specified as a number of days, but special expressions can also be used. For example "last_day(sysdate)+1" would execute a recurring billing on the 1st day of every month. See the output of the Button maker/editor utility within the online administration interface for other special expressions.

RECURRING_COUNT

public static final java.lang.String RECURRING_COUNT

"recurring_count" protocol parameter. Optional. Used to specify how many times a subscriber should be billed in additional to the initial transaction. The default is no limit.

RECURRING_PRORATE

public static final java.lang.String RECURRING_PRORATE

"recurring_prorate" protocol parameter. Only used together with special recurring_period expressions. When set to "true", the next recurring billing will occur either at the end of the initial membership period (member_duration), or at the next matching recurring_period special expression, whichever is sooner. The amount of the first recurring billing will be be reduced based on how many days early the recurring billing occured compared to the number of days specified in member_duration.

Constructor Detail

V3Client.Request

public V3Client.Request()

V3Client.Request

public V3Client.Request(V3Client.Request copy_me)