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

HTTP + CSV

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

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

AccountId,StartDate,EndDate,PageSize,PageNumber,Sorting,SearchAmount,SearchFJNo
0,0001-01-01,0001-01-01,0,0,String,0,0

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

Amount,FjNo,TransactionDate,PaymentPortal,Description
0,0,0001-01-01,String,String