POST api/ApiMerchant/GetSettlementHistoryDetail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
StartDate	date	None.
EndDate	date	None.
TerminalId	string	None.
FileName	string	None.
IsOperationSuccessful	boolean	None.
Message	string	None.
SetFrom	string	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2026-03-12T21:24:23.0067274-07:00",
  "EndDate": "2026-03-12T21:24:23.0067274-07:00",
  "TerminalId": "sample string 3",
  "FileName": "sample string 4",
  "IsOperationSuccessful": true,
  "Message": "sample string 6",
  "SetFrom": "sample string 7"
}

application/xml, text/xml

Sample:

<SettlementReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TradeEstate.BLL.ViewModels">
  <IsOperationSuccessful>true</IsOperationSuccessful>
  <Message>sample string 6</Message>
  <SetFrom>sample string 7</SetFrom>
  <EndDate>2026-03-12T21:24:23.0067274-07:00</EndDate>
  <FileName>sample string 4</FileName>
  <StartDate>2026-03-12T21:24:23.0067274-07:00</StartDate>
  <TerminalId>sample string 3</TerminalId>
</SettlementReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SettlementFileResponse

Name	Type	Additional information
SettlementFileId	globally unique identifier	None.
RecordCount	integer	None.
FileStatus	string	None.
FileDate	date	None.
AcknowledgementFileName	string	None.
AcknowledgementFileHeader	string	None.
AcknowledgementFileTrailer	string	None.
AcknowledgementFileData	string	None.
AcknowledgementFileRecordReceived	integer	None.
AcknowledgementFileDetails	string	None.
AcknowledgementFileStatus	string	None.
ReconciliationFileName	string	None.
ReconciliationFileHeader	string	None.
ReconciliationFileTrailer	string	None.
ReconciliationFileRecordCount	integer	None.
ReconciliationFileTotalAmount	decimal number	None.
ReconciliationFileSettledRecordCount	integer	None.
ReconciliationFileTotalAmountSettled	decimal number	None.
ReconciliationFileRejectedRecordCount	integer	None.
ReconciliationFileRejectedAmount	decimal number	None.
SettlementDate	date	None.
SettlementTransactionList	Collection of SettlementTransaction	None.
IsOperationSuccessful	boolean	None.
Message	string	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SettlementFileId": "b47d5294-9421-4aa2-ae03-42d5a1b81e87",
  "RecordCount": 2,
  "FileStatus": "sample string 3",
  "FileDate": "2026-03-12T21:24:23.0067274-07:00",
  "AcknowledgementFileName": "sample string 5",
  "AcknowledgementFileHeader": "sample string 6",
  "AcknowledgementFileTrailer": "sample string 7",
  "AcknowledgementFileData": "sample string 8",
  "AcknowledgementFileRecordReceived": 1,
  "AcknowledgementFileDetails": "sample string 9",
  "AcknowledgementFileStatus": "sample string 10",
  "ReconciliationFileName": "sample string 11",
  "ReconciliationFileHeader": "sample string 12",
  "ReconciliationFileTrailer": "sample string 13",
  "ReconciliationFileRecordCount": 1,
  "ReconciliationFileTotalAmount": 1.0,
  "ReconciliationFileSettledRecordCount": 1,
  "ReconciliationFileTotalAmountSettled": 1.0,
  "ReconciliationFileRejectedRecordCount": 1,
  "ReconciliationFileRejectedAmount": 1.0,
  "SettlementDate": "2026-03-12T21:24:23.0067274-07:00",
  "SettlementTransactionList": [
    {
      "CAN": "sample string 1",
      "TransHeader": "sample string 2",
      "TRP": "sample string 3",
      "InvoiceReference": "sample string 4",
      "Detail": "sample string 5",
      "Record": "sample string 6",
      "RecordStatus": "sample string 7",
      "RecordRemarks": "sample string 8",
      "ReconciliationRecord": "sample string 9",
      "ReconciliationDetail": "sample string 10",
      "ReconciliationStatus": "sample string 11",
      "ReconciliationRemarks": "sample string 12",
      "RecordId": "7b413301-cc1d-4bb0-9624-4e570f41ac99",
      "SettlementFileId": "24974e07-9e5b-4c68-90e9-2241697564b4",
      "Status": "sample string 15",
      "Remarks": "sample string 16"
    },
    {
      "CAN": "sample string 1",
      "TransHeader": "sample string 2",
      "TRP": "sample string 3",
      "InvoiceReference": "sample string 4",
      "Detail": "sample string 5",
      "Record": "sample string 6",
      "RecordStatus": "sample string 7",
      "RecordRemarks": "sample string 8",
      "ReconciliationRecord": "sample string 9",
      "ReconciliationDetail": "sample string 10",
      "ReconciliationStatus": "sample string 11",
      "ReconciliationRemarks": "sample string 12",
      "RecordId": "7b413301-cc1d-4bb0-9624-4e570f41ac99",
      "SettlementFileId": "24974e07-9e5b-4c68-90e9-2241697564b4",
      "Status": "sample string 15",
      "Remarks": "sample string 16"
    }
  ],
  "IsOperationSuccessful": true,
  "Message": "sample string 15",
  "Success": true
}

application/xml, text/xml

Sample:

<SettlementFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TradeEstate.BLL.Responses">
  <IsOperationSuccessful>true</IsOperationSuccessful>
  <Message>sample string 15</Message>
  <Success>true</Success>
  <AcknowledgementFileData>sample string 8</AcknowledgementFileData>
  <AcknowledgementFileDetails>sample string 9</AcknowledgementFileDetails>
  <AcknowledgementFileHeader>sample string 6</AcknowledgementFileHeader>
  <AcknowledgementFileName>sample string 5</AcknowledgementFileName>
  <AcknowledgementFileRecordReceived>1</AcknowledgementFileRecordReceived>
  <AcknowledgementFileStatus>sample string 10</AcknowledgementFileStatus>
  <AcknowledgementFileTrailer>sample string 7</AcknowledgementFileTrailer>
  <FileDate>2026-03-12T21:24:23.0067274-07:00</FileDate>
  <FileStatus>sample string 3</FileStatus>
  <ReconciliationFileHeader>sample string 12</ReconciliationFileHeader>
  <ReconciliationFileName>sample string 11</ReconciliationFileName>
  <ReconciliationFileRecordCount>1</ReconciliationFileRecordCount>
  <ReconciliationFileRejectedAmount>1</ReconciliationFileRejectedAmount>
  <ReconciliationFileRejectedRecordCount>1</ReconciliationFileRejectedRecordCount>
  <ReconciliationFileSettledRecordCount>1</ReconciliationFileSettledRecordCount>
  <ReconciliationFileTotalAmount>1</ReconciliationFileTotalAmount>
  <ReconciliationFileTotalAmountSettled>1</ReconciliationFileTotalAmountSettled>
  <ReconciliationFileTrailer>sample string 13</ReconciliationFileTrailer>
  <RecordCount>2</RecordCount>
  <SettlementDate>2026-03-12T21:24:23.0067274-07:00</SettlementDate>
  <SettlementFileId>b47d5294-9421-4aa2-ae03-42d5a1b81e87</SettlementFileId>
  <SettlementTransactionList>
    <SettlementTransaction>
      <CAN>sample string 1</CAN>
      <Detail>sample string 5</Detail>
      <InvoiceReference>sample string 4</InvoiceReference>
      <ReconciliationDetail>sample string 10</ReconciliationDetail>
      <ReconciliationRecord>sample string 9</ReconciliationRecord>
      <ReconciliationRemarks>sample string 12</ReconciliationRemarks>
      <ReconciliationStatus>sample string 11</ReconciliationStatus>
      <Record>sample string 6</Record>
      <RecordId>7b413301-cc1d-4bb0-9624-4e570f41ac99</RecordId>
      <RecordRemarks>sample string 8</RecordRemarks>
      <RecordStatus>sample string 7</RecordStatus>
      <Remarks>sample string 16</Remarks>
      <SettlementFileId>24974e07-9e5b-4c68-90e9-2241697564b4</SettlementFileId>
      <Status>sample string 15</Status>
      <TRP>sample string 3</TRP>
      <TransHeader>sample string 2</TransHeader>
    </SettlementTransaction>
    <SettlementTransaction>
      <CAN>sample string 1</CAN>
      <Detail>sample string 5</Detail>
      <InvoiceReference>sample string 4</InvoiceReference>
      <ReconciliationDetail>sample string 10</ReconciliationDetail>
      <ReconciliationRecord>sample string 9</ReconciliationRecord>
      <ReconciliationRemarks>sample string 12</ReconciliationRemarks>
      <ReconciliationStatus>sample string 11</ReconciliationStatus>
      <Record>sample string 6</Record>
      <RecordId>7b413301-cc1d-4bb0-9624-4e570f41ac99</RecordId>
      <RecordRemarks>sample string 8</RecordRemarks>
      <RecordStatus>sample string 7</RecordStatus>
      <Remarks>sample string 16</Remarks>
      <SettlementFileId>24974e07-9e5b-4c68-90e9-2241697564b4</SettlementFileId>
      <Status>sample string 15</Status>
      <TRP>sample string 3</TRP>
      <TransHeader>sample string 2</TransHeader>
    </SettlementTransaction>
  </SettlementTransactionList>
</SettlementFileResponse>