1. Inputs
2. Outputs
a. Basic Result Set
b. Batch Result Set
c. Transactions Result Set



Inputs

NAME Required. This contains the name of the query that will contain the result set consisting of all the parameters returned by CyberCash Cash Register.
PS_HOST Required. This is the fully qualified name of the machine that's running the CyberCash Cash Register e.g. milkyway.ntinternet.com. It can also be the IP address in dot notation e.g. 205.252.71.192 - your System Administrator (or your ISP's technical support) can give this to you.
PS_PORT Required. This is the port number where the Payment Server component of the CyberCash Cash Register is listening for requests. At most installations this will be 8000 - however, check with your system administrator (or your ISP) to be sure.
PS_SECRET Required. This is the unique identifier which identifies your merchant account at the CyberCash Cash Register installation.
TRANS_TYPE Required. This parameter allows you to select the type of transaction that you want to process. It can be either one of the following:-
  • mauthonly
  • mauthcapture
  • checkauth
  • capture
  • void
  • return
  • batch-commit
  • unmark
  • credit
  • checkreturn
ORDER_ID Required for all transaction types except "batch-commit". This is an order id number that must be unique each time. This is used to track individual transactions in CyberCash. It can contain any alphanumeric string.
AMOUNT Required for "checkauth", "mauthonly", and "mauthcapture" transactions; Optional for "return" and "credit" transactions, and not required for "void", "unmark" or "batch-commit" transaction. This is the amount of transaction in US dollars.
CC_NUMBER Required for "checkauth", "mauthonly" and "mauthcapture" transactions only. For "checkauth" transaction this is the MICR checking or savings account number as printed on the checks. For "mauthonly" and "mauthcapture" transactions, this is the credit card number for the transaction. The given amount will be charged to this credit card. Any spaces or dashes are stripped.
CC_EXP Required for "mauthonly" and "mauthcapture" transactions only. This is the expiration date for the credit card in the format "mm/yy".
CC_NAME Optional. This contains the name of the card holder. If given, this will be used for Address Verification and the avs_code output parameter will be set to indicate the result.
CC_ADDRESS Optional. This is the address of the card holder.If given, this will be used for Address Verification and the avs_code output parameter will be set to indicate the result.
CC_CITY Optional. This contains the city of the credit card holder. If given, this will be used for Address Verification and the avs_code output parameter will be set to indicate the result.
CC_STATE Optional. State of card holder. If given, this will be used for Address Verification and the avs_code output parameter will be set to indicate the result.
CC_ZIP Optional. ZIP code of card holder. If given, this will be used for Address Verification and the avs_code output parameter will be set to indicate the result.
CC_COUNTRY Optional. Country of card holder. If given, this will be used for Address Verification and the avs_code output parameter will be set to indicate the result.
QUERY Required for "batch-commit", not used for any other transaction. This parameter contains the name of the query containing all the order-id that are to be settled by the Batch process for batching type processors such as fdc.
ORDER_ID_COLUMN Optional. Only used for "batch-commit" transaction. This indicates the position of the field that contains the "order-id" of the transaction that is to be settled in the QUERY that is passed in. Default value for this parameter is 1. For example if the query that is being passed in is "select date, type, order-id, amount, status, vendor from transactions", then the value for ORDER_ID_COLUMN should be 3.
AMOUNT_COLUMN Optional. Only used for "batch-commit" transaction. This indicates the position of the field that contains the "amount" of the transaction that is to be settled in the QUERY that is passed in. Default value for this parameter is 2. For example if the query that is being passed in is "select date, type, order-id, amount, status, vendor from transactions", then the value for AMOUNT_COLUMN should be 4.
BATCH Optional. Used only for "batch-commit" transaction. This parameter provides the name of the query that will be hold the result set of batch parameters returned by CyberCash Cash Register such as batch-status, batch-id. Please refer to Outputs section for details of all the fields that are returned.
TRANSACTIONS Optional. Used only for "batch-commit" transaction. This parameter provides the name of the query that will be hold the result set containing status and response code for individual transactions submitted in a batch. Please refer to Outputs section for details of all the fields that are returned.


Outputs
Three sets of output result sets are possible when using CFX_ONCR_CYBERCASH to process transactions. One, two or all three sets will be returned depending on the transaction selected and the parameters passed in. Following are the result sets returned by the tag -
Basic Result Set   Always returned for all transactions. The name of this result set is given in the "NAME" parameter to the tag.
Batch Result Set   Optionally returned for batch-commit transaction only. The name of this result set is specified in the "BATCH" optional parameter to the tag.
Transactions Result Set   Optionally returned for batch-commit transaction only. The name of this result set is specified in the "TRANSACTION" optional parameter to the tag.


Basic Result Set
Status Status of the transaction, possible values are -"success", "success-duplicate", "success-partial", "failure-hard", "failure-q-or-cancel", "failure-q-or-discard", "failure-sw-version", or "failure-bad-money".
OrderID Order ID as passed into the transaction.
CardNumber Truncated version of the card number string. This will be in the form ##*#### - i.e. first 2 digits a '*' and the last 4 digits.
CardType Indicates the type of the given card. Possible values are "ot" (other), "ax" (amex), "cb" (carte blanche), "dc" (diners club), "ds" (discover), "mc" (mastercard), "vs" (visa), "ecp-savings" (paytech check service, savings account), and "ecp-checking" (Paytech check service, checking).
CardExp Card Expiration Date expressed in the format mm/yyyy
CustomerTransaction Customer transaction number.
MerchantTransaction Merchant Transaction Number.
AuthNumber Approval Code returned by CyberCash.
ActionCode A code returned by the bank that's approving the transaction - many values are possible depending on the bank that issued the card, and the merchant account processor.
AVSCode Address Verification Code as returned by CyberCash. This field is not supported by all processors. Please check the documentation at CyberCash's site for details on this.
ErrorLocation In case of errors, this will contain the location where the error occured.
ErrorMessage In case of errors, this will contain the detailed error message as returned by CyberCash.
AuxMessage Any additional message returned by the Financial Institution processing the card.
SWErrorMessage Returned by CyberCash Gateway in case of software version mismatches or software configuration problems. Please note that a transaction may succeed despite a mismatch in software versions.
ReferenceCode A reference number returned by cybercash in some cases.


Batch Result Set
Status Status of the entire batch as reported by the CyberCash Gateway.
ID Merchant Batch ID for later reference.
GWBatchID CyberCash Gateway Batch ID.
TotalAmount Net amount for the whole batch. Sales are counted as positive numbers, credits are counted as negative numbers.
SalesAmount Total sales for all card types.
SalesAmex Total sales for American Express.
SalesCarte Total sales for Carte Blanche.
SalesDiners Total sales for Diners Club.
SalesDiscover Total sales for Discover
SalesECP Total sales for ECP checks.
SalesJCB Total sales for JCB.
SalesMC Total sales for MasterCard.
SalesOther Total sales for Other cards.
SalesVisa Total sales for Visa cards.
CreditAmount Total Credit for all card types.
CreditAmex Total Credit for American Express.
CreditCarte Total Credit for Carte Blanche.
CreditDiners Total Credit for Diners Club.
CreditDiscover Total Credit for Discover
CreditECP Total Credit for ECP checks.
CreditJCB Total Credit for JCB.
CreditMC Total Credit for MasterCard.
CreditOther Total Credit for Other cards.
CreditVisa Total Credit for Visa cards.


Transactions Result Set
OrderID Order ID as passed into the transaction.
MerchantTransaction Merchant transaction number.
ResponseCode Transaction Status.
ExceptionMessage Additional error message in case of errors.

ONCR Home