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

FDMSOmahaDetailRecord Component

Properties   Methods   Events   Configuration Settings   Errors  

The FDMSOmahaDetailRecord component is a tool used to create off-line transactions (Captures, Refunds, Revisions, and Voids) to be settled by the FDMSOmahaBatchMgr component.

Syntax

DPayments.DPaymentsSDK.Fdmsomahadetailrecord

Remarks

Captures (for Auth Only transactions), Refunds, Voids, and Revisions are all off-line transactions. This means that there is no live response from the server for the transaction. Instead you will add the transactions to the FDMSOmahaBatchMgr component to be sent when the batch is closed.

To capture an AuthOnly transaction, first parse the aggregate obtained from the auth only transaction.

FDMSOmahaDetailRecord.ParseAggregate(FDMSOmahaRetail1.GetDetailAggregate())

Once the aggregate is parsed, you must then set the BatchNumber, TransactionNumber, and TransactionType.

FDMSOmahaDetailRecord.BatchNumber = 1
FDMSOmahaDetailRecord.TransactionNumber = 1
FDMSOmahaDetailRecord.TransactionType = ttCapture

Finally, the aggregate can be added to the FDMSOmahaBatchMgr component to be sent when the batch is closed.

FDMSOmahaBatchMgr.DetailRecords.Add(new FDMSOmahaRecordType(FDMSOmahaDetailRecord.GetDetailAggregate()))

Void and Revision transactions are performed very much like Capture transactions. First, the aggregate is added to the FDMSOmahaDetailRecord component. The TransactionType can then be set to either ttVoid or ttRevise. For revision transactions, you can update the transaction details (such as SettlementAmount). Note that neither of these transaction types allow you to set BatchNumber or TransactionNumber as they have already been assigned to the transaction when it was marked for capture (after a Sale transaction or after a Capture transaction).

A common revision request is adding a TipAmount to charge. Below is an example of adding a TipAmount to a restaurant transaction.

FDMSOmahaDetailRecord.ParseAggregate(FDMSOmahaRestaurant1.GetDetailAggregate())
FDMSOmahaDetailRecord.TipAmount = "5.00"
//The SettlementAmount must include the sum of the TipAmount and the AuthorizedAmount
//If the transaction was originally for $10.00 and a $5.00 tip is added the new
//SettlementAmount should be "15.00"
FDMSOmahaDetailRecord.SettlementAmount = "15.00"
FDMSOmahaBatchMgr.DetailRecords.Add(New FDMSRecordType(FDMSOmahaDetailRecord.GetDetailAggregate()))

A Credit Card Refund is not based on a prior transaction. Instead, the FDMSOmahaDetailRecord component is used to construct a completely new aggregate. To perform a Credit Card Refund, first set the IndustryType to the desired industry and set TransactionType to ttRefund. The below example is for a Retail transaction.

FDMSOmahaDetailRecord.IndustryType = itRetail
FDMSOmahaDetailRecord.TransactionType = ttRefund

Next, set the card and transaction data along with the amount of the refund (via SettlementAmount).

FDMSOmahaDetailRecord.Card.EntryDataSource = edsManualEntryTrack1Capable
FDMSOmahaDetailRecord.Card.Number = "4444333322221111"
FDMSOmahaDetailRecord.Card.ExpMonth = 1
FDMSOmahaDetailRecord.Card.ExpYear = 2013
FDMSOmahaDetailRecord.BatchNumber = 1
FDMSOmahaDetailRecord.TransactionNumber = 2
FDMSOmahaDetailRecord.SettlementAmount = "1.00"

Finally, the aggregate can be added to the FDMSOmahaBatchMgr component to be sent when the batch is closed.

FDMSOmahaBatchMgr.DetailRecords.Add(new FDMSOmahaRecordType(FDMSOmahaDetailRecord.GetDetailAggregate()))

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AuthCodeAuthorization Code returned from the server.
AuthorizedAmountOriginal amount authorized before any reversals.
AVSResultContains the Address Verification System result code.
BatchNumberNumber identifying the batch (assigned by the POS device).
BeverageAmountThe amount of the restaurant beverage purchase.
CardContains the customer's credit card information.
CustomerAddressThe customer's street number of the billing address.
CustomerCodeMerchant-assigned customer code.
CustomerZipCodeCustomer's zip code (or postal code if outside of the USA).
DeviceIdPOS Device Identification.
DirectMarketingTypeSpecifies the type of transaction to process.
FoodAmountThe amount of the restaurant food purchase.
IndustryTypeCode which indicates the industry the merchant is engaged in.
InvoiceNumberMerchant-defined invoice number.
OperatorIDMerchant-assigned operator code identifying the operator who entered the transaction.
OrderNumberMerchant-defined number identifying the purchase or service.
SettlementAmountThe amount that the customer will be charged.
ShipToZipCodeThe zip code where the purchased items will be shipped to.
TaxAmountDollar-and-cent amount of tax for the purchase.
TipAmountThe amount of the tip given at a restaurant for the purchase.
TPPIDThird Party Processor Identifier assigned by FDMS.
TransactionIdContains the Visa Transaction Identifier or MasterCard Reference Number.
TransactionNumberThe transaction number for the current transaction.
TransactionTypeIndicates transaction type for this detail record.
VisaIdentifierAdditional merchant identification field used when authorizing Visa transactions.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting .
GetDetailAggregateReturns an aggregate containing details of this transaction, which is then used for settlement.
ParseAggregateParses the aggregate returned from another component's GetDetailAggregate method.
ResetClears all properties to their default values.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

ACIRequested Authorization Characteristics Indicator (ACI).
CustomerAddressThe customer's street number of the billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
OperatorIDMerchant-assigned Operator code identifying the operator who entered the transaction.
UseEncryptionChannelSpecifies whether First Data should use the SST Encryption Channel.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

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