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
GetAccountStatementRequestName | 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": "23afebca-b472-45e7-a715-ba7e088a29a0", "accountId": "35871afa-f3ce-4142-90ce-2ca44e850ef1", "startDate": "2025-08-29T15:37:25.5832085+00:00", "endDate": "2025-08-29T15:37:25.5832085+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>35871afa-f3ce-4142-90ce-2ca44e850ef1</accountId> <endDate>2025-08-29T15:37:25.5832085+00:00</endDate> <paymentProviderId>23afebca-b472-45e7-a715-ba7e088a29a0</paymentProviderId> <startDate>2025-08-29T15:37:25.5832085+00:00</startDate> <transactionCount>1</transactionCount> </GetAccountStatementRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
GetAccountStatementReplyName | Description | 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": "40491ffb-f26c-4132-8f40-4b04f6ef627e", "AccountNumber": "sample string 2", "AccountTransactionNumber": "sample string 3", "AccountId": "dbf97642-2a88-4a9e-b31d-22717690f665", "PaymentProviderId": "33df8cf1-32ee-42cc-a10b-962d58391760", "CurrencyCode": "sample string 6", "Amount": 7.0, "BookingDate": "2025-08-29T15:37:25.598761+00:00", "ValueDate": "2025-08-29T15:37:25.598761+00:00", "PaymentDate": "2025-08-29T15:37:25.598761+00:00", "RegistrationTime": "2025-08-29T15:37:25.598761+00:00", "ReverseTime": "2025-08-29T15:37:25.598761+00:00", "Description": "sample string 12", "SettlementTransactiontId": "ff5948c9-8f69-4bc5-982f-d9ea378ca9ce", "PaymentProviderPurchaseNumber": "sample string 13", "ReferenceNumber": "sample string 14" }, { "Id": "40491ffb-f26c-4132-8f40-4b04f6ef627e", "AccountNumber": "sample string 2", "AccountTransactionNumber": "sample string 3", "AccountId": "dbf97642-2a88-4a9e-b31d-22717690f665", "PaymentProviderId": "33df8cf1-32ee-42cc-a10b-962d58391760", "CurrencyCode": "sample string 6", "Amount": 7.0, "BookingDate": "2025-08-29T15:37:25.598761+00:00", "ValueDate": "2025-08-29T15:37:25.598761+00:00", "PaymentDate": "2025-08-29T15:37:25.598761+00:00", "RegistrationTime": "2025-08-29T15:37:25.598761+00:00", "ReverseTime": "2025-08-29T15:37:25.598761+00:00", "Description": "sample string 12", "SettlementTransactiontId": "ff5948c9-8f69-4bc5-982f-d9ea378ca9ce", "PaymentProviderPurchaseNumber": "sample string 13", "ReferenceNumber": "sample string 14" } ], "StartBalance": 1.0, "EndBalance": 2.0, "StartDate": "2025-08-29T15:37:25.598761+00:00", "EndDate": "2025-08-29T15:37:25.598761+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>dbf97642-2a88-4a9e-b31d-22717690f665</AccountId> <AccountNumber>sample string 2</AccountNumber> <AccountTransactionNumber>sample string 3</AccountTransactionNumber> <Amount>7</Amount> <BookingDate>2025-08-29T15:37:25.598761+00:00</BookingDate> <CurrencyCode>sample string 6</CurrencyCode> <Description>sample string 12</Description> <Id>40491ffb-f26c-4132-8f40-4b04f6ef627e</Id> <PaymentDate>2025-08-29T15:37:25.598761+00:00</PaymentDate> <PaymentProviderId>33df8cf1-32ee-42cc-a10b-962d58391760</PaymentProviderId> <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber> <ReferenceNumber>sample string 14</ReferenceNumber> <RegistrationTime>2025-08-29T15:37:25.598761+00:00</RegistrationTime> <ReverseTime>2025-08-29T15:37:25.598761+00:00</ReverseTime> <SettlementTransactiontId>ff5948c9-8f69-4bc5-982f-d9ea378ca9ce</SettlementTransactiontId> <ValueDate>2025-08-29T15:37:25.598761+00:00</ValueDate> </AccountTransaction> <AccountTransaction> <AccountId>dbf97642-2a88-4a9e-b31d-22717690f665</AccountId> <AccountNumber>sample string 2</AccountNumber> <AccountTransactionNumber>sample string 3</AccountTransactionNumber> <Amount>7</Amount> <BookingDate>2025-08-29T15:37:25.598761+00:00</BookingDate> <CurrencyCode>sample string 6</CurrencyCode> <Description>sample string 12</Description> <Id>40491ffb-f26c-4132-8f40-4b04f6ef627e</Id> <PaymentDate>2025-08-29T15:37:25.598761+00:00</PaymentDate> <PaymentProviderId>33df8cf1-32ee-42cc-a10b-962d58391760</PaymentProviderId> <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber> <ReferenceNumber>sample string 14</ReferenceNumber> <RegistrationTime>2025-08-29T15:37:25.598761+00:00</RegistrationTime> <ReverseTime>2025-08-29T15:37:25.598761+00:00</ReverseTime> <SettlementTransactiontId>ff5948c9-8f69-4bc5-982f-d9ea378ca9ce</SettlementTransactiontId> <ValueDate>2025-08-29T15:37:25.598761+00:00</ValueDate> </AccountTransaction> </AccountTransactions> <EndBalance>2</EndBalance> <EndDate>2025-08-29T15:37:25.598761+00:00</EndDate> <StartBalance>1</StartBalance> <StartDate>2025-08-29T15:37:25.598761+00:00</StartDate> </Reply> </GetAccountStatementReply>