SwissQR
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.signature.domain.extensions.interfaces.IComplexData
public class SwissQR implements IComplexData
Class for encoding and decoding the text embedded in the SwissQR code.
Constructors
| Constructor | Description |
|---|---|
| SwissQR() | Creates an instance of SwissQR. |
Methods
| Method | Description |
|---|---|
| getAmount() | Gets or sets the payment amount. |
| setAmount(double value) | Gets or sets the payment amount. |
| getCurrency() | Gets or sets the payment currency. |
| setCurrency(String value) | Gets or sets the payment currency. |
| getAccount() | Gets or sets the creditor’s account number. |
| setAccount(String value) | Gets or sets the creditor’s account number. |
| getCreditor() | Gets or sets the creditor address. |
| setCreditor(SwissAddress value) | Gets or sets the creditor address. |
| getReference() | Gets or sets the creditor payment reference. |
| setReference(String value) | Gets or sets the creditor payment reference. |
| getDebtor() | Gets or sets the debtor address. |
| setDebtor(SwissAddress value) | Gets or sets the debtor address. |
| getUnstructuredMessage() | Gets or sets the additional unstructured message. |
| setUnstructuredMessage(String value) | Gets or sets the additional unstructured message. |
| getBillInformation() | Gets or sets the additional structured bill information. |
| setBillInformation(String value) | Gets or sets the additional structured bill information. |
SwissQR()
public SwissQR()
Creates an instance of SwissQR.
getAmount()
public final double getAmount()
Gets or sets the payment amount. Valid values are between 0.01 and 999,999,999.99.
Value: The payment amount.
Returns: double
setAmount(double value)
public final void setAmount(double value)
Gets or sets the payment amount. Valid values are between 0.01 and 999,999,999.99.
Value: The payment amount.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
getCurrency()
public final String getCurrency()
Gets or sets the payment currency. Valid values are “CHF” and “EUR”.
Value: The payment currency.
Returns: java.lang.String
setCurrency(String value)
public final void setCurrency(String value)
Gets or sets the payment currency. Valid values are “CHF” and “EUR”.
Value: The payment currency.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getAccount()
public final String getAccount()
Gets or 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.
Returns: java.lang.String
setAccount(String value)
public final void setAccount(String value)
Gets or 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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getCreditor()
public final SwissAddress getCreditor()
Gets or sets the creditor address.
Value: The creditor address.
Returns: SwissAddress
setCreditor(SwissAddress value)
public final void setCreditor(SwissAddress value)
Gets or sets the creditor address.
Value: The creditor address.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | SwissAddress |
getReference()
public final String getReference()
Gets or 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.
Value: The creditor payment reference.
Returns: java.lang.String
setReference(String value)
public final void setReference(String value)
Gets or 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.
Value: The creditor payment reference.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getDebtor()
public final SwissAddress getDebtor()
Gets or 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.
Returns: SwissAddress
setDebtor(SwissAddress value)
public final void setDebtor(SwissAddress value)
Gets or 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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | SwissAddress |
getUnstructuredMessage()
public final String getUnstructuredMessage()
Gets or sets the additional unstructured message.
Value: The unstructured message.
Returns: java.lang.String
setUnstructuredMessage(String value)
public final void setUnstructuredMessage(String value)
Gets or sets the additional unstructured message.
Value: The unstructured message.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getBillInformation()
public final String getBillInformation()
Gets or sets the additional structured bill information.
Value: The structured bill information.
Returns: java.lang.String
setBillInformation(String value)
public final void setBillInformation(String value)
Gets or sets the additional structured bill information.
Value: The structured bill information.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |