SwissQRBill

SwissQRBill

SwissQR bill data

Constructor

new SwissQRBill()

Source:

Methods

createAndSetCreditorReference(rawReference)

Creates and sets a ISO11649 creditor reference from a raw string by prefixing
the String with "RF" and the modulo 97 checksum.

Whitespace is removed from the reference

Parameters:
Name Type Description
rawReference The raw reference.
Source:
Throws:
ArgumentException rawReference contains invalid characters.

equals(obj)

Determines whether the specified object is equal to the current object.
Parameters:
Name Type Description
obj The object to compare with the current object.
Returns:
Type Description
true if the specified object is equal to the current object; otherwise, false.
Source:

getAccount()

Gets the creditor's account number.

Account numbers must be valid IBANs of a bank of Switzerland or
Liechtenstein. Spaces are allowed in the account number.
Returns:
Type Description
The creditor account number.
Source:

getAlternativeSchemes()

Gets ors sets the alternative payment schemes.

A maximum of two schemes with parameters are allowed.
Returns:
Type Description
The alternative payment schemes.
Source:

getAmount()

Gets the payment amount.

Valid values are between 0.01 and 999,999,999.99.
Returns:
Type Description
The payment amount.
Source:

getBillInformation()

Gets the additional structured bill information.
Returns:
Type Description
The structured bill information.
Source:

getCreditor()

Gets the creditor address.
Returns:
Type Description
The creditor address.
Source:

getCurrency()

Gets the payment currency.
Valid values are "CHF" and "EUR".
Returns:
Type Description
The payment currency.
Source:

getDebtor()

Gets the debtor address.

The debtor is optional. If it is omitted, both setting this field to
null or setting an address with all null or empty values is ok.

Returns:
Type Description
The debtor address.
Source:

getReference()

Gets the creditor payment reference.

The reference is mandatory for SwissQR IBANs, i.e.IBANs in the range
CHxx30000xxxxxx through CHxx31999xxxxx.

If specified, the reference must be either a valid SwissQR reference
(corresponding to ISR reference form) or a valid creditor reference
according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting.
Returns:
Type Description
The creditor payment reference.
Source:

getUnstructuredMessage()

Gets the additional unstructured message.
Returns:
Type Description
The unstructured message.
Source:

getVersion()

Gets the version of the SwissQR bill standard.
Returns:
Type Description
The SwissQR bill standard version.
Source:

hashCode()

Gets the hash code for this instance.
Returns:
Type Description
A hash code for the current object.
Source:

setAccount(value:)

Sets the creditor's account number.

Account numbers must be valid IBANs of a bank of Switzerland
or
Liechtenstein. Spaces are allowed in the account number.
Parameters:
Name Type Description
value: The creditor account number.
Source:

setAlternativeSchemes(value:)

Gets or sets the alternative payment schemes.

A maximum of two schemes with parameters are allowed.
Parameters:
Name Type Description
value: The alternative payment schemes.
Source:

setAmount(value)

Sets the payment amount.
Valid values are between 0.01 and 999,999,999.99.
Parameters:
Name Type Description
value The payment amount.
Source:

setBillInformation(value:)

Sets the additional structured bill information.
Parameters:
Name Type Description
value: The structured bill information.
Source:

setCreditor(value:)

Sets the creditor address.
Parameters:
Name Type Description
value: The creditor address.
Source:

setCurrency(value)

Sets the payment currency.
Parameters:
Name Type Description
value Valid values are "CHF" and "EUR".
Source:

setDebtor(value:)

Sets the debtor address.

The debtor is optional. If it is omitted, both setting this field to
null or setting an address with all null or empty values is ok.
Parameters:
Name Type Description
value: The debtor address.
Source:

setReference(value)

Sets the creditor payment reference.

The reference is mandatory for SwissQR IBANs, i.e.IBANs in the range
CHxx30000xxxxxx through CHxx31999xxxxx.

If specified, the reference must be either a valid SwissQR reference
(corresponding to ISR reference form) or a valid creditor reference
according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting.
Parameters:
Name Type Description
value The creditor payment reference.
Source:

setUnstructuredMessage(value:)

Sets the additional unstructured message.
Parameters:
Name Type Description
value: The unstructured message.
Source:

setVersion(value)

Sets the version of the SwissQR bill standard.
Parameters:
Name Type Description
value The SwissQR bill standard version.
Source: