codinux
/
EpcQrCode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation

This commit is contained in:
dankito 2024-10-16 00:43:53 +02:00
parent a0540c005d
commit 2845900731
2 changed files with 34 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
EpcQrCode/src/commonMain/kotlin/net/codinux/banking/epcqrcode/EpcQrCodeConfig.kt
View File

@ -3,8 +3,16 @@ package net.codinux.banking.epcqrcode
open class EpcQrCodeConfig( open class EpcQrCodeConfig(
/**
* Name of the Receiver. Mandatory.
* Max. 70 characters
*/
open val receiverName: String = "", open val receiverName: String = "",
/**
* Receiver's IBAN. Mandatory.
* Max. 34 bytes.
*/
open val iban: String = "", open val iban: String = "",
open val bic: String? = null, open val bic: String? = null,

29
EpcQrCode/src/commonMain/kotlin/net/codinux/banking/epcqrcode/EpcQrCodeValues.kt
View File

@ -1,6 +1,11 @@
package net.codinux.banking.epcqrcode package net.codinux.banking.epcqrcode
/**
* The values of a EPC QR code use two different charsets:
* - byte = printable ASCII characters from range 32 (white space) to 126 (tilde) (most fields)
* - characters = all allowed characters according to encoding in line 3 'coding' (only for receiver name, remittance and information for user)
*/
open class EpcQrCodeValues( open class EpcQrCodeValues(
/** /**
@ -36,13 +41,13 @@ open class EpcQrCodeValues(
open val bic: String?, open val bic: String?,
/** /**
* Receiver name. * Name of the Receiver. Mandatory.
* Max. 70 characters * Max. 70 characters in encoding of line 3 'coding'.
*/ */
open val receiverName: String, open val receiverName: String,
/** /**
* Receiver's IBAN. * Receiver's IBAN. Mandatory.
* Max. 34 bytes. * Max. 34 bytes.
*/ */
open val iban: String, open val iban: String,
@ -66,8 +71,24 @@ open class EpcQrCodeValues(
*/ */
open val purposeCode: String?, open val purposeCode: String?,
/**
* Structured Remittance Information.
*
* Creditor Reference (ISO 11649 RF Creditor Reference may be used).
*
* May only be set if line 11 (unstructured remittanceText) is empty.
*
* Max. 35 bytes
*/
open val remittanceReference: String?, open val remittanceReference: String?,
/**
* Unstructured remittance information (Verwendungstext).
*
* May only be set if line 10 (structured remittanceReference) is empty.
*
* Max. 140 characters in encoding of line 3 'coding'
*/
open val remittanceText: String?, open val remittanceText: String?,
/** /**
@ -76,6 +97,8 @@ open class EpcQrCodeValues(
* The text contained in Display must be shown to the user after decoding and serves a * The text contained in Display must be shown to the user after decoding and serves a
* short textual description of what the user is going to initiate. * short textual description of what the user is going to initiate.
* This text must not be forwarded with the data handed over to the payment system. * This text must not be forwarded with the data handed over to the payment system.
*
* Max. 70 characters in encoding of line 3 'coding'
*/ */
open val informationForUser: String? open val informationForUser: String?