Class SepaQrCode

Represents the content of a EPC069 QR Code, and includes methods for parsing and generating EPC 069 QR Code data strings.

Inheritance
object
SepaQrCode
Inherited Members
Namespace: Subsembly.Sepa
Assembly: Subsembly.Sepa.dll
Syntax
public class SepaQrCode
Remarks

When generating a QR code at least BeneficiaryIBAN and BeneficiaryName must be set.

Properties

Amount

The decimal amount.

Declaration
public decimal Amount { get; set; }
Property Value
Type Description
decimal

The value must be in the range from 0.01 through 999,999,999.99. The initial value is zero.
Exceptions
Type Condition
ArgumentOutOfRangeException

An attempt was made to set a value less than 0.01, or a value greater than 999999999.99.
ArgumentException

An attempt was made to set a decimal value with more than two significant fractional digits.

BeneficiaryBIC

Declaration
public SepaBIC BeneficiaryBIC { get; set; }
Property Value
Type Description
SepaBIC

BeneficiaryIBAN

Declaration
public SepaIBAN BeneficiaryIBAN { get; set; }
Property Value
Type Description
SepaIBAN

BeneficiaryName

Declaration
public string BeneficiaryName { get; set; }
Property Value
Type Description
string

BeneficiaryToOriginatorInformation

Declaration
public string BeneficiaryToOriginatorInformation { get; set; }
Property Value
Type Description
string

CreditorReferenceInformation

Creditor reference information.

Declaration
public string CreditorReferenceInformation { get; set; }
Property Value
Type Description
string
Remarks

Only either this CreditorReferenceInformation or the RemittanceInformation may be set, but not both.

Exceptions
Type Condition
ArgumentException

An attempt was made to set a string longer than 35 characters.
See Also

Currency

The currency code of the amount.

Declaration
public string Currency { get; set; }
Property Value
Type Description
string

The initial value of this property is "EUR".
Exceptions
Type Condition
ArgumentException

An attempt was made to set a value that is not a syntactically valid currency code.

IsValid

Validates this instance.

Declaration
public bool IsValid { get; }
Property Value
Type Description
bool

If the contained data is valid for generating a EPC069 code, then the value is true. If some mandatory data is missing or the data is otherwise invalid, then the value is false.

PurposeCode

Purpose code.

Declaration
public string PurposeCode { get; set; }
Property Value
Type Description
string
Exceptions
Type Condition
ArgumentException

An attempt was made to set a string that is not a syntactically correct purpose code.

RemittanceInformation

Unstructured remittance information.

Declaration
public string RemittanceInformation { get; set; }
Property Value
Type Description
string

If no remittance information is provided, this property is null, which is also its default value. A remittance information string must not be longer than MaxRmtInfLen (140) characters.
Remarks

Only either this RemittanceInformation or the CreditorReferenceInformation may be set, but not both.

Only latin characters should be used. It is up to the caller to ensure that the provided string contains only characters allowed in the encoding used when generating the QR code data.

Exceptions
Type Condition
ArgumentException

An attempt was made to set a string longer than 140 characters.
See Also

Methods

Clear()

Declaration
public void Clear()

Create(SepaQrCodeCharacterSet)

Creates a EPC069 data string for initiating a SEPA credit transfer to the given account.

Declaration
public string Create(SepaQrCodeCharacterSet nCharacterSet = SepaQrCodeCharacterSet.ISO_8859_1)
Parameters
Type Name Description
SepaQrCodeCharacterSet nCharacterSet

The character set value that shall be included in the QR code payload data that is produced. This parameter has no effect on the actual character set used for encoding the QR code. The character set used when encoding the QR code image, must be specified when the QR code image is created. Of course, the same character set than specified here, should be used for the actual encoding.
Returns
Type Description
string

TryParse(string)

Declaration
public static SepaQrCode TryParse(string sSepaQrCodeData)
Parameters
Type Name Description
string sSepaQrCodeData

The decoded QR code data. This data was already converted from a byte sequence to a string, using some character set encoding rules, usually UTF-8. So the character set specification inside of the data is meaningless.
Returns
Type Description
SepaQrCode
Exceptions
Type Condition
ArgumentNullException

The parameter sSepaQrCodeData was null.