GlobalBatchResponse Type
The response from a batch management transaction.
Remarks
This type will contain a response to a batch settlement, batch inquiry, or connection check.
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. After a call to CheckConnection this field will contain "OK" if everything is okay. If not, the Code, Message, and MessageDetail will indicate the problem. For batch settlement responses it will contain the approval code. For all other transaction responses ApprovalCode will remain empty. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BatchNumber String |
Indicates the number of the current batch. If this is a response to a BatchInquiry transaction, this field will contain the number of the current open batch. If in response to a CaptureAll transaction this field will contain the number of the batch that was just closed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Code String |
Contains the transaction result code from the Global Transport Gateway. This value signifies the result of the transaction (i.e. approved, declined, 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.
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Message String |
Contains a human-readable response message concerning the processed transaction. This value is typically either Approved or Declined, but may also contain a description of any error condition. Do NOT use this when programmatically validating a transaction's result; use the Code field instead. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MessageDetail String |
Contains a formatted response message concerning the processed transaction. This field will contain an additional message about the results of the transaction, providing more detail than the Message field alone. For approved transactions this field will typically be "APPROVAL", and for declined transactions will contain a detailed error message. Do NOT use this when programmatically validating a transaction's result; Use the Code field instead. Note: For Debit Card Sales and Refund, the string value in MessageDetail includes non-printable characters. Global Transport removes all non-printable characters from the returned MessageDetail. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NetTransAmount String |
The net dollar amount of all transactions. This is the total transaction amount of the settlement, minus all refunds. If positive it indicates a payment to the merchant. If negative it means more refunds than sales were contained in the batch, and the merchant will be charged. Note that a void transaction DOES count towards the total NetTransAmount, but a Refund or Credit subtracts from it. For instance, a batch containing one $10 transaction and one $10 void will have a NetTransAmount of "20.00". However, a batch containing one $10 transaction and one $3 refund will have a NetTransAmount of "7.00". In either case, the NetTransCount will be 2. This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NetTransCount int |
This field contains the total number of transactions contained in the batch settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SettleDate String |
The date the batch was settled. This date field is in the format "YYYY-MM-DD HH:MM:SS" |
Constructors
public GlobalBatchResponse();