POST api/Merchant/v1/GetSettlementTransactions

Method returns all settlement transactions paid for payment provider during given date interval.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
paymentProviderId	Id of payment provider (M)	globally unique identifier	None.
startDate	Start date of transactions returned. If null Today - 30 days used.	date	None.
endDate	End date of transactions returned. If null Today used.	date	None.
OrganizationCode		string	None.
UserName		string	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

{
  "paymentProviderId": "bbed73aa-3aa4-41db-9c9d-78cb55624fb4",
  "startDate": "2025-06-26T17:19:40.0921041+00:00",
  "endDate": "2025-06-26T17:19:40.0921041+00:00",
  "OrganizationCode": "sample string 2",
  "UserName": "sample string 3",
  "Password": "sample string 4"
}

application/xml, text/xml

Sample:

<GetSettlementTransactionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.Merchant">
  <OrganizationCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</OrganizationCode>
  <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Password>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</UserName>
  <endDate>2025-06-26T17:19:40.0921041+00:00</endDate>
  <paymentProviderId>bbed73aa-3aa4-41db-9c9d-78cb55624fb4</paymentProviderId>
  <startDate>2025-06-26T17:19:40.0921041+00:00</startDate>
</GetSettlementTransactionsRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetSettlementTransactionsRequest'.

Response Information

Resource Description

GetSettlementTransactionsReply

Name	Type	Additional information
Reply	Collection of AccountTransaction	None.
Ok	boolean	None.
ErrorMessage	string	None.
ErrorCode	string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Reply": [
    {
      "Id": "ef9c52dd-77e0-4006-a562-4f3ab101c746",
      "AccountNumber": "sample string 2",
      "AccountTransactionNumber": "sample string 3",
      "AccountId": "21a7db20-d3da-4fec-b68e-40558b37b661",
      "PaymentProviderId": "b085cf4f-3e2d-40fd-bf72-07f43e2555ab",
      "CurrencyCode": "sample string 6",
      "Amount": 7.0,
      "BookingDate": "2025-06-26T17:19:40.1073685+00:00",
      "ValueDate": "2025-06-26T17:19:40.1073685+00:00",
      "PaymentDate": "2025-06-26T17:19:40.1073685+00:00",
      "RegistrationTime": "2025-06-26T17:19:40.1073685+00:00",
      "ReverseTime": "2025-06-26T17:19:40.1073685+00:00",
      "Description": "sample string 12",
      "SettlementTransactiontId": "20620134-92f2-4e0d-aae3-cd512a0de12e",
      "PaymentProviderPurchaseNumber": "sample string 13",
      "ReferenceNumber": "sample string 14"
    },
    {
      "Id": "ef9c52dd-77e0-4006-a562-4f3ab101c746",
      "AccountNumber": "sample string 2",
      "AccountTransactionNumber": "sample string 3",
      "AccountId": "21a7db20-d3da-4fec-b68e-40558b37b661",
      "PaymentProviderId": "b085cf4f-3e2d-40fd-bf72-07f43e2555ab",
      "CurrencyCode": "sample string 6",
      "Amount": 7.0,
      "BookingDate": "2025-06-26T17:19:40.1073685+00:00",
      "ValueDate": "2025-06-26T17:19:40.1073685+00:00",
      "PaymentDate": "2025-06-26T17:19:40.1073685+00:00",
      "RegistrationTime": "2025-06-26T17:19:40.1073685+00:00",
      "ReverseTime": "2025-06-26T17:19:40.1073685+00:00",
      "Description": "sample string 12",
      "SettlementTransactiontId": "20620134-92f2-4e0d-aae3-cd512a0de12e",
      "PaymentProviderPurchaseNumber": "sample string 13",
      "ReferenceNumber": "sample string 14"
    }
  ],
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<GetSettlementTransactionsReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.Merchant">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Message>
  <Ok xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">true</Ok>
  <Reply>
    <AccountTransaction>
      <AccountId>21a7db20-d3da-4fec-b68e-40558b37b661</AccountId>
      <AccountNumber>sample string 2</AccountNumber>
      <AccountTransactionNumber>sample string 3</AccountTransactionNumber>
      <Amount>7</Amount>
      <BookingDate>2025-06-26T17:19:40.1073685+00:00</BookingDate>
      <CurrencyCode>sample string 6</CurrencyCode>
      <Description>sample string 12</Description>
      <Id>ef9c52dd-77e0-4006-a562-4f3ab101c746</Id>
      <PaymentDate>2025-06-26T17:19:40.1073685+00:00</PaymentDate>
      <PaymentProviderId>b085cf4f-3e2d-40fd-bf72-07f43e2555ab</PaymentProviderId>
      <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber>
      <ReferenceNumber>sample string 14</ReferenceNumber>
      <RegistrationTime>2025-06-26T17:19:40.1073685+00:00</RegistrationTime>
      <ReverseTime>2025-06-26T17:19:40.1073685+00:00</ReverseTime>
      <SettlementTransactiontId>20620134-92f2-4e0d-aae3-cd512a0de12e</SettlementTransactiontId>
      <ValueDate>2025-06-26T17:19:40.1073685+00:00</ValueDate>
    </AccountTransaction>
    <AccountTransaction>
      <AccountId>21a7db20-d3da-4fec-b68e-40558b37b661</AccountId>
      <AccountNumber>sample string 2</AccountNumber>
      <AccountTransactionNumber>sample string 3</AccountTransactionNumber>
      <Amount>7</Amount>
      <BookingDate>2025-06-26T17:19:40.1073685+00:00</BookingDate>
      <CurrencyCode>sample string 6</CurrencyCode>
      <Description>sample string 12</Description>
      <Id>ef9c52dd-77e0-4006-a562-4f3ab101c746</Id>
      <PaymentDate>2025-06-26T17:19:40.1073685+00:00</PaymentDate>
      <PaymentProviderId>b085cf4f-3e2d-40fd-bf72-07f43e2555ab</PaymentProviderId>
      <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber>
      <ReferenceNumber>sample string 14</ReferenceNumber>
      <RegistrationTime>2025-06-26T17:19:40.1073685+00:00</RegistrationTime>
      <ReverseTime>2025-06-26T17:19:40.1073685+00:00</ReverseTime>
      <SettlementTransactiontId>20620134-92f2-4e0d-aae3-cd512a0de12e</SettlementTransactiontId>
      <ValueDate>2025-06-26T17:19:40.1073685+00:00</ValueDate>
    </AccountTransaction>
  </Reply>
</GetSettlementTransactionsReply>