POST api/Merchant/v1/GetPaymentsRelatedToSettlementTransaction
Method returns all payments (account transactions) that are settled for payment provider with given settlement transaction id.
Request Information
URI Parameters
None.
Body Parameters
GetPaymentsRelatedToSettlementTransactionRequestName | Description | Type | Additional information |
---|---|---|---|
paymentProviderId |
Id of payment provider (M) |
globally unique identifier |
None. |
settlementTransactionId |
Id of settlement transaction (M) |
globally unique identifier |
None. |
OrganizationCode | string |
None. |
|
UserName | string |
None. |
|
Password | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "paymentProviderId": "c9d8be73-7dfa-4a17-9b16-0ae333c11c93", "settlementTransactionId": "1e62f3d9-786d-4463-81ee-aba5748a776f", "OrganizationCode": "sample string 3", "UserName": "sample string 4", "Password": "sample string 5" }
application/xml, text/xml
Sample:
<GetPaymentsRelatedToSettlementTransactionRequest 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 3</OrganizationCode> <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 5</Password> <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</UserName> <paymentProviderId>c9d8be73-7dfa-4a17-9b16-0ae333c11c93</paymentProviderId> <settlementTransactionId>1e62f3d9-786d-4463-81ee-aba5748a776f</settlementTransactionId> </GetPaymentsRelatedToSettlementTransactionRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
GetPaymentsRelatedToSettlementTransactionReplyName | 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": "bcdcc827-824f-4c96-bb13-fc44b6cbf515", "AccountNumber": "sample string 2", "AccountTransactionNumber": "sample string 3", "AccountId": "5f5414fe-6a39-407e-9b9e-e1551173d274", "PaymentProviderId": "0fc15ee7-e79e-4f28-a54f-4a5fbb71c6ea", "CurrencyCode": "sample string 6", "Amount": 7.0, "BookingDate": "2025-08-30T16:52:52.099299+00:00", "ValueDate": "2025-08-30T16:52:52.099299+00:00", "PaymentDate": "2025-08-30T16:52:52.099299+00:00", "RegistrationTime": "2025-08-30T16:52:52.099299+00:00", "ReverseTime": "2025-08-30T16:52:52.099299+00:00", "Description": "sample string 12", "SettlementTransactiontId": "1849b397-1f19-49a2-9932-b3e3eacfbb9b", "PaymentProviderPurchaseNumber": "sample string 13", "ReferenceNumber": "sample string 14" }, { "Id": "bcdcc827-824f-4c96-bb13-fc44b6cbf515", "AccountNumber": "sample string 2", "AccountTransactionNumber": "sample string 3", "AccountId": "5f5414fe-6a39-407e-9b9e-e1551173d274", "PaymentProviderId": "0fc15ee7-e79e-4f28-a54f-4a5fbb71c6ea", "CurrencyCode": "sample string 6", "Amount": 7.0, "BookingDate": "2025-08-30T16:52:52.099299+00:00", "ValueDate": "2025-08-30T16:52:52.099299+00:00", "PaymentDate": "2025-08-30T16:52:52.099299+00:00", "RegistrationTime": "2025-08-30T16:52:52.099299+00:00", "ReverseTime": "2025-08-30T16:52:52.099299+00:00", "Description": "sample string 12", "SettlementTransactiontId": "1849b397-1f19-49a2-9932-b3e3eacfbb9b", "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:
<GetPaymentsRelatedToSettlementTransactionReply 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>5f5414fe-6a39-407e-9b9e-e1551173d274</AccountId> <AccountNumber>sample string 2</AccountNumber> <AccountTransactionNumber>sample string 3</AccountTransactionNumber> <Amount>7</Amount> <BookingDate>2025-08-30T16:52:52.099299+00:00</BookingDate> <CurrencyCode>sample string 6</CurrencyCode> <Description>sample string 12</Description> <Id>bcdcc827-824f-4c96-bb13-fc44b6cbf515</Id> <PaymentDate>2025-08-30T16:52:52.099299+00:00</PaymentDate> <PaymentProviderId>0fc15ee7-e79e-4f28-a54f-4a5fbb71c6ea</PaymentProviderId> <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber> <ReferenceNumber>sample string 14</ReferenceNumber> <RegistrationTime>2025-08-30T16:52:52.099299+00:00</RegistrationTime> <ReverseTime>2025-08-30T16:52:52.099299+00:00</ReverseTime> <SettlementTransactiontId>1849b397-1f19-49a2-9932-b3e3eacfbb9b</SettlementTransactiontId> <ValueDate>2025-08-30T16:52:52.099299+00:00</ValueDate> </AccountTransaction> <AccountTransaction> <AccountId>5f5414fe-6a39-407e-9b9e-e1551173d274</AccountId> <AccountNumber>sample string 2</AccountNumber> <AccountTransactionNumber>sample string 3</AccountTransactionNumber> <Amount>7</Amount> <BookingDate>2025-08-30T16:52:52.099299+00:00</BookingDate> <CurrencyCode>sample string 6</CurrencyCode> <Description>sample string 12</Description> <Id>bcdcc827-824f-4c96-bb13-fc44b6cbf515</Id> <PaymentDate>2025-08-30T16:52:52.099299+00:00</PaymentDate> <PaymentProviderId>0fc15ee7-e79e-4f28-a54f-4a5fbb71c6ea</PaymentProviderId> <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber> <ReferenceNumber>sample string 14</ReferenceNumber> <RegistrationTime>2025-08-30T16:52:52.099299+00:00</RegistrationTime> <ReverseTime>2025-08-30T16:52:52.099299+00:00</ReverseTime> <SettlementTransactiontId>1849b397-1f19-49a2-9932-b3e3eacfbb9b</SettlementTransactiontId> <ValueDate>2025-08-30T16:52:52.099299+00:00</ValueDate> </AccountTransaction> </Reply> </GetPaymentsRelatedToSettlementTransactionReply>