If you are unable to use our REST API, we provide a FTP service that will read your data files and make calls to the REST interface. Below is listed our standard file format, but customized data file readers can be developed for a fee.
Our service accepts files with semicolon-separated fields. The first line must contain configuration data, while the following n lines contain detailed data changeable pr customer.
Do not use a line with header data.
Do not use semicolon inside the text fields (as that will be interpreted as a field separator).
Files must have the .csv extension and it is encouraged to use unique file names (ie have timestamp as part of the filename).
It is recommended to encode the text file with UTF-8 encoding.
| Id | Name | Description | Example |
|---|---|---|---|
| 1 | Version | Version of the FTP file processor. Set to 1. | 1 |
| 2 | Batch reference | Unique identifier for the batch, note that this reference is appended with "-part{i}" if number of recipients are greater than 250. | test-20170101-120000 |
| 3 | Expiry days | Number of days until the payment becomes invalid. The payment is valid until 23:59:59 on the expiration day. | 30 |
| 4 | SMS message text | Text that is sent to user in the initial SMS 1 | Hello, click on the link below to pay |
| 5 | SMS receipt text | Text message sent to user after a successful payment (leave this field empty if you don't want to send a text message receipt) 1 | Your payment is now confirmed. |
| Id | Name | Description | Example |
|---|---|---|---|
| 1 | Msisdn | Mobile phone number of the recipient | +4799999999 |
| 2 | Customer reference | A unique identifier (within the batch) for the customer (e.g. use KID) | abcd123456 |
| 3 | Amount | Amount to pay, in lowest monetary unit | 1000 |
| 4 | Currency | Currency code (ISO 4217) | NOK |
| x+n | Variable name x | Name of input variable 2 | name |
| y+n | Variable value y | Value of input variable 2 | Kjetil |
1Note that variables can be used in these texts. Variables are notated like this: {{variable_name}} - example of text with a variable: "Hello {{name}}, please click on the link to pay your bill of {{amount}} NOK".
- Some variables are predefined and can be used without adding them at the end of the line in the file, they are listed here
- In addition the predefined variable {{CRLF}} can be used in the FTP API to get line breaks in the SMS message and receipt texts.
- The input variables must exist in either the SMS texts or in the texts shown on the web.
2These fields can be repeated n times, but be sure to have the same number of variable names as you have variable values.
1;test-20170101-120000;30;Hello {{name}}, click here to pay {{amount}} kroner.;Your payment of {{amount}} is now confirmed
+4799999999;abcd1234;10000;NOK;name;Kjetil;amount;100
+4799999998;abcd1235;25000;NOK;name;Steven;amount;250
+4799999997;abcd1236;7500;NOK;name;Robbie;amount;75