4D Payments SDK 2016 .NET Edition

Questions / Feedback?

GetDetailAggregate Method

Returns an aggregate containing details of this transaction, which is then used for settlement.


public string GetDetailAggregate();
Public Function GetDetailAggregate() As String


This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the FDMSSettle component's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the FDMSDetailRecord component to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the CaptureFlag is false) the method throws an exception.

An example of how this method is used is shown below:

  if (FDMSRetail.ResponseCaptureFlag) {
    FDMSSettle.DetailRecords.Add(new FDMSRecordType(FDMSRetail.GetDetailAggregate()));

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