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

PTechGiftCardResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the PTechGiftCard component. The fields contained by this type are listed below.

Fields

ApprovalCode
String

Contains an authorization code when a transaction has been approved, or an error code. This six character field contains an authorization code when a transaction has been approved. If the Code returned indicates that the transaction has not been approved, then this field will contain an error code, and the Text field will contain the description. Note that the host does not send back an actual authorization code for Credit Returns. Instead, the host sends back six blank spaces in the authorization code field. Credit VOIDS return the original authorization number.

See the list of errors for this component for more information.

AuthorizedAmount
String

Used for partial authorizations. Indicates the actual amount authorized from the stored value card. If the customer does not have enough on his stored value card to cover the complete cost of the purchase, the merchant may request that the host perform a partial redemption. The full stored value card will be used to fund as much of the transaction as possible, and the remainder may be funded by some other form of payment. When PartialRedemption is set to True, the host will supply the actual amount authorized from the stored value card in the AuthorizedAmount field.

Note that the AuthorizedAmount will only contain a value if the PartialRedemption property in the authorizing component was set to True. It will remain blank otherwise.

Balance
String

Balance after this transaction was completed. This field contains the available balance remaining on the card. It is required that this value be printed on the customer's receipt.

BatchNumber
String

Current open batch number This field is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component.

CashOut
String

The sum of the TransactionAmount plus the remainder of any value left on the card. When the CashOutIndicator field is set to True, the stored value card will be "cashed out". This means that all funds stored on the card is cleared, and the merchant is to return those funds to the customer as cash. When CashOutIndicator is True, the CashOut field will contain the amount of money the merchant is to return to the customer in cash. AuthorizedAmount will contain the total amount removed from the gift card (The sum of the TransactionAmount plus the CashOut amount).

Code
String

Indicates the status of the authorization request. This is the field used to determine whether a transaction has been approved or not. Valid values for this field are:

ATransaction is Approved.
EError condition or card declined (see the Error section of the help file for more information).

See the list of errors for this component for more information.

CVVResult
String

Contains the returned CVV result code if it was requested. If a CVV value was present in the CVVData field before authorizing the transaction, this one character field will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the Card.CVVData; field is filled. Instead, an AMEX transaction will be declined if the CVV value does not match, with an Text indicating such. The following is a list of current result codes:

MCVV2 match.
NCVV2 no match.
PNot processed.
SMerchant has indicated that CVV2 is not present on card.
UIssuer not certified and/or has not provided Visa encryption keys.

PreviousBalance
String

Balance before this transaction started. This field contains the available balance on the card BEFORE this transaction took place. For instance, if a Stored Value card contains funds in the amount of $50.00, and the TransactionAmount for this authorization was "20.00", the Balance will contain "30.00" and the PreviousBalance, if returned, will contain "50.00". This field may or may not be returned by the processor, and is not required to be printed on the customer's receipt.

RetrievalNumber
String

Reference number returned from the Paymentech host. This is the reference number of the transaction as assigned by the Paymentech host. This number must remain with the transaction for the duration of the transaction's life cycle. This information is sent as a parameter in the VoidTransaction method.

If the SettlementMode is set to manual this field will contain the POSRetrievalNumber submitted in the authorization. If no POSRetrievalNumber was sent, this field will contain all zeros, and you will not have a reference number for the transaction.

If the SettlementMode is set to host settle, this field will always contain the Paymentech-generated retrieval number returned by the transaction server, regardless of the value contained in the POSRetrievalNumber property.

In all cases, the RetrievalNumber will contain the number used to reference the transaction when issuing voids or reversals.

SequenceNumber
String

SequenceNumber echoed from the authorization. After any transaction this field will contain the same value sent in the SequenceNumber property.

Text
String

Approval/Decline/Error text message information This field contains a response or display text message, and is used by the terminal to display the authorization result. This field will contain human-readable text indicating whether the transaction was approved or declined, or will contain a description of the error. The actual error code will be returned in the ApprovalCode field. The Text field is for informational use only, and should not be used in determining whether a transaction has been approved or not. Instead, use the Code field to determine this.

See the list of errors for this component for more information.

Trace
String

Trace number returned for Stored Value transactions. This field is returned in the response to a Stored Value card transaction. The returned value is used for transaction tracking purposes, and must be printed on the customer's receipt.

Constructors

[VB.NET]
Public PTechGiftCardResponse()

[C#]
public PTechGiftCardResponse();



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