The following response fields may be part of the return value for web services using transact.asmx operations. These web services include:
Applicable Web Services
• GetCardTrx
• GetCardTrxSummary
• GetCheckTrx
• GetOpenBatchSummary
Response Field Definitions:
|
Response Field |
Data Type |
Value Description |
Remarks |
|
Account_Type_CH |
A string value up to 10 characters |
Returns the card type of the transaction, e.g. VISA, Diners, EBT |
|
|
AccountNum_VC |
A string value up to 200 characters |
Returns the check account number |
This field will be masked out with asterisk (*) characters except for the last 4 digits if the System Security Level of the user is set to 1 |
|
Acct_Num_CH |
A string value up to 200 characters |
Returns credit card number |
This field will be masked out with asterisk (*) characters except for the last 4 digits if the System Security Level of the user is set to 1 |
|
Amount_MN |
A string value representing a signed 64-bit real number |
Returns the check’s total amount |
|
|
Approval_Code_CH |
A string value up to 50 characters |
Returns the response code from the payment processor |
|
|
Auth_Amt_MN |
A string value representing a signed 64-bit real number |
Returns the authorized amount of a card transaction |
|
|
Authorization |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all Authorization (PreAuth) transactions |
|
|
Authorization_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all Authorization (PreAuth) transactions |
|
|
AVS_Resp_CH |
A string value up to 1 character |
Returns the address verification result code from the payment processor |
|
|
AVS_Resp_Txt_VC |
A string value up to 25 characters |
Returns the formatted response message when address verification is performed |
|
|
Batch_Number |
A string value up to 10 characters |
Returns the batch number for the transaction that was returned by the payment processor |
Not all payment processors support returning this data element |
|
Capture |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all Capture transactions |
This value will always return “0” |
|
Capture_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all Capture transactions |
This value will always return “0” |
|
Card_Info_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the CC_Info_T table in the database |
|
|
Cash_Back_Amt_MN |
A string value representing a signed 64-bit real number |
Returns the cash back amount for a debit or EBT transaction |
|
|
CheckNum_CH |
A string value up to 10 characters |
Returns the check number |
|
|
Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all transactions |
|
|
CustomerID |
A string value up to 50 characters |
Returns the Customer ID of a customer to which the transaction belongs to |
|
|
CV_Resp_CH |
A string value up to 1 character |
Returns the card verification result code from the payment processor |
|
|
CV_Resp_Txt_VC |
A string value up to 25 characters |
Returns the formatted response message when card verification is performed |
|
|
Date_DT |
A string value representing a date and time |
Returns the date on which the transaction is first made |
|
|
ERROR |
A string value up to 200 characters |
Returns an error message when a problem occurs during the transaction processing |
|
|
Exp_CH |
A string value up to 10 characters |
Returns the credit card expiration date |
|
|
ForceCapture |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all ForceCapture (ForceAuth) transactions |
|
|
ForceCapture_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all ForceCapture (ForceAuth) transactions |
|
|
Host_Date_CH |
A string value up to 10 characters |
Returns the payment processor’s date on which the transaction is performed |
|
|
Host_Ref_Num_CH |
A string value up to 30 characters |
Returns a number which uniquely identifies the transaction for the payment processor |
|
|
Host_Time_CH |
A string value up to 10 characters |
Returns the payment processor’s time at which the transaction was performed |
|
|
Invoice_ID |
A string value up to 100 characters |
Returns the transaction’s Invoice number |
|
|
IP_VC |
A string value up to 15 characters |
Returns the IP address of the client machine from which the transaction was processed |
|
|
Last_Update_DT |
A string value representing a date and time |
Returns the date and time on which the transaction is last modified |
|
|
Manual |
A string value representing a Boolean value |
Returns the card was swiped or not |
|
|
Merchant_Key |
A string value representing a signed 32-bit integer |
Returns a number which uniquely identifies a merchant |
|
|
Name_on_Card_VC |
A string value up to 25 characters |
Returns the name of the cardholder |
|
|
NameOnCheck_VC |
A string value up to 25 characters |
Returns the check payer’s name on the check |
|
|
Orig_TRX_HD_Key |
A string value representing a signed 32-bit integer |
Returns the TRX_HD_Key on which the current transaction is based |
|
|
Payment_Type_ID |
A string value up to 10 characters |
Returns the payment type, e.g. ECHECK |
|
|
PostAuth |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all PostAuth transactions |
|
|
PostAuth_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all PostAuth transactions |
|
|
Processor_ID |
A string value up to 10 characters |
Returns the name the payment processor, e.g. Vital |
|
|
Receipt |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all transactions with a Receipt |
This value will always return “0” |
|
Receipt_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all transactions with a Receipt |
This value will always return “0” |
|
Ref_Number_CH |
A string |
Not currently used |
This field is not the unique transaction identifier (also called PNRef) of the Payment Server. See the field TRX_HD_Key for the PNRef value |
|
Register_Number_CH |
A string value up to 10 characters |
Returns the register number of a transaction |
|
|
RepeatSale |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all RepeatSale (Recurring Billing/Installment) transactions |
|
|
RepeatSale_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all RepeatSale (Recurring Billing/Installment) transactions |
|
|
Reseller_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the Reseller_T table in the database |
|
|
Result_CH |
A string value up to 50 characters |
Returns the transaction processing result, e.g. 0, 12. “0” for approval, “12” for decline |
|
|
Result_Msg_VC |
A string value up to 50 characters |
Returns the check transaction’s processing result |
|
|
Result_Msg1_VC |
A string value up to 50 characters |
Returns an extra formatted response message giving more information about the processed transaction |
|
|
Result_Msg2_VC |
A string value up to 50 characters |
Returns an extra formatted response message giving more information about the processed transaction |
|
|
Result_Txt_VC |
A string value up to 150 characters |
Returns the text message of either approval or decline for the transaction processing result |
|
|
Return |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all Return (Credit) transactions |
|
|
Return_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all Return (Credit) transactions |
|
|
Sale |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all Sale transactions |
|
|
Sale_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all Sale transactions |
|
|
Settle_Date_DT |
A string value representing a date and time |
Returns the date on which the transaction is settled |
|
|
Settle_Flag_CH |
A string value representing a value of 0=Not Settled, 1=Settled, 2=Rolled Back/Indeterminate, 5=In Progress |
Returns if the transaction is settled or not |
|
|
StateCode_CH |
A string value up to 10 characters |
Returns the state code |
|
|
Street_CH |
A string value up to 25 characters |
Returns the billing street address of the credit card |
|
|
SureCharge_Amt_MN |
A string value representing a signed 64-bit real number |
Returns the sure charge amount of a transaction |
|
|
Tip_Amt_MN |
A string value representing a signed 64-bit real number |
Returns the tip amount of a transaction |
|
|
Trans_Type_ID |
A string value up to 20 characters |
Returns the transaction type, e.g. Sale, Credit |
|
|
Transport_Method |
A string |
Returns the Transportation Method |
Only for use with Dial-up transactions |
|
Transport_EndPoint |
A string |
Returns the Transportation’s Ending Destination |
Only for use with Dial-up transactions |
|
TransitNum_VC |
A string value up to 200 characters |
Returns the transit/routing number |
This field will be masked out with asterisk (*) characters except for the last 4 digits if the System Security Level of the user is set to 1 |
|
TRX_Card_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the TRX_Card_T table in the database |
|
|
TRX_Check_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the TRX_Check_T table in the database |
|
|
TRX_HD_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the TRX_Header_T table in the database |
This field is the unique transaction identifier (also called PNRef) of the Payment Server. Use its value when submitting transactions based on a previous transaction (i.e. Voids) through the Transact.asmx Web Service |
|
TRX_Settle_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the TRX_Settle_T table in the database |
|
|
TRX_Settle_Msg_VC |
A string value up to 25 characters |
Returns the transaction’s settlement message |
|
|
Type_CH |
A string value up to 10 characters |
Returns the credit card type, e.g. VISA, MASTERCARD |
|
|
User_Name_VC |
A string value up to 25 characters |
Returns the username, under which the transactions were made |
|
|
Void_Flag_CH |
A string value representing a Boolean value |
Returns the transaction is voided or not |
|
|
Zip_CH |
A string value up to 10 characters |
Returns the billing zip code of the credit card |
|
|
Auth_Amt_MN |
A string value representing a signed 64-bit real number |
Returns the authorized amount of a card transaction |
|
|
Authorization |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all Authorization (PreAuth) transactions |
|
|
Authorization_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all Authorization (PreAuth) transactions |
|
|
AVS_Resp_CH |
A string value up to 1 character |
Returns the address verification result code from the payment processor |
|
|
AVS_Resp_Txt_VC |
A string value up to 25 characters |
Returns the formatted response message when address verification is performed |
|
|
Batch_Number |
A string value up to 10 characters |
Returns the batch number for the transaction that was returned by the payment processor |
Not all payment processors support returning this data element |
|
Capture |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all Capture transactions |
This value will always return “0” |
|
Capture_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all Capture transactions |
This value will always return “0” |
|
Card_Info_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the CC_Info_T table in the database |
|
|
Cash_Back_Amt_MN |
A string value representing a signed 64-bit real number |
Returns the cash back amount for a debit or EBT transaction |
|
|
CheckNum_CH |
A string value up to 10 characters |
Returns the check number |
|
|
Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all transactions |
|
|
CustomerID |
A string value up to 50 characters |
Returns the Customer ID of a customer to which the transaction belongs to |
|
|
CV_Resp_CH |
A string value up to 1 character |
Returns the card verification result code from the payment processor |
|
|
CV_Resp_Txt_VC |
A string value up to 25 characters |
Returns the formatted response message when card verification is performed |
|
|
Date_DT |
A string value representing a date and time |
Returns the date on which the transaction is first made |
|
|
ERROR |
A string value up to 200 characters |
Returns an error message when a problem occurs during the transaction processing |
|
|
Exp_CH |
A string value up to 10 characters |
Returns the credit card expiration date |
|
|
ForceCapture |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all ForceCapture (ForceAuth) transactions |
|
|
ForceCapture_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all ForceCapture (ForceAuth) transactions |
|
|
Host_Date_CH |
A string value up to 10 characters |
Returns the payment processor’s date on which the transaction is performed |
|
|
Host_Ref_Num_CH |
A string value up to 30 characters |
Returns a number which uniquely identifies the transaction for the payment processor |
|
|
Host_Time_CH |
A string value up to 10 characters |
Returns the payment processor’s time at which the transaction was performed |
|
|
Invoice_ID |
A string value up to 100 characters |
Returns the transaction’s Invoice number |
|
|
IP_VC |
A string value up to 15 characters |
Returns the IP address of the client machine from which the transaction was processed |
|
|
Last_Update_DT |
A string value representing a date and time |
Returns the date and time on which the transaction is last modified |
|
|
Manual |
A string value representing a Boolean value |
Returns the card was swiped or not |
|
|
Merchant_Key |
A string value representing a signed 32-bit integer |
Returns a number which uniquely identifies a merchant |
|
|
Name_on_Card_VC |
A string value up to 25 characters |
Returns the name of the cardholder |
|
|
NameOnCheck_VC |
A string value up to 25 characters |
Returns the check payer’s name on the check |
|
|
Orig_TRX_HD_Key |
A string value representing a signed 32-bit integer |
Returns the TRX_HD_Key on which the current transaction is based |
|
|
Payment_Type_ID |
A string value up to 10 characters |
Returns the payment type, e.g. ECHECK |
|
|
PostAuth |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all PostAuth transactions |
|
|
PostAuth_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all PostAuth transactions |
|
|
Processor_ID |
A string value up to 10 characters |
Returns the name the payment processor, e.g. Vital |
|
|
Receipt |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all transactions with a Receipt |
This value will always return “0” |
|
Receipt_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all transactions with a Receipt |
This value will always return “0” |
|
Ref_Number_CH |
A string |
Not currently used |
This field is not the unique transaction identifier (also called PNRef) of the Payment Server. See the field TRX_HD_Key for the PNRef value |
|
Register_Number_CH |
A string value up to 10 characters |
Returns the register number of a transaction |
|
|
RepeatSale |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all RepeatSale (Recurring Billing/Installment) transactions |
|
|
RepeatSale_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all RepeatSale (Recurring Billing/Installment) transactions |
|
|
Reseller_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the Reseller_T table in the database |
|
|
Result_CH |
A string value up to 50 characters |
Returns the transaction processing result, e.g. 0, 12. “0” for approval, “12” for decline |
|
|
Result_Msg_VC |
A string value up to 50 characters |
Returns the check transaction’s processing result |
|
|
Result_Msg1_VC |
A string value up to 50 characters |
Returns an extra formatted response message giving more information about the processed transaction |
|
|
Result_Msg2_VC |
A string value up to 50 characters |
Returns an extra formatted response message giving more information about the processed transaction |
|
|
Result_Txt_VC |
A string value up to 150 characters |
Returns the text message of either approval or decline for the transaction processing result |
|
|
Return |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all Return (Credit) transactions |
|
|
Return_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all Return (Credit) transactions |
|
|
Sale |
A string value representing a signed 64-bit real number |
Returns the dollar amount of all Sale transactions |
|
|
Sale_Cnt |
A string value representing a signed 32-bit integer |
Returns the transaction count of all Sale transactions |
|
|
Settle_Date_DT |
A string value representing a date and time |
Returns the date on which the transaction is settled |
|
|
Settle_Flag_CH |
A string value representing a Boolean value |
Returns if the transaction is settled or not |
|
|
StateCode_CH |
A string value up to 10 characters |
Returns the state code |
|
|
Street_CH |
A string value up to 25 characters |
Returns the billing street address of the credit card |
|
|
SureCharge_Amt_MN |
A string value representing a signed 64-bit real number |
Returns the sure charge amount of a transaction |
|
|
Tip_Amt_MN |
A string value representing a signed 64-bit real number |
Returns the tip amount of a transaction |
|
|
Total_Amt_MN |
A string value representing a signed 64-bit real number |
Returns the total amount of a transaction |
|
|
Trans_Type_ID |
A string value up to 20 characters |
Returns the transaction type, e.g. Sale, Credit |
|
|
Transport_Method |
A string |
Returns the Transportation Method |
Only for use with Dial-up transactions |
|
Transport_EndPoint |
A string |
Returns the Transportation’s Ending Destination |
Only for use with Dial-up transactions |
|
TransitNum_VC |
A string value up to 200 characters |
Returns the transit/routing number |
This field will be masked out with asterisk (*) characters except for the last 4 digits if the System Security Level of the user is set to 1 |
|
TRX_Card_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the TRX_Card_T table in the database |
|
|
TRX_Check_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the TRX_Check_T table in the database |
|
|
TRX_HD_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the TRX_Header_T table in the database |
This field is the unique transaction identifier (also called PNRef) of the Payment Server. Use its value when submitting transactions based on a previous transaction (i.e. Voids) through the Transact.asmx Web Service |
|
TRX_Settle_Key |
A string value representing a signed 32-bit integer |
Returns the primary key of the TRX_Settle_T table in the database |
|
|
TRX_Settle_Msg_VC |
A string value up to 25 characters |
Returns the transaction’s settlement message |
|
|
Type_CH |
A string value up to 10 characters |
Returns the credit card type, e.g. VISA, MASTERCARD |
|
|
User_Name_VC |
A string value up to 25 characters |
Returns the username, under which the transactions were made |
|
|
Void_Flag_CH |
A string value representing a Boolean value |
Returns the transaction is voided or not |
|
|
Zip_CH |
A string value up to 10 characters |
Returns the billing zip code of the credit card |
|