com.netbilling.direct
Class V3Client.Response

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable
          com.netbilling.util.StringHash
              com.netbilling.direct.V3Client.Response

All Implemented Interfaces:

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

Enclosing class:

V3Client

public static class V3Client.Response
extends StringHash

This class defines a Response object, used to obtain the transaction response from the server. All parameters are stored as String attributes, with String values. Use the val=get(attr) method to get attributes. All currently defined parameters are made available as String constants, Response.TRANS_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:

String trans_id = response.get (Response.TRANS_ID);
String trans_id = response.get ("trans_id");

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.netbilling.direct.V3Client.Request, com.netbilling.direct.V3Client.Response), Serialized Form

Field Summary

static java.lang.String	AUTH_CODE "auth_code" protocol parameter.
static java.lang.String	AUTH_DATE "auth_date" protocol parameter.
static java.lang.String	AUTH_MSG "auth_msg" protocol parameter.
static java.lang.String	AVS_CODE "avs_code" protocol parameter.
static java.lang.String	CVV2_CODE "cvv2_code" protocol parameter.
static java.lang.String	MEMBER_ID "member_id" protocol parameter.
static java.lang.String	REASON_CODE2 "reason_code2" protocol parameter.
static java.lang.String	RECURRING_ID "recurring_id" protocol parameter.
static java.lang.String	STATUS_CODE "status_code" protocol parameter.
static java.lang.String	TICKET_CODE "ticket_code" protocol parameter.
static java.lang.String	TRANS_ID "trans_id" protocol parameter.

Constructor Summary

V3Client.Response()

Method Summary

boolean

isSuccess() Returns true if the transaction was successful, false otherwise

Methods inherited from class com.netbilling.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

TRANS_ID

public static final java.lang.String TRANS_ID

"trans_id" protocol parameter. 12 digit transaction ID. If "trans_id" was supplied in the Request, the same code will be returned. If "trans_id" was not supplied in the Request, a unique server generated code will be returned.

See Also:

Constant Field Values

STATUS_CODE

public static final java.lang.String STATUS_CODE

"status_code" protocol parameter. 1 character status code.

"1" - Successful monetary transaction
"I" - Pending transaction, such as an unfunded ACH payment
"T" - Successful auth only transaction
"0" - Failed transaction. Consult "auth_msg" and "reason_code2"
"F" - Settlement failure. Not returned at authorization time
"D" - Duplicate transaction. The "trans_id" of the original transaction will be returned

Any unexpected code other than "0" and "F" should be interpreted as a successful transaction.

See Also:

for a convenient true/false test., Constant Field Values

AUTH_MSG

public static final java.lang.String AUTH_MSG

"auth_msg" protocol parameter. A human readable approval message, for example "APPROVED 123456", or "DECLINED 05". These messages are processor specific, and are not intended to be machine readable.

See Also:

Constant Field Values

AUTH_CODE

public static final java.lang.String AUTH_CODE

"auth_code" protocol parameter. A 6 digit bank authorization code for the transaction.

See Also:

Constant Field Values

AVS_CODE

public static final java.lang.String AVS_CODE

"avs_code" protocol parameter. 1 character AVS result code. See the AVS popup window in the online administration system for a list of codes.

See Also:

Constant Field Values

CVV2_CODE

public static final java.lang.String CVV2_CODE

"cvv2_code" protocol parameter. 1 character CVV2 result code. See the CVV2 popup window in the online administration system for a list of codes.

See Also:

Constant Field Values

TICKET_CODE

public static final java.lang.String TICKET_CODE

"ticket_code" protocol parameter. Typically not used. Processor specific additional transaction reference code.

See Also:

Constant Field Values

REASON_CODE2

public static final java.lang.String REASON_CODE2

"reason_code2" protocol parameter. Typically not used. Processor specific additional DECLINE-reason code. Consult the transaction details screen for a declined transaction in the online administration system for verbose reason code messages.

See Also:

Constant Field Values

AUTH_DATE

public static final java.lang.String AUTH_DATE

"auth_date" protocol parameter. This is the date and time in GMT (UTC) when the transaction was authorized by the system. YYYY-MM-DD HH:MM:SS format.

See Also:

Constant Field Values

MEMBER_ID

public static final java.lang.String MEMBER_ID

"member_id" protocol parameter. Returned when a new subscriber/member was added.

See Also:

Constant Field Values

RECURRING_ID

public static final java.lang.String RECURRING_ID

"recurring_id" protocol parameter. Returned when a recurring billing record was established for a new subscriber/member.

See Also:

Constant Field Values

Constructor Detail

V3Client.Response

public V3Client.Response()

Method Detail

isSuccess

public boolean isSuccess()

Returns true if the transaction was successful, false otherwise