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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"AccountId":0,"StartDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","PageSize":0,"PageNumber":0,"Sorting":"String","SearchAmount":0,"SearchFJNo":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Payments":[{"Amount":0,"FjNo":0,"TransactionDate":"\/Date(-62135596800000-0000)\/","PaymentPortal":"String","Description":"String"}],"TotalNumber":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]}}