Importing existing mandates can be done via the upload of a CSV file or via our API's.
To ensure all fields are imported correctly, your file must follow the structure of our file. The header fields must match exactly.
A detailed description of each header and the expected format is provided below.
| Field Name | Description | Notes & Constraints |
|---|---|---|
customerNumber(*) | Unique customer identifier | Reference/add to an existing customer. If not found, a new customer is created. Must appear only once in the file. |
email(*) | Customer email address | Reference/add to an existing customer. If missing and no customerNumber exists, a new customer is created. |
contractNumber(*) | Contract number of the agreement | If empty, the profile’s default contract reference is used. |
companyName(*) | Name of the company | Leave empty if the invoiced entity is a person. |
l | Language / locale for communications | Accepted: en, nl, nl_nl, fr, fr_fr, de, it, es, pt. Defaults to English if missing or unrecognized. |
mandateNumber | Mandate reference | By default generated automatically. Custom numbers must be unique and cannot start with the profile’s mandate prefix. |
lastname | Customer’s last name | |
firstname | Customer’s first name | |
mobile | Phone number | Use international format (e.g., +31, +32, +33). |
coc | CoC or VAT number | Leave empty for individuals. |
address | Street and number | |
city | City | |
zip | Postal code | |
country | ISO country code (2 letters) | Example: BE, NL, FR. See ISO 3166 |
iban | IBAN number | |
bic | BIC | Recommended for foreign IBANs |
campaign | Assign agreement to a campaign | Default campaign name: uploadYYYYMMDD |
(*) - Required fields : At least one value is required for the import to succeed.
Custom headers:
Any custom attribute defined on the selected profile can be included in the CSV. Values are stored in the agreement’s extra attributes and can be used in emails or for internal reference.
The import function is accessible at the top of your Twikey environment on all pages.
mandateNumber and IBAN are required.BIC is recommended for foreign IBAN accounts.signDate is optional. If omitted, the current import date is used.