new SwissQRBill()

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

Parameter

Name Type Optional Description

rawReference

 

 

The raw reference.

Throws

ArgumentException rawReference contains invalid characters.

equals(obj)

Determines whether the specified object is equal to the current object.

Parameter

Name Type Optional Description

obj

 

 

The object to compare with the current object.

Returns

true if the specified object is equal to the current object; otherwise, false.

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

The creditor account number.

getAlternativeSchemes()

Gets ors sets the alternative payment schemes.

A maximum of two schemes with parameters are allowed.

Returns

The alternative payment schemes.

getAmount()

Gets the payment amount.

Valid values are between 0.01 and 999,999,999.99.

Returns

The payment amount.

getBillInformation()

Gets the additional structured bill information.

Returns

The structured bill information.

getCreditor()

Gets the creditor address.

Returns

The creditor address.

getCurrency()

Gets the payment currency.

Valid values are "CHF" and "EUR".

Returns

The payment currency.

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

The debtor address.

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

The creditor payment reference.

getUnstructuredMessage()

Gets the additional unstructured message.

Returns

The unstructured message.

getVersion()

Gets the version of the SwissQR bill standard.

Returns

The SwissQR bill standard version.

hashCode()

Gets the hash code for this instance.

Returns

A hash code for the current object.

setAccount()

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.

Value: The creditor account number.

setAlternativeSchemes()

Gets or sets the alternative payment schemes.

A maximum of two schemes with parameters are allowed.

Value: The alternative payment schemes.

setAmount()

Sets the payment amount.

Valid values are between 0.01 and 999,999,999.99.

Value: The payment amount.

setBillInformation()

Sets the additional structured bill information. Value: The structured bill information.

setCreditor()

Sets the creditor address. Value: The creditor address.

setCurrency()

Sets the payment currency.

Valid values are "CHF" and "EUR".

Value: The payment currency.

setDebtor()

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.

Value: The debtor address.

setReference()

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.

Returns

The creditor payment reference.

setUnstructuredMessage()

Sets the additional unstructured message. Value: The unstructured message.

setVersion()

Sets the version of the SwissQR bill standard. Value: The SwissQR bill standard version.