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

Name	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": "6833e115-0ac7-4fca-a8eb-11258bfac298",
  "settlementTransactionId": "a8ad4a1d-168a-4eec-a085-ab0347147427",
  "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>6833e115-0ac7-4fca-a8eb-11258bfac298</paymentProviderId>
  <settlementTransactionId>a8ad4a1d-168a-4eec-a085-ab0347147427</settlementTransactionId>
</GetPaymentsRelatedToSettlementTransactionRequest>

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

Response Information

Resource Description

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": "1766f066-3df6-4198-a46c-1733b140fb81",
      "AccountNumber": "sample string 2",
      "AccountTransactionNumber": "sample string 3",
      "AccountId": "78e65ae9-cfc1-454a-b2a0-d67785bd89b6",
      "PaymentProviderId": "59b17308-8a13-4011-8632-e41a44c17109",
      "CurrencyCode": "sample string 6",
      "Amount": 7.0,
      "BookingDate": "2025-05-01T22:17:09.8663778+00:00",
      "ValueDate": "2025-05-01T22:17:09.8663778+00:00",
      "PaymentDate": "2025-05-01T22:17:09.8663778+00:00",
      "RegistrationTime": "2025-05-01T22:17:09.8663778+00:00",
      "ReverseTime": "2025-05-01T22:17:09.8663778+00:00",
      "Description": "sample string 12",
      "SettlementTransactiontId": "63babc58-2332-4be2-8cf1-9830b1dfab96",
      "PaymentProviderPurchaseNumber": "sample string 13",
      "ReferenceNumber": "sample string 14"
    },
    {
      "Id": "1766f066-3df6-4198-a46c-1733b140fb81",
      "AccountNumber": "sample string 2",
      "AccountTransactionNumber": "sample string 3",
      "AccountId": "78e65ae9-cfc1-454a-b2a0-d67785bd89b6",
      "PaymentProviderId": "59b17308-8a13-4011-8632-e41a44c17109",
      "CurrencyCode": "sample string 6",
      "Amount": 7.0,
      "BookingDate": "2025-05-01T22:17:09.8663778+00:00",
      "ValueDate": "2025-05-01T22:17:09.8663778+00:00",
      "PaymentDate": "2025-05-01T22:17:09.8663778+00:00",
      "RegistrationTime": "2025-05-01T22:17:09.8663778+00:00",
      "ReverseTime": "2025-05-01T22:17:09.8663778+00:00",
      "Description": "sample string 12",
      "SettlementTransactiontId": "63babc58-2332-4be2-8cf1-9830b1dfab96",
      "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>78e65ae9-cfc1-454a-b2a0-d67785bd89b6</AccountId>
      <AccountNumber>sample string 2</AccountNumber>
      <AccountTransactionNumber>sample string 3</AccountTransactionNumber>
      <Amount>7</Amount>
      <BookingDate>2025-05-01T22:17:09.8663778+00:00</BookingDate>
      <CurrencyCode>sample string 6</CurrencyCode>
      <Description>sample string 12</Description>
      <Id>1766f066-3df6-4198-a46c-1733b140fb81</Id>
      <PaymentDate>2025-05-01T22:17:09.8663778+00:00</PaymentDate>
      <PaymentProviderId>59b17308-8a13-4011-8632-e41a44c17109</PaymentProviderId>
      <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber>
      <ReferenceNumber>sample string 14</ReferenceNumber>
      <RegistrationTime>2025-05-01T22:17:09.8663778+00:00</RegistrationTime>
      <ReverseTime>2025-05-01T22:17:09.8663778+00:00</ReverseTime>
      <SettlementTransactiontId>63babc58-2332-4be2-8cf1-9830b1dfab96</SettlementTransactiontId>
      <ValueDate>2025-05-01T22:17:09.8663778+00:00</ValueDate>
    </AccountTransaction>
    <AccountTransaction>
      <AccountId>78e65ae9-cfc1-454a-b2a0-d67785bd89b6</AccountId>
      <AccountNumber>sample string 2</AccountNumber>
      <AccountTransactionNumber>sample string 3</AccountTransactionNumber>
      <Amount>7</Amount>
      <BookingDate>2025-05-01T22:17:09.8663778+00:00</BookingDate>
      <CurrencyCode>sample string 6</CurrencyCode>
      <Description>sample string 12</Description>
      <Id>1766f066-3df6-4198-a46c-1733b140fb81</Id>
      <PaymentDate>2025-05-01T22:17:09.8663778+00:00</PaymentDate>
      <PaymentProviderId>59b17308-8a13-4011-8632-e41a44c17109</PaymentProviderId>
      <PaymentProviderPurchaseNumber>sample string 13</PaymentProviderPurchaseNumber>
      <ReferenceNumber>sample string 14</ReferenceNumber>
      <RegistrationTime>2025-05-01T22:17:09.8663778+00:00</RegistrationTime>
      <ReverseTime>2025-05-01T22:17:09.8663778+00:00</ReverseTime>
      <SettlementTransactiontId>63babc58-2332-4be2-8cf1-9830b1dfab96</SettlementTransactiontId>
      <ValueDate>2025-05-01T22:17:09.8663778+00:00</ValueDate>
    </AccountTransaction>
  </Reply>
</GetPaymentsRelatedToSettlementTransactionReply>