| Parameter Name | From version | Description | Parameter type | Default valueExample | Comments and restricitons |
|---|
| File configuration |
| Document class* | 1.0.X | The name of the document class to which the generated file will be added. | String | | |
| Name of the document* | 1.0.X | The name of the generated document | String | | |
| Title configuration | |
Payer NIP* | 1.0.X | Payer NIP without separators (dashes, spaces, etc.). | String/String Array | |
The parameters must have the same length.
|
Complementary identifier type* | 1.0.X | Secondary identifier type and value:*If a TIN number is provided, the "Secondary identifier type"(Complementary identifier type) and "Secondary payer identifier"(Payer secondary identifier) fields may be left blank. If populated, the "Second Identifier Type" field must contain one of the following identifier types: P, R, 1(ID card) or 2(Passport).The values entered should be without dashes, spaces, etc.-If the type indicates "P"-the identifier must contain the formally correct PESEL number.-If the type indicates "R"-the identifier must contain the formally correct REGON number.-If the type indicates 1 or 2-the identifier must not be empty (spaces are treated as missing content) and must not be longer than 14 characters | String/String Array | |
Payer secondary identifier* | 1.0.X | String/String Array | |
Deposit type* | 1.0.X | The "Deposit Type," "Declaration," and "Declaration Number" fields must be completed as described below: - "Deposit Type" must contain one of the following designations: A, B, D, E, M, S, T, or U. - The "Declaration" field must contain the year and month according to the "YYYYMM" format (Declaration Year and Declaration Month parameters) , where year>1998 - If "Payment type" indicates S or M, the "Declaration number" field must take values from 01-89, - for other "Payment type" designations the field "Declaration number" must have one of the following values: 01, 40, 51, 70, 80. | String/String Array | A |
Declaration year* | 1.0.X | String/String Array | 2022 |
Declaration month* | 1.0.X | String/String Array | 03 |
Declaration No.* | 1.0.X | String/String Array | 01 |
Number of decision/contract/enforcement title* | 1.0.X | The "Decision/Agreement/Executive Title Number" field must be placed on the fourth line of the payment detail. If "Type of payment" indicates S or M this field must not be filled in. For other "Payment type" indications the field must be filled in (spaces are treated as missing) and cannot contain more than 15 characters. | String/String Array | |
| Transfer configuration |
| Date of the transfer* | 1.0.X | | Date/Date Array | |
| Amount* | 1.0.X | Transfer amount | Float/Float Array | |
| Principal's account number* | 1.0.X | The payer's account number in the NRB format without spaces | String/String Array | |
| Beneficiary's account number* | 1.0.X | The payer's account number in the NRB format without spaces | String/String Array | |
| Principal's name and address* | 1.0.X | | String/String Array | |
| Beneficiary's name and address* | 1.0.X | | String/String Array | |
| Principal's references | 1.0.X | The field Originator's references is used to provide transaction references for the purpose of its subsequent identification in the user's system. Max 20 characters | String/String Array | |
