Interface IScraperSessionPayments

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

Namespace: Subsembly.Scraper

Assembly: Subsembly.Scraper.dll

Syntax

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.

Declaration

ScraperResult CancelPayment()

Returns

Type	Description
ScraperResult

ContinuePayment(JsonObject)

Authorize a previously initiated payment.

Declaration

ScraperResult ContinuePayment(JsonObject jsAuthCredentials)

Parameters

Type	Name	Description
JsonObject	jsAuthCredentials	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

Type	Description
ScraperResult

InitiatePayment(SepaDocument)

Initiate payment.

Declaration

ScraperResult InitiatePayment(SepaDocument aPainDoc)

Parameters

Type	Name	Description
SepaDocument	aPainDoc	A complete and valid ISO 20022 pain document containing the payment details. Must not be null.

Returns

Type	Description
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.