Interface IScraperSessionDocuments
This interface shall be implemented by scrapers that support downloading of PDF account documents.
public interface IScraperSessionDocuments
Remarks
The methods in this interface may only be invoked after a successful Login(JsonObject).
A scraper that implements this interface shall advertise it through the ImplementsDocuments flag.
Properties
MaxDocumentDays
Provides the max number of history days for which statement data can be downloaded via DownloadDocumentList(out JsonArray, JsonObject, DateTime).
int MaxDocumentDays { get; }
Property Value
Remarks
By default the PSD2 RTS default value 90 should be assumed.
Methods
DownloadDocument(out byte[], JsonObject, JsonObject)
Download the PDF data for a particular document.
ScraperResult DownloadDocument(out byte[] vbPDF, JsonObject jsAcct, JsonObject jsDoc)
Parameters
vbPDF
byte[]jsAcct
JsonObjectjsDoc
JsonObjectSpecification of the document for which to download the PDF data. The fields must be initialized accoring to SUPA. It is recommended to just pass the JSON object returned by DownloadDocumentList(out JsonArray, JsonObject, DateTime).
Returns
DownloadDocumentList(out JsonArray, JsonObject, DateTime)
Download a list of available PDF documents for an account.
ScraperResult DownloadDocumentList(out JsonArray jsDocList, JsonObject jsAcct, DateTime tFromDate)
Parameters
jsDocList
JsonArrayArray of JSON objects with PDf document details according to the SUPA specification.
jsAcct
JsonObjecttFromDate
DateTimeThe starting date from which documents should be returned, up to today. If this is
DateTime.MinValue
, then all available documents are returned.