Class FinSepaInstPaymt

Namespace
Subsembly.FinTS
Assembly
Subsembly.FinTS.Core.dll

A specialised FinOrder that encapsulates a SEPA Instant Payment, or SEPA Instant Payment Status Query, providing access to the special result values of it.

public class FinSepaInstPaymt : FinSepaOrder
Inheritance
FinSepaInstPaymt
Inherited Members

Constructors

FinSepaInstPaymt()

This ctor shall only be used when loading a previously persisted instance of this class. For new orders the corresponding builder class shall be used.

public FinSepaInstPaymt()

Properties

CancellationCode

The SEPA C-Code that was returned in the response.

public FinSepaCancellationCode CancellationCode { get; }

Property Value

FinSepaCancellationCode

MustQueryStatus

After this order was executed, this indicates whether a status query shall be performed in order order to get the final completion status of this order.

public bool MustQueryStatus { get; }

Property Value

bool

Remarks

This flag will be set, whenever the StatusSegment of the order contains a warning code that indicates that a status query via CreateStatusBuilder(FinContact) is required. If there is no StatusSegment, then false is returned.

See Also

OrderStatus

The SEPA Order Status that was returned in the response.

public FinSepaOrderStatus OrderStatus { get; }

Property Value

FinSepaOrderStatus

PaymentStatusReport

The complete pain.002 Payment Status Report for this order.

public SepaDocument PaymentStatusReport { get; }

Property Value

SepaDocument

Remarks

A pain.002 Payment Status Report is provided only for an order created by the FinSepaMultInstPaymtStatusBuilder. It is null in all other cases.

Methods

CreateStatusBuilder(FinContact)

Depending on the current StatusSegment this will create an order builder for querying the status, if needed and supported.

public FinSepaInstPaymtStatusBuilder CreateStatusBuilder(FinContact aContact)

Parameters

aContact FinContact

The FinContact for which to create the order builder. This contact must be the same contact that was used to send this instant payment.

Returns

FinSepaInstPaymtStatusBuilder

If the current StatusSegment indicates that a status query must be performed (MustQueryStatus is true), then a suitable status order builder is created and returned. If the contact does not support instant payment status queries, or if no status query is required, then null is returned.

Exceptions

ArgumentNullException

The parameter aContact was null.

OnExecuteComplete(FinDialog) 

protected override void OnExecuteComplete(FinDialog aDialog)

Parameters

aDialog FinDialog

See Also

FinSepaInstPaymtBuilder
FinSepaSubmitPostdatedInstPaymtBuilder
FinSepaSingInstPaymtStatusBuilder
FinSepaMultInstPaymtBuilder
FinSepaSubmitPostdatedMultInstPaymtBuilder
FinSepaMultInstPaymtStatusBuilder
FinSepaInstPaymtReclassBuilder