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
GetSettlementTransactionsRequestName | 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": "6f380fd0-f390-4d6f-b198-a70eaa3cc8eb", "startDate": "2025-08-31T16:12:02.2402249+00:00", "endDate": "2025-08-31T16:12:02.2402249+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-08-31T16:12:02.2402249+00:00</endDate> <paymentProviderId>6f380fd0-f390-4d6f-b198-a70eaa3cc8eb</paymentProviderId> <startDate>2025-08-31T16:12:02.2402249+00:00</startDate> </GetSettlementTransactionsRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
GetSettlementTransactionsReplyName | Description | 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": "d4740559-3ee9-4fe5-b58f-4b2c869c4e57", "AccountNumber": "sample string 2", "AccountTransactionNumber": "sample string 3", "AccountId": "18814c67-4577-4c88-a47b-c95f4b0be891", "PaymentProviderId": "8b1cfebe-7ab0-4c39-acb3-b79eb964279c", "CurrencyCode": "sample string 6", "Amount": 7.0, "BookingDate": "2025-08-31T16:12:02.2558622+00:00", "ValueDate": "2025-08-31T16:12:02.2558622+00:00", "PaymentDate": "2025-08-31T16:12:02.2558622+00:00", "RegistrationTime": "2025-08-31T16:12:02.2558622+00:00", "ReverseTime": "2025-08-31T16:12:02.2558622+00:00", "Description": "sample string 12", "SettlementTransactiontId": "00b68031-1710-42db-9ceb-67a24288fd53", "PaymentProviderPurchaseNumber": "sample string 13", "ReferenceNumber": "sample string 14" }, { "Id": "d4740559-3ee9-4fe5-b58f-4b2c869c4e57", "AccountNumber": "sample string 2", "AccountTransactionNumber": "sample string 3", "AccountId": "18814c67-4577-4c88-a47b-c95f4b0be891", "PaymentProviderId": "8b1cfebe-7ab0-4c39-acb3-b79eb964279c", "CurrencyCode": "sample string 6", "Amount": 7.0, "BookingDate": "2025-08-31T16:12:02.2558622+00:00", "ValueDate": "2025-08-31T16:12:02.2558622+00:00", "PaymentDate": "2025-08-31T16:12:02.2558622+00:00", "RegistrationTime": "2025-08-31T16:12:02.2558622+00:00", "ReverseTime": "2025-08-31T16:12:02.2558622+00:00", "Description": "sample string 12", "SettlementTransactiontId": "00b68031-1710-42db-9ceb-67a24288fd53", "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>18814c67-4577-4c88-a47b-c95f4b0be891</AccountId> <AccountNumber>sample string 2</AccountNumber> <AccountTransactionNumber>sample string 3</AccountTransactionNumber> <Amount>7</Amount> <BookingDate>2025-08-31T16:12:02.2558622+00:00</BookingDate> <CurrencyCode>sample string 6</CurrencyCode> <Description>sample string 12</Description> <Id>d4740559-3ee9-4fe5-b58f-4b2c869c4e57</Id> <PaymentDate>2025-08-31T16:12:02.2558622+00:00</PaymentDate> <PaymentProviderId>8b1cfebe-7ab0-4c39-acb3-b79eb964279c</PaymentProviderId> <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber> <ReferenceNumber>sample string 14</ReferenceNumber> <RegistrationTime>2025-08-31T16:12:02.2558622+00:00</RegistrationTime> <ReverseTime>2025-08-31T16:12:02.2558622+00:00</ReverseTime> <SettlementTransactiontId>00b68031-1710-42db-9ceb-67a24288fd53</SettlementTransactiontId> <ValueDate>2025-08-31T16:12:02.2558622+00:00</ValueDate> </AccountTransaction> <AccountTransaction> <AccountId>18814c67-4577-4c88-a47b-c95f4b0be891</AccountId> <AccountNumber>sample string 2</AccountNumber> <AccountTransactionNumber>sample string 3</AccountTransactionNumber> <Amount>7</Amount> <BookingDate>2025-08-31T16:12:02.2558622+00:00</BookingDate> <CurrencyCode>sample string 6</CurrencyCode> <Description>sample string 12</Description> <Id>d4740559-3ee9-4fe5-b58f-4b2c869c4e57</Id> <PaymentDate>2025-08-31T16:12:02.2558622+00:00</PaymentDate> <PaymentProviderId>8b1cfebe-7ab0-4c39-acb3-b79eb964279c</PaymentProviderId> <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber> <ReferenceNumber>sample string 14</ReferenceNumber> <RegistrationTime>2025-08-31T16:12:02.2558622+00:00</RegistrationTime> <ReverseTime>2025-08-31T16:12:02.2558622+00:00</ReverseTime> <SettlementTransactiontId>00b68031-1710-42db-9ceb-67a24288fd53</SettlementTransactiontId> <ValueDate>2025-08-31T16:12:02.2558622+00:00</ValueDate> </AccountTransaction> </Reply> </GetSettlementTransactionsReply>