POST api/ApiMerchant/GetSettlementHistory

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:23:19.9022873-07:00",
  "EndDate": "2026-03-12T21:23:19.9022873-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:23:19.9022873-07:00</EndDate>
  <FileName>sample string 4</FileName>
  <StartDate>2026-03-12T21:23:19.9022873-07:00</StartDate>
  <TerminalId>sample string 3</TerminalId>
</SettlementReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SettlementHistoryResponse

Name	Type	Additional information
SettlementFileList	Collection of SettlementFileResponse	None.
IsOperationSuccessful	boolean	None.
Message	string	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SettlementFileList": [
    {
      "SettlementFileId": "46d30b77-5031-4247-9196-ed1604156696",
      "RecordCount": 2,
      "FileStatus": "sample string 3",
      "FileDate": "2026-03-12T21:23:19.9179179-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:23:19.9179179-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": "7915af4c-b2b4-4d9e-8a94-9dc8bd240fc9",
          "SettlementFileId": "c72bc690-58fc-4f6a-8100-87d897d5b171",
          "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": "7915af4c-b2b4-4d9e-8a94-9dc8bd240fc9",
          "SettlementFileId": "c72bc690-58fc-4f6a-8100-87d897d5b171",
          "Status": "sample string 15",
          "Remarks": "sample string 16"
        }
      ],
      "IsOperationSuccessful": true,
      "Message": "sample string 15",
      "Success": true
    },
    {
      "SettlementFileId": "46d30b77-5031-4247-9196-ed1604156696",
      "RecordCount": 2,
      "FileStatus": "sample string 3",
      "FileDate": "2026-03-12T21:23:19.9179179-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:23:19.9179179-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": "7915af4c-b2b4-4d9e-8a94-9dc8bd240fc9",
          "SettlementFileId": "c72bc690-58fc-4f6a-8100-87d897d5b171",
          "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": "7915af4c-b2b4-4d9e-8a94-9dc8bd240fc9",
          "SettlementFileId": "c72bc690-58fc-4f6a-8100-87d897d5b171",
          "Status": "sample string 15",
          "Remarks": "sample string 16"
        }
      ],
      "IsOperationSuccessful": true,
      "Message": "sample string 15",
      "Success": true
    }
  ],
  "IsOperationSuccessful": true,
  "Message": "sample string 2",
  "Success": true
}

application/xml, text/xml

Sample:

<SettlementHistoryResponse 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 2</Message>
  <Success>true</Success>
  <SettlementFileList>
    <SettlementFileResponse>
      <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:23:19.9179179-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:23:19.9179179-07:00</SettlementDate>
      <SettlementFileId>46d30b77-5031-4247-9196-ed1604156696</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>7915af4c-b2b4-4d9e-8a94-9dc8bd240fc9</RecordId>
          <RecordRemarks>sample string 8</RecordRemarks>
          <RecordStatus>sample string 7</RecordStatus>
          <Remarks>sample string 16</Remarks>
          <SettlementFileId>c72bc690-58fc-4f6a-8100-87d897d5b171</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>7915af4c-b2b4-4d9e-8a94-9dc8bd240fc9</RecordId>
          <RecordRemarks>sample string 8</RecordRemarks>
          <RecordStatus>sample string 7</RecordStatus>
          <Remarks>sample string 16</Remarks>
          <SettlementFileId>c72bc690-58fc-4f6a-8100-87d897d5b171</SettlementFileId>
          <Status>sample string 15</Status>
          <TRP>sample string 3</TRP>
          <TransHeader>sample string 2</TransHeader>
        </SettlementTransaction>
      </SettlementTransactionList>
    </SettlementFileResponse>
    <SettlementFileResponse>
      <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:23:19.9179179-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:23:19.9179179-07:00</SettlementDate>
      <SettlementFileId>46d30b77-5031-4247-9196-ed1604156696</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>7915af4c-b2b4-4d9e-8a94-9dc8bd240fc9</RecordId>
          <RecordRemarks>sample string 8</RecordRemarks>
          <RecordStatus>sample string 7</RecordStatus>
          <Remarks>sample string 16</Remarks>
          <SettlementFileId>c72bc690-58fc-4f6a-8100-87d897d5b171</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>7915af4c-b2b4-4d9e-8a94-9dc8bd240fc9</RecordId>
          <RecordRemarks>sample string 8</RecordRemarks>
          <RecordStatus>sample string 7</RecordStatus>
          <Remarks>sample string 16</Remarks>
          <SettlementFileId>c72bc690-58fc-4f6a-8100-87d897d5b171</SettlementFileId>
          <Status>sample string 15</Status>
          <TRP>sample string 3</TRP>
          <TransHeader>sample string 2</TransHeader>
        </SettlementTransaction>
      </SettlementTransactionList>
    </SettlementFileResponse>
  </SettlementFileList>
</SettlementHistoryResponse>