My Profile_


Standard Response Fields

To collect the applicable response details, parse the transaction response for the particular element. The response samples are included in each individual transaction.

This section outlines all of the possible response fields that may be returned. For response details custom to a particular transaction please refer to that transaction example.

Transaction Response Fields

Value Limits Variable Description
Order ID / Receipt ID 50-character alphanumeric ReceiptId Returns the order_id from the request.
Reference Number 18-character alphanumeric ReferenceNum Terminal used to process the transaction as well as the shift, batch and sequence number. This data is typically used to reference transactions on the host systems, and must be displayed on any receipt presented to the customer.
This information is to be stored by the merchant.

Example: 660123450010690030
  • 66012345: Terminal ID
  • 001: Shift number
  • 069: Batch number
  • 003: Transaction number within the batch.
Response Code 3-character numeric or null ResponseCode Transaction Response Code
< 50: Transaction approved
>= 50: Transaction declined
NULL: Transaction was not sent for authorization
For further details on the response codes that are returned please see the Response Codes table
ISO Code 2 – character numeric ISO ISO response code return from issuing institution. For further details on the response codes that are returned please see the Response Codes table
Authorization Code 8 – character alphanumeric AuthCode Authorization code returned from the issuing institution.
Transaction Time ##:##:## TransTime Processing host time stamp (24 hour clock).
Transaction Date yyyy-mm-dd TransDate Processing host date stamp.
Transaction Type 2 – character numeric TransType Type of transaction that was performed:
  • 00 = Purchase, ACH Debit, Vault Credit Card Purchase, Vault ACH Purchase
  • 01 = Preauthorization, Vault Credit Card Pre-Authorization
  • 02 = Pre-Authorization Completion
  • 04 = Refund, Independent Refund, ACH Credit, Vault Credit Card & ACH Independent Refund
  • 11 = Purchase Correction, ACH Reversal
Complete true/false Complete Transaction was sent to authorization host and a response was received
Message 100 – character alphanumeric Message Response description returned from issuing institution. This message should not be displayed on any cardholder facing materials. For receipt purposes, please refer to the Receipt Requirements
Transaction Amount 9 - decimal TransAmount Returns the transaction amount from the request.
Card Type 2 – character alphanumeric CardType Card Type
M = MasterCard
V = Visa
AX = American Express
NO = Novus/Discover in (Canada only)
DS= Discover (US only)
C = JCB (US only)
C1 = JCB (Canada only)
SE = Sears (Canada only)
CQ = ACH (US only)
P = Pin Debit (US only)
D = Debit (Canada only)
Transaction Number 20 - character alphanumeric TxnNumber Gateway Transaction identifier. This field is required for any future follow-on transactions such as Refunds, Corrections, Completions, Reversals, etc.
Timed Out true/false TimedOut Indicates if a transaction failed due to a process timing out.
Bank Totals BankTotals Reserved field for API Batch Close / Open Totals.
Ticket Ticket Reserved field.

AVS Response Fields

Value Limits Variable Description
AVS result code 1-character alphanumeric AvsResultCode Indicates the address verification result. For a full list of possible response codes refer to the AVS Result Code table.

Recurring Billing Response Fields

Value Limits Variable Description
Recurring billing success true/false RecurSuccess Indicates whether the recurring billing transaction has been successfully set up for future billing.

Vault Response Fields

Value Limits Variable Description
Data Key 25-character alphanumeric DataKey This field is created when a profile is created and a token is returned.
It is a unique profile identifier, and is a required value for all future Vault transactions.
Vault Success true/false ResSuccess Indicates whether Vault transaction was successful.
PaymentType cc/ach PaymentType Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric cust_id Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric phone Returns the phone number saved in the profile.
Email Address 30-character alphanumeric email Returns the email address saved in the profile.
Note 30-character alphanumeric note Returns the note saved in the profile.
ACH Fields
SEC Code 3-character numeric sec Returns the ACH SEC code saved in the profile.
Customer First Name 50-character alphanumeric cust_first_name Returns the customer first name saved in the profile.
Customer Last Name 50-character numeric cust_last_name Returns the customer last name saved in the profile.
Customer Address 1 50-character alphanumeric cust_address1 Returns the customer address line 1 saved in the profile.
Customer Address 2 50-character alphanumeric cust_address2 Returns the customer address line 2 saved in the profile.
Customer City 50-character alphanumeric cust_city Returns the customer city saved in the profile.
Customer State 2-character alphanumeric cust_state Returns the customer state code saved in the profile.
Customer Zip Code 10-character alphanumeric cust_zip Returns the customer zip code saved in the profile.
Check Routing Number 9-character alphanumeric routing_num Returns the customer check routing number saved in the profile.
Masked Account Number 15-character alphanumeric masked_account_num Returns the masked first 4 last 4 of the account number saved in the profile.
Check Number 16-character alphanumeric check_num Returns the check number saved in the profile.
Account Type savings/checking account_type Returns the type of account saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric masked_pan Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric expdate Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric crypt_type Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric avs_street_number Returns the AVS street number saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Street Name 19-character alphanumeric avs_street_name Returns the AVS street name saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Zip/Postal Code 9-character alphanumeric avs_street_zipcode Returns the AVS zip/postal code saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.

VAU & ABU Response Fields

Value Limits Variable Description
Transaction / Order ID 20 – character alphanumeric merchant_trans_id Returns the Transaction / Order ID indicated in the request.
Old Credit Card Number 20 – character numeric old_pan Returns the Old Credit Card Number indicated in the request.
New Credit Card Number 20 – character numeric new_pan This field contains one of the following:
  • The account number when new information is available
  • All spaces for messages that indicate one of the following conditions:
    • Closed Account
    • Participating BIN, No Match
    • Contact Cardholder
    • Non-participating BIN, No Match
  • 0 padded field
Old Expiry Date 4 – character numeric old_exp_date Returns the Old Expiry Date indicated in the request.
New Expiry Date 4 – character numeric new_exp_date This field contains one of the following:
  • The expiration date when new information is available (YYMM format)
  • Spaces for messages that indicate one of the following conditions:
    • Closed Account
    • Participating BIN, No Match
    • Contact Cardholder
    • Non-participating BIN, No Match
  • 0 padded field
ABU
MC Reason ID / Code 6 – character alphanumeric mc_reason_id This response is returned by MasterCard.
Valid values are:
  • UPDATE - Update was made, updated data is returned
  • EXPIRY - Expiry date changed on the card
  • NOMATH - No match was found in MasterCard's system
  • CONTACT - Account closed, contact card holder for updated information
  • 000101 - (ERROR) Non-numeric Account Number
  • 000102 - (ERROR) Bad Check Digit for Account
  • 000103 - (ERROR) Invalid Expiration Date
  • 000104 - (ERROR) Merchant Not Registered
VAU
Visa Service ID / Code 1 – character alphabetic service_id This response is returned by Visa.
Valid values are:
  • A - Account number change message
  • C - Closed account advice
  • E - Expiration date change message
  • N - Non-participating BIN
  • Q - Contact cardholder advice
  • P - Participating BIN, no match
  • V - Match made, account number and expiration date unchanged
  • Z - No match found in the system
Previously Sent Y/N prev_sent This field will return a value of “Y” which indicates that exactly the same account information was requested during the previous 40 days (the retention period), excluding the current day.