FDMSBenefitResponse Type
Contains the response to the EBT transaction..
Remarks
This type contains the results of a transaction made with the FDMSBenefit 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 message if declined. This field contains an authorization code when a transaction has been approved. The code will begin with "AP" and will be 8 characters in length. If the transaction was declined, it will contain one of the response messages listed in the table below:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 EndingBalance should be printed instead (print "Balance Unavailable" if neither are returned in the response). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CaptureFlag boolean |
Indicates whether the authorization was successful, and whether it can be settled. After an authorization request, the CaptureFlag will be set to True if the request was successfully processed. This indicates that you may send the transaction on for batch settlement using the FDMSSettle component. If this field is False you should consider the transaction as Declined, and it may not be settled. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CashEndingBalance String |
Ending (Current/Ledger) 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 EndingBalance indicates the current balance in the Food Stamp account, and this field indicates the available balance in the Cash Benefit account. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DatawireReturnCode String |
Contains an error code providing more details about the DatawireStatus received. When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the DatawireStatus will be "OK" and the DatawireReturnCode will be "000". These two fields have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This field only indicates that the request reached FDMS, and that FDMS responded with some data. The CaptureFlag and ApprovalCode fields contain the actual transaction result that was returned by FDMS. The following is a list of possible Datawire return codes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DatawireStatus String |
Status of the communication with Datawire. When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the DatawireStatus will be "OK" and the DatawireReturnCode will be "000". These two fields have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This field only indicates that the request reached FDMS, and that FDMS responded with some data. The CaptureFlag and ApprovalCode fields contains the actual FDMS Transaction Result that was returned. The following is a list of possible Datawire response status codes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndingBalance String |
Current balance of the EBT card, not including pending authorizations. This is also known as the Ledger, or Current balance, and it indicates the actual balance of the EBT card at this moment; it does not reflect any holds or pending transactions that have not yet been settled. If no AvailableBalance was returned in the response, this EndingBalance should be printed on the receipt instead (if neither are returned, print "Balance Unavailable"). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransactionDate String |
Local transaction date returned from the server in MMDDYY format. This six digit field contains a local transaction date calculated by the authorization center. This field should be recorded and submitted in the Batch Settlement. |
Constructors
public FDMSBenefitResponse();