POST api/ApiMerchant/UploadSettlementInformation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SettlementFileName	string	None.
SettlementFileTransactionsList	Collection of SettlementFileTransaction	None.
SettlementFileResponseTransactionsList	Collection of SettlementFileResponseTransaction	None.
SettlementFileHeader	string	None.
SettlementFileTrailer	string	None.
TerminalId	string	None.
IsOperationSuccessful	boolean	None.
Message	string	None.
SetFrom	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SettlementFileName": "sample string 1",
  "SettlementFileTransactionsList": [
    {
      "RecordIndicator": "sample string 1",
      "TransType": "sample string 2",
      "CAN": "sample string 3",
      "TransHeader": "sample string 4",
      "TRP": "sample string 5",
      "DebitOption": "sample string 6",
      "PurseBeforeBalance": "sample string 7",
      "PurseBalance": "sample string 8",
      "CounterData": "sample string 9",
      "SignedCert": "sample string 10",
      "LastCreditTransTRP": "sample string 11",
      "LastCreditTransHeader": "sample string 12",
      "LastTransTRP": "sample string 13",
      "LastTransRecord": "sample string 14",
      "LastTransDebitOption": "sample string 15",
      "LastTransSignedCert": "sample string 16",
      "LastTransCounterData": "sample string 17",
      "SAMID": "sample string 18",
      "InvoiceReference": "sample string 19",
      "CreatedDate": "2026-03-12T21:24:12.8547302-07:00",
      "TransactionString": "sample string 21"
    },
    {
      "RecordIndicator": "sample string 1",
      "TransType": "sample string 2",
      "CAN": "sample string 3",
      "TransHeader": "sample string 4",
      "TRP": "sample string 5",
      "DebitOption": "sample string 6",
      "PurseBeforeBalance": "sample string 7",
      "PurseBalance": "sample string 8",
      "CounterData": "sample string 9",
      "SignedCert": "sample string 10",
      "LastCreditTransTRP": "sample string 11",
      "LastCreditTransHeader": "sample string 12",
      "LastTransTRP": "sample string 13",
      "LastTransRecord": "sample string 14",
      "LastTransDebitOption": "sample string 15",
      "LastTransSignedCert": "sample string 16",
      "LastTransCounterData": "sample string 17",
      "SAMID": "sample string 18",
      "InvoiceReference": "sample string 19",
      "CreatedDate": "2026-03-12T21:24:12.8547302-07:00",
      "TransactionString": "sample string 21"
    }
  ],
  "SettlementFileResponseTransactionsList": [
    {
      "InvoiceReference": "sample string 1"
    },
    {
      "InvoiceReference": "sample string 1"
    }
  ],
  "SettlementFileHeader": "sample string 2",
  "SettlementFileTrailer": "sample string 3",
  "TerminalId": "sample string 4",
  "IsOperationSuccessful": true,
  "Message": "sample string 6",
  "SetFrom": "sample string 7"
}

application/xml, text/xml

Sample:

<SettlementViewModel 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>
  <SettlementFileHeader>sample string 2</SettlementFileHeader>
  <SettlementFileName>sample string 1</SettlementFileName>
  <SettlementFileResponseTransactionsList>
    <SettlementFileResponseTransaction>
      <InvoiceReference>sample string 1</InvoiceReference>
    </SettlementFileResponseTransaction>
    <SettlementFileResponseTransaction>
      <InvoiceReference>sample string 1</InvoiceReference>
    </SettlementFileResponseTransaction>
  </SettlementFileResponseTransactionsList>
  <SettlementFileTrailer>sample string 3</SettlementFileTrailer>
  <SettlementFileTransactionsList>
    <SettlementFileTransaction>
      <CAN>sample string 3</CAN>
      <CounterData>sample string 9</CounterData>
      <CreatedDate>2026-03-12T21:24:12.8547302-07:00</CreatedDate>
      <DebitOption>sample string 6</DebitOption>
      <InvoiceReference>sample string 19</InvoiceReference>
      <LastCreditTransHeader>sample string 12</LastCreditTransHeader>
      <LastCreditTransTRP>sample string 11</LastCreditTransTRP>
      <LastTransCounterData>sample string 17</LastTransCounterData>
      <LastTransDebitOption>sample string 15</LastTransDebitOption>
      <LastTransRecord>sample string 14</LastTransRecord>
      <LastTransSignedCert>sample string 16</LastTransSignedCert>
      <LastTransTRP>sample string 13</LastTransTRP>
      <PurseBalance>sample string 8</PurseBalance>
      <PurseBeforeBalance>sample string 7</PurseBeforeBalance>
      <RecordIndicator>sample string 1</RecordIndicator>
      <SAMID>sample string 18</SAMID>
      <SignedCert>sample string 10</SignedCert>
      <TRP>sample string 5</TRP>
      <TransHeader>sample string 4</TransHeader>
      <TransType>sample string 2</TransType>
      <TransactionString>sample string 21</TransactionString>
    </SettlementFileTransaction>
    <SettlementFileTransaction>
      <CAN>sample string 3</CAN>
      <CounterData>sample string 9</CounterData>
      <CreatedDate>2026-03-12T21:24:12.8547302-07:00</CreatedDate>
      <DebitOption>sample string 6</DebitOption>
      <InvoiceReference>sample string 19</InvoiceReference>
      <LastCreditTransHeader>sample string 12</LastCreditTransHeader>
      <LastCreditTransTRP>sample string 11</LastCreditTransTRP>
      <LastTransCounterData>sample string 17</LastTransCounterData>
      <LastTransDebitOption>sample string 15</LastTransDebitOption>
      <LastTransRecord>sample string 14</LastTransRecord>
      <LastTransSignedCert>sample string 16</LastTransSignedCert>
      <LastTransTRP>sample string 13</LastTransTRP>
      <PurseBalance>sample string 8</PurseBalance>
      <PurseBeforeBalance>sample string 7</PurseBeforeBalance>
      <RecordIndicator>sample string 1</RecordIndicator>
      <SAMID>sample string 18</SAMID>
      <SignedCert>sample string 10</SignedCert>
      <TRP>sample string 5</TRP>
      <TransHeader>sample string 4</TransHeader>
      <TransType>sample string 2</TransType>
      <TransactionString>sample string 21</TransactionString>
    </SettlementFileTransaction>
  </SettlementFileTransactionsList>
  <TerminalId>sample string 4</TerminalId>
</SettlementViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SettlementViewModel

Name	Type	Additional information
SettlementFileName	string	None.
SettlementFileTransactionsList	Collection of SettlementFileTransaction	None.
SettlementFileResponseTransactionsList	Collection of SettlementFileResponseTransaction	None.
SettlementFileHeader	string	None.
SettlementFileTrailer	string	None.
TerminalId	string	None.
IsOperationSuccessful	boolean	None.
Message	string	None.
SetFrom	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SettlementFileName": "sample string 1",
  "SettlementFileTransactionsList": [
    {
      "RecordIndicator": "sample string 1",
      "TransType": "sample string 2",
      "CAN": "sample string 3",
      "TransHeader": "sample string 4",
      "TRP": "sample string 5",
      "DebitOption": "sample string 6",
      "PurseBeforeBalance": "sample string 7",
      "PurseBalance": "sample string 8",
      "CounterData": "sample string 9",
      "SignedCert": "sample string 10",
      "LastCreditTransTRP": "sample string 11",
      "LastCreditTransHeader": "sample string 12",
      "LastTransTRP": "sample string 13",
      "LastTransRecord": "sample string 14",
      "LastTransDebitOption": "sample string 15",
      "LastTransSignedCert": "sample string 16",
      "LastTransCounterData": "sample string 17",
      "SAMID": "sample string 18",
      "InvoiceReference": "sample string 19",
      "CreatedDate": "2026-03-12T21:24:12.8783486-07:00",
      "TransactionString": "sample string 21"
    },
    {
      "RecordIndicator": "sample string 1",
      "TransType": "sample string 2",
      "CAN": "sample string 3",
      "TransHeader": "sample string 4",
      "TRP": "sample string 5",
      "DebitOption": "sample string 6",
      "PurseBeforeBalance": "sample string 7",
      "PurseBalance": "sample string 8",
      "CounterData": "sample string 9",
      "SignedCert": "sample string 10",
      "LastCreditTransTRP": "sample string 11",
      "LastCreditTransHeader": "sample string 12",
      "LastTransTRP": "sample string 13",
      "LastTransRecord": "sample string 14",
      "LastTransDebitOption": "sample string 15",
      "LastTransSignedCert": "sample string 16",
      "LastTransCounterData": "sample string 17",
      "SAMID": "sample string 18",
      "InvoiceReference": "sample string 19",
      "CreatedDate": "2026-03-12T21:24:12.8783486-07:00",
      "TransactionString": "sample string 21"
    }
  ],
  "SettlementFileResponseTransactionsList": [
    {
      "InvoiceReference": "sample string 1"
    },
    {
      "InvoiceReference": "sample string 1"
    }
  ],
  "SettlementFileHeader": "sample string 2",
  "SettlementFileTrailer": "sample string 3",
  "TerminalId": "sample string 4",
  "IsOperationSuccessful": true,
  "Message": "sample string 6",
  "SetFrom": "sample string 7"
}

application/xml, text/xml

Sample:

<SettlementViewModel 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>
  <SettlementFileHeader>sample string 2</SettlementFileHeader>
  <SettlementFileName>sample string 1</SettlementFileName>
  <SettlementFileResponseTransactionsList>
    <SettlementFileResponseTransaction>
      <InvoiceReference>sample string 1</InvoiceReference>
    </SettlementFileResponseTransaction>
    <SettlementFileResponseTransaction>
      <InvoiceReference>sample string 1</InvoiceReference>
    </SettlementFileResponseTransaction>
  </SettlementFileResponseTransactionsList>
  <SettlementFileTrailer>sample string 3</SettlementFileTrailer>
  <SettlementFileTransactionsList>
    <SettlementFileTransaction>
      <CAN>sample string 3</CAN>
      <CounterData>sample string 9</CounterData>
      <CreatedDate>2026-03-12T21:24:12.8783486-07:00</CreatedDate>
      <DebitOption>sample string 6</DebitOption>
      <InvoiceReference>sample string 19</InvoiceReference>
      <LastCreditTransHeader>sample string 12</LastCreditTransHeader>
      <LastCreditTransTRP>sample string 11</LastCreditTransTRP>
      <LastTransCounterData>sample string 17</LastTransCounterData>
      <LastTransDebitOption>sample string 15</LastTransDebitOption>
      <LastTransRecord>sample string 14</LastTransRecord>
      <LastTransSignedCert>sample string 16</LastTransSignedCert>
      <LastTransTRP>sample string 13</LastTransTRP>
      <PurseBalance>sample string 8</PurseBalance>
      <PurseBeforeBalance>sample string 7</PurseBeforeBalance>
      <RecordIndicator>sample string 1</RecordIndicator>
      <SAMID>sample string 18</SAMID>
      <SignedCert>sample string 10</SignedCert>
      <TRP>sample string 5</TRP>
      <TransHeader>sample string 4</TransHeader>
      <TransType>sample string 2</TransType>
      <TransactionString>sample string 21</TransactionString>
    </SettlementFileTransaction>
    <SettlementFileTransaction>
      <CAN>sample string 3</CAN>
      <CounterData>sample string 9</CounterData>
      <CreatedDate>2026-03-12T21:24:12.8783486-07:00</CreatedDate>
      <DebitOption>sample string 6</DebitOption>
      <InvoiceReference>sample string 19</InvoiceReference>
      <LastCreditTransHeader>sample string 12</LastCreditTransHeader>
      <LastCreditTransTRP>sample string 11</LastCreditTransTRP>
      <LastTransCounterData>sample string 17</LastTransCounterData>
      <LastTransDebitOption>sample string 15</LastTransDebitOption>
      <LastTransRecord>sample string 14</LastTransRecord>
      <LastTransSignedCert>sample string 16</LastTransSignedCert>
      <LastTransTRP>sample string 13</LastTransTRP>
      <PurseBalance>sample string 8</PurseBalance>
      <PurseBeforeBalance>sample string 7</PurseBeforeBalance>
      <RecordIndicator>sample string 1</RecordIndicator>
      <SAMID>sample string 18</SAMID>
      <SignedCert>sample string 10</SignedCert>
      <TRP>sample string 5</TRP>
      <TransHeader>sample string 4</TransHeader>
      <TransType>sample string 2</TransType>
      <TransactionString>sample string 21</TransactionString>
    </SettlementFileTransaction>
  </SettlementFileTransactionsList>
  <TerminalId>sample string 4</TerminalId>
</SettlementViewModel>