4D Payments SDK 2016 .NET Edition
4D Payments SDK 2016 .NET Edition
Questions / Feedback?

GlobalSearchResult Type

Contains information about a single transaction.

Remarks

The GlobalTransactionSearch component is used to search for individual transactions. This type is used to store the results.

Fields

ApprovalCode
String

Contains the transaction authorization code from the card issuer.

For approved transaction responses (Code 0 or 200) the Global Transport Gateway sends a 6-character approval code in the ApprovalCode field and a human-readable approval message in the Message field. In the case of a decline, the ApprovalCode will contain an error message. Your application should display the ApprovalCode as part of the approval message for an approved transaction. For declined responses, the HostCode field will contain an additional code that provides detail on the reason for the decline.

AuthorizedAmount
String

In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the Code will contain "200", the Message will contain "Partial Approval", and the MessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the AuthorizedAmount will contain the amount of the transaction that was authorized, and the BalanceDue field will indicate the amount still owed by the customer.

If a partial authorization occurs and the customer does not wish to go through with the transaction, you must submit a reversal of the authorization in order to return funds to the prepaid card.

AVSResultCode
String

Contains the address verification result code from the card issuer.

When programmatically validating an AVS Result, this value should ALWAYS be used instead of any formatted AVSResultMessage describing the result. The following table lists the possible AVS result codes:

X Exact: Address and nine-digit Zip match.
Y Yes: Address and five-digit Zip match.
A Address: Address matches, Zip does not.
Z 5-digit Zip: 5-digit Zip matches, address doesn't.
W Whole Zip: 9-digit Zip matches, address doesn't.
N No: Neither address nor Zip matches.
U Unavailable: Address information not available.
G Unavailable: Address information not available for international transaction.
R Retry: System unavailable or time-out.
E Error: Transaction unintelligible for AVS or edit error found in the message that prevents AVS from being performed.
S Not Supported: Issuer doesn't support AVS service.
B * Street Match: Street addresses match for international transaction, but postal code doesn't.
C * Street Address: Street addresses and postal code not verified for international transaction.
D * Match: Street addresses and postal codes match for international transaction.
I * Not Verified: Address Information not verified for International transaction.
M * Match: Street addresses and postal codes match for international transaction.
P * Postal Match: Postal codes match for international transaction, but street address doesn't.
0 ** No response sent.
5 Invalid AVS response.

* These values are Visa specific.
** These values are returned by the Global Transport Gateway and not the issuing bank.

BatchNumber
String

The number of the batch this transaction is currently contained in. If this is a reply to an AuthOnly transaction, the BatchNumber field will be blank, as auth-onlys are not added to the open batch until a Capture is performed.

CardExpDate
String

Contains the credit card expiration date. Typically returned in MMYY format, but may contain up to a 10-character date string.

CardNumber
String

Contains the credit card number used in the transaction. This field will be masked out with asterisk (*) characters except for the last four digits.

CardPresent
Boolean

Indicates whether or not this was a card-present transaction.

CardType
String

Indicates the card type or payment method.

For credit card transactions, this field will contain the name of the credit card type. For instance, "VISA", "MASTERCARD", "AMEX", etc. For Debit or Electronic Benefit transactions, this field will contain "DEBIT" or "EBT".

CashBackAmount
String

Contains the cash back amount for a debit or EBT transaction.

ClientIP
String

* No longer supported as the underlying Global API has changed.

Contains the IP address of the client machine from which the transaction was processed.

CustomerId
String

Identifies the customer that initiated the transaction. This field will only contain data if the merchant has assigned identification numbers to customers.

CustomerStreet
String

Contains the billing street address of the credit card.

CustomerZip
String

Contains the billing zip code of the credit card.

CVVResultCode
String

Contains the card verification result code from the card issuer.

This value is only applicable to credit card transactions. The card verification number is typically printed on the back of the card and not embossed on the front. It is used as an extra authentication method for "card not present" transactions. When programmatically validating a CV Result, this value should ALWAYS be used instead of any formatted response message describing the result, contained in the CVVResultMessage field.

The following table lists the possible result codes for this field:

Value Description
M CVV2/CVC2/CID Match
N CVV2/CVC2/CID No Match
P Not Processed
S Issuer indicates that the CV data should be present on the card, but the merchant has indicated that the CV data is not present on the card.
U Unknown / Issuer has not certified for CV or issuer has not provided Visa/MasterCard with the
CV encryption keys.
X Server Provider did not respond

EntryMode
SearchEntryModes

Indicates whether the card was swiped or manually keyed. Possible values are:

emNotSpecified (0) No entry mode was specified.
emManualEntry (1) The card was manually keyed.
emSwipedEntry (2) The magnetic strip from the card was read.

Error
String

* No longer supported as the underlying Global API has changed.

Contains an error message when a problem occurred during transaction processing.

GratuityAmount
String

Contains the tip portion of the TotalAmount. This is not applicable to all industries and transaction types.

HostCode
String

Action code returned by Global Payments.

Typically, if the transaction is approved, this will be the batch reference number. If the transaction is declined, the HostCode will indicate the reason for the decline. The table below lists the possible HostCode and Message combinations for error conditions.

HostCodeMessageDescription
000AP Approved or Completed Successfully.
000AP NEW INFO Approved with updated cardholder data.
000PARTIAL AP Only part of the requested amount was approved.
001CALL AE Refer to American Express.
001CALL DC Refer to Diners Club.
001CALL DISCOVER Refer to Discover.
001CALL ND Call your Visa/MasterCard Voice Authorization Center.
001CALL TK Refer to TeleCheck.
001CALL XXXXXXXXXX Call indicated number.
001ISSUER UNAVAIL Global Payments cannot contact issuing bank for authorization.
002CALL AE Touchtone capture, won't roll to an operator.
002CALL DC Touchtone capture, won't roll to an operator.
002CALL DISCOVER Touchtone capture, won't roll to an operator.
002CALL ND Touchtone capture, won't roll to an operator.
002CALL XXXXXXXXXX Touchtone capture, won't roll to an operator.
002ISSUER UNAVAIL Touchtone capture, won't roll to an operator.
003INVLD MERCH ID Invalid Merchant ID.
004PIC UP Authorization Declined.
005DECLINE Authorization Declined.
005DECLINE NEW INFO Update cardholder data.
005DECLINE TRY LATER Try again in 3 days.
005REVK PAY ORDERED Stop payment of a specific recurring payment.
005STOP PAY ORDERED Stop all future recurring payments.
006REVERSED Requested transaction reversal was successful.
007DECLINE-CV2 FAIL Response for CVV2 failure. Declined. (Visa).
008AP WITH ID Approved with positive ID. Host does not capture this transaction.
012INVLD TRAN CODE Processing code entered is incorrect. Please refer to valid processing code.
013INVLD AMOUNT Amount entered is invalid.
014INVLD ACCT Account number does not pass issuer's edit checks.
014INVLD CODE ACCT Valid account number matched with a transaction code for a different card type.
014INVLD CID American Express CID failure.
019PLEASE RETRY Retry the transaction.
054INVLD EXP DATE Expiration date entered is incorrect.
055PIN INVALID Incorrect PIN entered.
058UNAUTH TRANS Merchant not set up for transaction code used.
075MAX PIN RETRIES Maximum PIN number entry attempts exceeded.
094AP DUPE Transaction entered is a duplicate.
0C1SYSTEM UNAVAILABLE Global Payments Check System unavailable.
0N2INV AMT MATCH The amount entered for a void or adjustment transaction does not match the amount stored in the host for that item.
0N3INV ITEM NUM The item number entered for a void or adjustment transaction is incorrect.
0N4ITEM VOIDED An adjustment or item review was attempted on a transaction previously voided.
0N5MUST BALANCE NOW Terminal has not been balanced within time specified in the Global Payments Merchant Master File for this merchant.
0N6USE DUP THEN BAL Originating device has not been balanced within time specified in the Global Payments Merchant Master File for this merchant, but merchant is set up to perform extra transactions before balancing.
0N7NO DUP FOUND Override transaction is attempted on a non-duplicated transaction.
0N8INVALID DATA Format of the transaction is incorrect.
0NANO TRANS FOUND Reversal transaction is attempted on a transaction that is not in the open batch on the host.
0NCAP NOT CAPTURED Approved but not captured (applies only to credit card transactions)- stand in.
0NEAP AUTH-ONLY Approved but this EDC merchant is not set up to capture this card type (applies only to credit card transactions).
PART AP AUTH-ONLY Only part of the requested amount was approved, but this EDC merchant is not set up to capture this card type (applies only to credit card transactions).
0P1APPROVED Approved debit card transaction.
0P2DB UNAVAIL 02 Global Payments is experiencing a problem.
0P5UNAUTH USER Merchant is not set up for debit on Global Payments Merchant Master File.
0P6INVALID CARD Invalid card number.
0T1EDC UNAVAILABLE EDC application down, try later.
0T2DB UNAVAIL 01 Debit application down, try later.
121EXCEEDS MAX AMT Exceeds withdrawal amount limit.
121EXCEEDS MAX AMT Exceeds withdrawal amount limit.

IMPORTANT: When programmatically validating a transaction's result, the Code value should ALWAYS be used instead of any other response messages describing the result. For example, do not use HostCode, Message, MessageDetail, or any other responses, as these values may vary. This tables is included for informational purposes only.

InvoiceNumber
String

Contains the transactions invoice number.

LastModified
String

Contains the date and time on which the transaction was last modified.

NameOnCard
String

Contains the cardholder's name. If no name was specified in the NameOnCard property when the transaction was first authorized, this field will not be returned in a search.

OriginalPNRef
String

Contains the Global Transport Gateway PNRef on which the current transaction is based.

PaymentType
String

* No longer supported as the underlying Global API has changed.

Contains the payment type of this transaction. For instance, "MasterCard", "Visa", "DEBIT", etc.

PNRef
String

Contains a number which uniquely identifies the transaction in the Global Transport system.

This value should be stored by the POS to enable the processing transactions based on a previous transaction. For instance, Capture, Void, Refund, TipAdjustment, etc.

ProcessorId
String

* No longer supported as the underlying Global API has changed.

Contains the name of the processing platform.

RegisterNumber
String

A number that uniquely identifies the register or computer on which the transaction was performed. If the RegisterNumber was not sent in the authorization, this field will be empty.

ResellerKey
String

* No longer supported as the underlying Global API has changed.

Contains the primary key of the Reseller table.

ResponseCode
String

Contains the transaction result code from the Global Transport Gateway. This value signifies the result of the transaction (i.e. approved, decline, etc.) When programmatically validating a transaction's result, this value should ALWAYS be used instead of any response message describing the result. See the table below for a full list of result codes and descriptions.

-100Transaction NOT Processed; Generic Host Error.
0Approved.
2Invalid Transaction.
3Invalid Transaction Type.
3Unsupported Transaction Type.
4Invalid Amount.
4Invalid Cash Back Amount.
5Invalid Merchant Information.
6Time Out Waiting for Host Response.
7Field Format Error. See Message and MessageDetail for more info.
7Swiped and Card Present transactions are not supported in Card Not Present markets.
8Not a Transaction Server.
11Client Timeout Waiting for Response.
12Decline
ITEM VOIDED
PREAUTH VOIDED.
14Transaction Type Not Supported In This Version.
19Original Transaction Id, PNRef, or Approval Code Not Found.
20Customer Reference Number Not Found.
22Invalid ABA Number.
23Invalid Account Number.
24Invalid Expiration Date.
25Transaction Type Not Supported by Host.
26Invalid Reference Number or PNRef.
27Invalid Receipt Information.
28Invalid Check Holder Name.
29Invalid Check Number.
30Check DL Verification Requires DL State.
31Cannot perform multiple captures on a PreAuth.
40Not Currently Supported.
50Insufficient Funds Available.
99General Error.
100Invalid Transaction Returned from Host.
101Timeout Value too Small or Invalid Time Out Value.
102Processor Not Available.
103Error Reading Response from Host.
104Timeout waiting for Processor Response.
105Credit Error.
106Host Not Available.
107Duplicate Suppression Timeout.
108Void Error/Cannot void a previously voided or settled transaction.
109Timeout Waiting for Host Response.
110Duplicate Transaction.
111Capture Error.
112Failed AVS Check.
113Cannot Exceed Sales Cap / Requested Refund Exceeds Available Refund Amount.
114Cannot refund a voided transaction.
115Sum of Tax, Tip, and Cash Back amount cannot exceed total Amount.
116Unsupported Card Type.
117Only Sales, Repeat Sales, Force Captures, and Post Authorizations can be refunded.
118The amount of a Pre-Auth Complete (Capture) must be less than or equal to the original amount authorized. Please retry.
200A Partial Authorization of a pre-paid card. This is considered an Approved transaction. Check the AuthorizedAmount field for the amount approved. See below for more information.
1000Generic Host Error or General Exception. (Missing or invalid data). See Message and MessageDetail for more info.
1001Invalid Login Information.
1002Insufficient Privilege or Invalid Amount.
1002AVS Only transactions are not supported in E-Commerce markets.
1002Debit/EBT Return transactions must provide the PNRef from the original Sale. Please retry.
1002Zip is required for AVS Only transaction type.
1003Invalid Login Blocked.
1004Invalid Login Deactivated.
1005Transaction Type or Service Not Allowed.
1006Unsupported Processor.
1007Invalid Request Message.
1008Invalid Version / The MAC value is required.
1010Payment Type Not Supported.
1011Error Starting Transaction.
1012Error Finishing Transaction.
1013Error Checking Duplicate.
1014No Records To Settle (in the current batch).
1015No Records To Process (in the current batch).

ResponseMessage
String

Contains a human-readable response message concerning the transaction.

This value is typically either "Approved" or "Declined", but may also contain a description of any error condition.

SettleDate
String

* No longer supported as the underlying Global API has changed.

Contains the date on which the transaction was settled. This date field is in the format "YYYY-MM-DD HH:MM:SS"

SettleFlag
Boolean

Indicates whether or not the transaction has been settled.

TotalAmount
String

Contains the total amount of the transaction. This value reflects the AuthorizedAmount plus any GratuityAmount, less any refunded amount. This amount also may be different from the AuthorizedAmount in the case of an AuthOnly transaction followed by a Capture transaction for a different amount.

TransactionDate
String

* No longer supported as the underlying Global API has changed.

Contains the date on which the transaction was first made. This date field is in the format "YYYY-MM-DD HH:MM:SS"

TransactionId
String

Card issuer's Transaction Reference Number.

This field contains a Visa Transaction Id, MasterCard BankNet Reference Number, American Express Transaction Id, or Discover STAN Id. If returned in the response, this field must be printed on the receipt. Note that this TransactionId is not used by Global Payments to reference the transaction. The PNRef field is used to track and modify transactions made on the Global Payments system.

TransactionKey
String

* No longer supported as the underlying Global API has changed.

Contains the Global Transport Gateway primary key of the transaction. This is also known as the Card Info Key.

TransactionType
String

Contains the transaction type. For example, "Sale", "Credit", "Void", etc.

UserId
String

Contains the username used to process the transaction.

VendorNumber
String

Contains a number which uniquely identifies a merchant. This is also known as the RPNum.

VoidFlag
Boolean

Indicates whether or not the transaction has been voided.

Constructors

[VB.NET]
Public GlobalSearchResult()

[C#]
public GlobalSearchResult();



 
 
Copyright (c) 2020 4D Payments Inc. - All rights reserved.
4D Payments SDK 2016 .NET Edition - Version 16.0 [Build 7502]