POST api/Merchant/v1/GetAccountStatement

Method returns account transactions and balances for payment provider settlement account for 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.
accountId	Id of account. If null, all payment provider accounts returned.	globally unique identifier	None.
startDate	Start date of transactions returned (M)	date	None.
endDate	End date of transactions returned (M)	date	None.
transactionCount	Returned max transaction count- If null, all transactions returned	integer	None.
OrganizationCode		string	None.
UserName		string	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

{
  "paymentProviderId": "e6011a57-33b1-4879-a337-f3db5716ceb0",
  "accountId": "019b323d-1886-4dee-963d-cc0f986b89d3",
  "startDate": "2025-05-02T01:56:11.7201951+00:00",
  "endDate": "2025-05-02T01:56:11.7201951+00:00",
  "transactionCount": 1,
  "OrganizationCode": "sample string 4",
  "UserName": "sample string 5",
  "Password": "sample string 6"
}

application/xml, text/xml

Sample:

<GetAccountStatementRequest 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 4</OrganizationCode>
  <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 6</Password>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 5</UserName>
  <accountId>019b323d-1886-4dee-963d-cc0f986b89d3</accountId>
  <endDate>2025-05-02T01:56:11.7201951+00:00</endDate>
  <paymentProviderId>e6011a57-33b1-4879-a337-f3db5716ceb0</paymentProviderId>
  <startDate>2025-05-02T01:56:11.7201951+00:00</startDate>
  <transactionCount>1</transactionCount>
</GetAccountStatementRequest>

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 'GetAccountStatementRequest'.

Response Information

Resource Description

GetAccountStatementReply

Name	Type	Additional information
Reply	AccountStatement	None.
Ok	boolean	None.
ErrorMessage	string	None.
ErrorCode	string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Reply": {
    "AccountTransactions": [
      {
        "Id": "a1ce5e42-372f-4593-aedb-26a76cca967b",
        "AccountNumber": "sample string 2",
        "AccountTransactionNumber": "sample string 3",
        "AccountId": "6c6627c0-9b58-4c53-bba2-db4c95e758cb",
        "PaymentProviderId": "a6d22717-8a62-45ad-ab5c-d34f825e7dd8",
        "CurrencyCode": "sample string 6",
        "Amount": 7.0,
        "BookingDate": "2025-05-02T01:56:11.7201951+00:00",
        "ValueDate": "2025-05-02T01:56:11.7201951+00:00",
        "PaymentDate": "2025-05-02T01:56:11.7201951+00:00",
        "RegistrationTime": "2025-05-02T01:56:11.7201951+00:00",
        "ReverseTime": "2025-05-02T01:56:11.7201951+00:00",
        "Description": "sample string 12",
        "SettlementTransactiontId": "bb81cc68-dbf8-41d8-bed3-3f0770b1b329",
        "PaymentProviderPurchaseNumber": "sample string 13",
        "ReferenceNumber": "sample string 14"
      },
      {
        "Id": "a1ce5e42-372f-4593-aedb-26a76cca967b",
        "AccountNumber": "sample string 2",
        "AccountTransactionNumber": "sample string 3",
        "AccountId": "6c6627c0-9b58-4c53-bba2-db4c95e758cb",
        "PaymentProviderId": "a6d22717-8a62-45ad-ab5c-d34f825e7dd8",
        "CurrencyCode": "sample string 6",
        "Amount": 7.0,
        "BookingDate": "2025-05-02T01:56:11.7201951+00:00",
        "ValueDate": "2025-05-02T01:56:11.7201951+00:00",
        "PaymentDate": "2025-05-02T01:56:11.7201951+00:00",
        "RegistrationTime": "2025-05-02T01:56:11.7201951+00:00",
        "ReverseTime": "2025-05-02T01:56:11.7201951+00:00",
        "Description": "sample string 12",
        "SettlementTransactiontId": "bb81cc68-dbf8-41d8-bed3-3f0770b1b329",
        "PaymentProviderPurchaseNumber": "sample string 13",
        "ReferenceNumber": "sample string 14"
      }
    ],
    "StartBalance": 1.0,
    "EndBalance": 2.0,
    "StartDate": "2025-05-02T01:56:11.7201951+00:00",
    "EndDate": "2025-05-02T01:56:11.7201951+00:00"
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<GetAccountStatementReply 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>
    <AccountTransactions>
      <AccountTransaction>
        <AccountId>6c6627c0-9b58-4c53-bba2-db4c95e758cb</AccountId>
        <AccountNumber>sample string 2</AccountNumber>
        <AccountTransactionNumber>sample string 3</AccountTransactionNumber>
        <Amount>7</Amount>
        <BookingDate>2025-05-02T01:56:11.7201951+00:00</BookingDate>
        <CurrencyCode>sample string 6</CurrencyCode>
        <Description>sample string 12</Description>
        <Id>a1ce5e42-372f-4593-aedb-26a76cca967b</Id>
        <PaymentDate>2025-05-02T01:56:11.7201951+00:00</PaymentDate>
        <PaymentProviderId>a6d22717-8a62-45ad-ab5c-d34f825e7dd8</PaymentProviderId>
        <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber>
        <ReferenceNumber>sample string 14</ReferenceNumber>
        <RegistrationTime>2025-05-02T01:56:11.7201951+00:00</RegistrationTime>
        <ReverseTime>2025-05-02T01:56:11.7201951+00:00</ReverseTime>
        <SettlementTransactiontId>bb81cc68-dbf8-41d8-bed3-3f0770b1b329</SettlementTransactiontId>
        <ValueDate>2025-05-02T01:56:11.7201951+00:00</ValueDate>
      </AccountTransaction>
      <AccountTransaction>
        <AccountId>6c6627c0-9b58-4c53-bba2-db4c95e758cb</AccountId>
        <AccountNumber>sample string 2</AccountNumber>
        <AccountTransactionNumber>sample string 3</AccountTransactionNumber>
        <Amount>7</Amount>
        <BookingDate>2025-05-02T01:56:11.7201951+00:00</BookingDate>
        <CurrencyCode>sample string 6</CurrencyCode>
        <Description>sample string 12</Description>
        <Id>a1ce5e42-372f-4593-aedb-26a76cca967b</Id>
        <PaymentDate>2025-05-02T01:56:11.7201951+00:00</PaymentDate>
        <PaymentProviderId>a6d22717-8a62-45ad-ab5c-d34f825e7dd8</PaymentProviderId>
        <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber>
        <ReferenceNumber>sample string 14</ReferenceNumber>
        <RegistrationTime>2025-05-02T01:56:11.7201951+00:00</RegistrationTime>
        <ReverseTime>2025-05-02T01:56:11.7201951+00:00</ReverseTime>
        <SettlementTransactiontId>bb81cc68-dbf8-41d8-bed3-3f0770b1b329</SettlementTransactiontId>
        <ValueDate>2025-05-02T01:56:11.7201951+00:00</ValueDate>
      </AccountTransaction>
    </AccountTransactions>
    <EndBalance>2</EndBalance>
    <EndDate>2025-05-02T01:56:11.7201951+00:00</EndDate>
    <StartBalance>1</StartBalance>
    <StartDate>2025-05-02T01:56:11.7201951+00:00</StartDate>
  </Reply>
</GetAccountStatementReply>