WebAPI

<back to all web services

GetPayments

Get a list of all the payments made to the account. Default date filter will be 30 days. Page size is 10

The following routes are available for this service:
POST/GetPaymentsRESTFUL POST call with Account ID , Start and End Dates, and Page Size in the URI
Parameters:
NameParameterData TypeRequiredDescription
AccountIdpathintegerYes
StartDatepathstringYesYYYY-MM-DD
EndDatepathstringYesYYYY-MM-DD
PageSizepathintegerYes
PageNumberpathintegerYes
SortingpathstringNo

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetPayments HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

<GetPayments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <AccountId>0</AccountId>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <SearchAmount>0</SearchAmount>
  <SearchFJNo>0</SearchFJNo>
  <Sorting>String</Sorting>
  <StartDate>0001-01-01T00:00:00</StartDate>
</GetPayments>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPaymentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <Payments xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:PaymentRecord>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:FjNo>0</d2p1:FjNo>
      <d2p1:PaymentPortal>String</d2p1:PaymentPortal>
      <d2p1:TransactionDate>0001-01-01T00:00:00</d2p1:TransactionDate>
    </d2p1:PaymentRecord>
  </Payments>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <TotalNumber>0</TotalNumber>
</GetPaymentsResponse>