Interface IScraperSessionPayments

Namespace

Subsembly.Scraper

Assembly

Subsembly.Scraper.dll

This interface shall be implemented by scrapers that support payment initiation.

public interface IScraperSessionPayments

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 ImplementsPayments flag.

Methods

CancelPayment()

Cancel a previously initiated payment.

ScraperResult CancelPayment()

Returns

ScraperResult

ContinuePayment(JsonObject)

Authorize a previously initiated payment.

ScraperResult ContinuePayment(JsonObject jsAuthCredentials)

Parameters

jsAuthCredentials JsonObject

Optional authentication credentials for the given payment. If given, then these contain at least the authentication code. It may contain:

ChallengeResponse

The authentication code (TAN number or similar).

Returns

ScraperResult

InitiatePayment(SepaDocument)

Initiate payment.

ScraperResult InitiatePayment(SepaDocument aPainDoc)

Parameters

aPainDoc SepaDocument

A complete and valid ISO 20022 pain document containing the payment details. Must not be null.

Returns

ScraperResult

If payment was initiated successfully, then a ScraperResult with Success will be returned. If the service needs an additional authentication code, then ChallengeResponseNeeded is returned. If so, the client shall obtain the authentication code from the given challenge and call ContinuePayment(JsonObject), including the authentication code in the `ChallengeResponse`.