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

PTechBenefitResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the PTechBenefit 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.

AvailableBalance
String

Current card balance, including all pending transactions. The available balance is the current Ledger balance, less any holds (due to authorizations), plus any credits or deposits and minus withdrawals, that are all part of the day's activity. If present, this value must be printed on the customer's receipt. If not present, the LedgerBalance should be printed instead (print "Balance Unavailable" if neither are returned in the response).

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.

BeginningBalance
String

Beginning balance of the EBT account. This field indicates what the beginning balance that was deposited into the EBT account for the current period.

CashAvailableBalance
String

Available cash balance on the EBT card. EBT cards may be linked to both a Food Stamp account and a Cash Benefit account. In this case, the AvailableBalance indicates the available balance in the Food Stamp account, and this field indicates the available balance in the Cash Benefit account.

CashBeginningBalance
String

Beginning cash balance on the EBT card. EBT cards may be linked to both a Food Stamp account and a Cash Benefit account. In this case, the BeginningBalance indicates the beginning balance in the Food Stamp account, and this field indicates the beginning balance in the Cash Benefit account.

CashLedgerBalance
String

Ledger (Current) cash balance on the EBT card. EBT cards may be linked to both a Food Stamp account and a Cash Benefit account. In this case, the LedgerBalance indicates the current balance in the Food Stamp account, and this field indicates the available balance in the Cash Benefit account.

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.

LedgerBalance
String

Current balance of the EBT card, not including pending authorizations. The Ledger, or Current balance indicates the actual balance of the EBT card on a specific day, and does not reflect any holds or pending transactions that have not yet been settled. If no AvailableBalance was returned in the response, this LedgerBalance should be printed on the receipt instead (if neither are returned, print "Balance Unavailable").

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 EBT transactions. This field is returned in the response to an EBT card transaction. The returned value is used for transaction tracking purposes, and must be printed on the customer's receipt.

Constructors

[VB.NET]
Public PTechBenefitResponse()

[C#]
public PTechBenefitResponse();



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