Wiki source code of Supplementary features

Last modified by Fredrik Nilsson on 2024/12/06 11:49
Show last authors
1 = Introduction =
2
3 (% class="jumbotron" %)
4 (((
5 (% class="container" %)
6 (((
7 This section covers additional features and functions of PayEx Invoice Service, that are not part of the base service. If you want to add additional features to your Invoice Service package please contact us for more information!
8 )))
9 )))
10
11 == Automatic payment service ==
12
13 Automatic payment service (direct debit) enables automatic payments that debit your customer's bank account on the invoice due date. If the bank account lacks coverage, up to three attempts will be made before a reminder is sent to your customer.
14
15 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
16
17 When the customer apply for the automatic payment service PayEx handles the consent.
18 You retrieve information about activated/deactivated consents in Customer Journal (depending on service set up).
19
20 By default, an active consent means that the next invoice produced will use the the automatic payment method.
21
22 (% lang="EN-US" %)
23 To use automatic payment service, your customer needs to apply in any of the following ways:
24
25 (% lang="EN-US" %)
26 - The automatic payment sign up via the customers internet bank.
27
28 (% lang="EN-US" %)
29 - The automatic payment sign up via the service providers app/web site, etc. (depending on service/country)
30
31 (% lang="EN-US" %)
32 - Using the Electronic agreement application provided by PayEx, see below.
33
34 (% lang="EN-US" %)
35 **Please note** that different customer information is required for different counties, in order for direct debit to work
36
37 (% lang="EN-US" %)
38 Sweden:
39
40 * RegNo/nationalIdentifier (SSN) needs to be sent to PayEx as it is the identifier used by Autogiro
41 * Only numeric characters and not with a leading zero may be used in CustomerNo
42
43 Norway:
44
45 * KID-number (Kundeiidentifikasjon) is the identifier used by AvtaleGiro
46 * KID-number is generated by PayEx, no additional customer information needs to be sent to PayEx in order for AvtaleGiro to work
47
48 Denmark:
49
50 * CustomerNo is the identifier used by Betalingsservice
51 * No additional customer information needs to be sent to PayEx in order for Betalingsservice to work
52
53 (% lang="EN-US" %)
54 === Electronic agreement application Sweden ===
55
56 (% lang="EN-US" %)
57 The customer access the agreement application on a website hosted by PayEx. A link to the application website can be embedded within your own "My Site", as a part of your onboarding process of new customers or sent to existing customers i.e. via sms or e-mail. In the application form the customer fills in social security number and bank account number from which the money is to be deducted, reviews the information related to the agreement and then submits by signing with BankID. The agreement is then sent by PayEx to BGC and the consent will be visible in both the customers internet bank and on the customer information in PayEx web interface when activated.
58
59 (% lang="EN-US" %)
60 Customer data including RegNo/nationalIdentifier (SSN) needs to be sent to PayEx in connection with the application as it is the identifier used by Autogiro.. The consent is stored in xml-format at PayEx.
61
62 (% lang="EN-US" %)
63 Example of URL structure: https:~/~/www.mypayex.com/application/direct-debit-sign-up-se/<LedgerNumber>/register
64 LedgerNumber = The company number in PayEx ledger system
65
66 (% lang="EN-US" %)
67 Using returnUrl allow the customer to be sent back to the specified URL, i.e. the company's homepage, enabling a seamless onboarding experience. When you link your users to the registration page, include the ?return=<your_url> query parameter in the URL. This allows the user to be redirected back to the specified URL once the registration process is completed. Example of returnUrl: ?returnUrl=https:~/~/companyhomepage.com/
68
69 (% lang="EN-US" %)
70 After the user completes the registration, the provided returnUrl will include an additional status query parameter indicating the result:
71
72 (% style="list-style-type:circle" type="circle" %)
73 * Status=success (//Registration was successful)//
74 * Status=fail (//Registration failed)//
75 * Status=cancel (//The user canceled the registration using the "Cancel" button)//
76
77 (% lang="EN-US" %)
78 Example of returnUrl status: https:~/~/companyhomepage.com/?status=success
79
80 (% lang="EN-US" %)
81 ReturnURL must use the HTTPS protocol. If the URL contains invalid characters or uses an unsupported protocol (e.g., HTTP instead of HTTPS), it will not be accepted. In such cases, the user will be redirected back to the registration page without the returnUrl query parameter.
82
83 (% lang="EN-US" %)
84 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
85
86 (% lang="EN-US" %)
87 === Electronic agreement application Norway ===
88
89 (% lang="EN-US" %)
90 The customer access the direct debit sign up as an HTML form on your website. The customer authenticates with BankID, choose bank account from which the money is to be deducted, fills monthly amout limit, reviews the information related to the agreement and then submits by signing with BankID. The agreement is forwarded to the bank for confirmation and will be visible in both the customers internet bank and on the customer information in PayEx web interface when activated. For further information about the concept please visit: [[https:~~/~~/www.mastercardpaymentservices.com/norway/utvikler/pvuoverview>>url:https://www.mastercardpaymentservices.com/norway/utvikler/pvuoverview]]
91
92 (% lang="EN-US" %)
93 You may offer the Electronic agreement service within your own "My Site" or as a part of your onboarding process of registering as a new customer. A link to the form can also be sent to the customer e.g. via sms or e-mail.
94
95 (% lang="EN-US" %)
96 The HTML form on your website inter​act with the E-Agreement via an http post. A guide how to set up the web form and http post is found here: [[https:~~/~~/www.mastercardpaymentservices.com/norway/utvikler/pvugetstarted>>url:https://www.mastercardpaymentservices.com/norway/utvikler/pvugetstarted]]
97
98 In order for AvtaleGiro sign up to work a unique KID-number needs to be created for every customer.
99
100 KID number at PayEx always consists of 12 digits by default, e.g.(% style="font-family:Calibri,sans-serif; font-size:11pt" %) (% style="background:yellow; font-family:Calibri,sans-serif; font-size:11pt" %)1234567(% style="background:lime; font-family:Calibri,sans-serif; font-size:11pt" %)0000(% style="background:aqua; font-family:Calibri,sans-serif; font-size:11pt" %)X
101
102 (% style="margin:0cm" %)
103 (% style="background:yellow; font-family:Calibri,sans-serif; font-size:11pt" %)7 digits (%%)= customer number sent to PayEx
104
105 (% style="margin:0cm" %)
106 (% style="background:lime; font-family:Calibri,sans-serif; font-size:11pt" %)4 digits (%%)= used at PayEx for invoice serial number per customer and ledger (may also be filled out with all zeroes when generating KID, i.e. in sign up for AvtaleGiro)
107
108 (% style="margin:0cm" %)
109 (% style="background:aqua; font-family:Calibri,sans-serif; font-size:11pt" %)1 digit (%%)= control digit
110
111
112 (% style="margin:0cm" %)
113 Modulus 10 is used as algorithm to calculate the control digit.
114
115 (% style="margin:0cm" %)
116 Learn more about modulus and how to generate KID here: [[https:~~/~~/www.mastercardpaymentservices.com/norway/utvikler/kid>>url:https://www.mastercardpaymentservices.com/norway/utvikler/kid]]
117
118
119 (% lang="EN-US" %)
120 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
121
122 (% id="HVerifiedpayment-Verifieratbetalsatt" %)
123 == Verified payment - Verifierat betalsätt ==
124
125 With Verified payment the change to automated payments through Autogiro/AvtaleGiro is activated only when the payment rules in the CUSIN file is changed accordingly. This verification ensures that i.e. the customer invoice fee is correct at all times.
126
127 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
128
129 This is achieved by activating or deactivating direct debit as part of the verified payment service in the PaymentRule element of the CUSIN file.
130
131 Payment Rules:
132 UseBGAGSE = Autogiro (Sweden)
133 UseBKAGNO = AvtaleGiro (Norway)
134
135 Set Value to 1 for activation and Value to 0 for deactivation.
136
137 {{code language="xml" title="**Payment rule Autogiro**"}}
138 <CUSIN>
139 <CUSINInfo>
140 <PaymentInfo>
141 <Set>
142 <PaymentRules>
143 <PaymentRule Rule="UseBGAGSE">
144 <Value>1</Value>
145 </PaymentRule>
146 </PaymentRules>
147 </Set>
148 </PaymentInfo>
149 </CUSINInfo>
150 </CUSIN>
151 {{/code}}
152
153 == E-Invoice - eFaktura ==
154
155 The eFaktura service enables distribution of bills electronically, either to a customer's online banking system or directly to a business ERP system.
156
157 === E-invoice internet bank B2C ===
158
159 To distribute and get paid via the online banking system the customer needs to give their consent in the internet bank.
160
161 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
162
163 When the customer applies for the service PayEx handles the consent and you will retrieve information about activated/deactivated consents in Customer Journal.
164
165 An active consent will set distribution method to e-invoice and override any DistributionType set in Cusin, meaning that by default the next invoice produced will use the specified distribution method.
166
167 === eFaktura internet bank B2C Norway ===
168
169 eFaktura 2.0 is a "one click applies to all"-solution used by the norwegian online banking system. To use eFaktura 2.0 the customer needs to give their consent to the service in the internet bank.
170
171 In order to make eFaktura 2.0 available as a distribution method on a specific customer PayEx will do lookups in Nets eFaktura Service alias register. Therefore, these alias parameters (perfect match) must be sent to PayEx in order to generate a match to each specific customer at Nets. The following rules outline which alias combinations will return a match when doing lookups:
172
173 * **SSN**, //or//
174 * 2 of 3 of the following: **Phone number**, **e-mail**, **zip code**
175
176 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
177
178 When the customer applies for the service PayEx handles the consent and you will retrieve information about activated/deactivated consents in Customer Journal.
179
180 An active consent will set distribution method to e-invoice and override any DistributionType set in Cusin, meaning that by default the next invoice produced will use the specified distribution method.
181
182 === E-faktura internet bank B2C Sweden ===
183
184 The customer apply for e-faktura (e-invoice) and give consent in their internet bank.
185
186 RegNo/nationalIdentifier (SSN) needs to be sent to PayEx as it is the identifier used by e-faktura.
187
188 === E-faktura internet bank B2C Finland ===
189
190 The customer apply for e-faktura (e-invoice) and give consent in their internet bank.
191
192 RegNo/nationalIdentifier (SSN) needs to be sent to PayEx as it is the identifier used by e-faktura.
193
194 === Vipps eFaktura Norway ===
195
196 Customer using eFaktura automatically has the possibility to use Vipps Regning. Regardless of whether the customer apply for Vipps Regning or eFaktura they will receive the invoice electronically __both __in their Vipps app and in their online bank as eFaktura.
197
198 Thereby both eFaktura and Vipps Regning are defined as EInvoiceB2CSE.
199
200 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
201
202 When the customer applies for the service PayEx handles the consent and you retrieve information about activated/deactivated consents in Customer Journal.
203
204 An active consent will set distribution method to e-invoice and override any DistributionType set in Cusin, meaning that by default the next invoice produced will use the specified distribution method.
205
206 === E-Invoice B2B ===
207
208 You can distribute bills business to business (B2B) electronically. To retrieve and import bills directly into a business customer's ERP system (e.g through EHF, EDI or Svefaktura) you need to send a technical specification of the necessary requirements from the receiving system, in order for PayEx to verify format and structure.
209
210 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
211
212 If invoice distribution in cusin is set to EInvoiceB2B, the following information is mandatory in the EDIInfo:
213 - Customer VAN
214 - Buyer ID
215 - Seller ID
216
217 If any of these values is not supplied, an error is created and the invoices will not be distributed B2B. As fallback an invoice copy will be distributed by postal service to the customers Billing Address.
218
219 (% id="HVerifieddistribution-Verifieratdistributionssatt" %)
220 == Verified distribution - Verifierat distributionssätt ==
221
222 With Verified distribution the change to electronic distribution through E-Invoice B2C is activated only when the distribution rules in the CUSIN file is changed accordingly. This verification ensures that i.e. the customer invoice fee is correct at all times.
223
224 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
225
226 This is achieved by activating or deactivating E-Invoice B2C as part of the Verified distribution service in the DistributionRule element of the CUSIN file.
227
228 Distribution Rules:
229 UseEInvoiceB2CSE = E-faktura (Sweden)
230 UseEInvoiceB2CNO = eFaktura (Norway)
231 UseEInvoiceB2CFI = EInvoice (Finland)
232
233 Set Value to 1 for activation and Value to 0 for deactivation.
234
235 **N.B.** No activation is needed if distribution is made by B2B EDI (DistributionType EInvoiceB2B is used).
236
237 {{code language="xml" title="**Distribution rule eFaktura**"}}
238 <CUSIN>
239 <CUSINInfo>
240 <DistributionInfo>
241 <Set>
242 <BillTypes>
243 <BillType DistributionBillType="I_Invoice">
244 <DistributionRules>
245 <DistributionRule Rule="UseEInvoiceB2CSE">
246 <value>1</value>
247 </DistributionsRule>
248 </DistributionsRules>
249 </BillType>
250 </BillTypes>
251 </Set>
252 </DistributionInfo>
253 </CUSINInfo>
254 </CUSIN>
255 {{/code}}
256
257 == Kivra (Sweden only) ==
258
259 To distribute via Kivra, your customer needs to sign up for a Kivra account.
260
261 **N.B.** Can only be used if specially contracted with PayEx, contact us to learn more.
262
263 When the customer applies for the service PayEx handles the consent and you will retrieve information about activated/deactivated consents in Customer Journal.
264
265 An active consent will set distribution method to Kivra and override any DistributionType set in Cusin.
266
267 == Settle surplus payment ==
268
269 (% class="wikigeneratedid" %)
270 If an invoice is paid in excess, a credit is created. PayEx supports automatic settlement on the receivables instead of disbursement.
271
272 (% class="wikigeneratedid" %)
273 The credit amout can be used to either:
274 - settle an overdue invoice, or
275 - to be deducted from the amout to be payed on the next invoice (typically applicable when billing of subscription services).
276
277 (% class="wikigeneratedid" %)
278 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
279
280 == Unpaid costs in arrear ==
281
282 If only the original capital amout is paid on an invoice claim, fees and interest remain to be paid.
283
284 PayEx supports handling of unpaid costs in arrear by billing the remaining costs at the same time as the next invoice is created (typically applicable when billing of subscription services).
285
286 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
287
288 == Invoice layout ==
289
290 You can tailor you invoice according to your business needs - from adding you company logotype to editing invoice columns and request a more thorough customization.
291
292 === Adding logotype ===
293
294 To use your own logotype for invoices generated by PayEx Invoice Service you need to send a logotype image to [[setup.invoice@payex.com>>mailto:setup.invoice@payex.com]] together with customer identification.
295
296 (% class="table-bordered table-striped" %)
297 |=Property|=Description
298 |Format|.jpg or .pcx
299 |Resolution|300 DPI or higher is highly recommended
300 |Max Height|1,7 cm
301 |Max Width|8 cm
302
303 === Editing invoice columns ===
304
305 You have the possibility to specify the structure and presentation of your invoice columns. This is done directly you CUSIN file that you send to PayEx.
306
307 Read more about [[editing invoice colums here>>doc:Main.Invoicing.invoice-service.Implementation guide.Invoice columns.WebHome]]. To see extended details of example columns of different length, please visit the [[Invoice layout examples >>doc:Main.Invoicing.invoice-service.Implementation guide.Invoice columns.Invoice layout examples.WebHome]]section.
308
309 === Customised invoice layout ===
310
311 If you want to have a customised layout that goes beyond the general framework presented above, you can use PayEx' customised layout. This supplemental service enable a wider range of options to create a tailor made invoice template. This service is set up together with PayEx in order to create and verify templates. Please contact us for more information regarding this service.
312
313 == Late fee ==
314
315 (% data-placeholder="Översättning" dir="ltr" id="tw-target-text" %)
316 Companies and authorities can be charged a Late fee immediately after the due date has passed. The fee replaces the reminder and collection fee.
317
318 (% dir="ltr" %)
319 To use Late fee LegalEntity must be set to Business.
320
321 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
322
323 == Invoice attachment ==
324
325 (% data-placeholder="Översättning" dir="ltr" id="tw-target-text" %)
326 PayEx Invoice Service offers the possibility to add invoice attachments/enclosures. The attachment will be produced as an extra page following the invoice document. Attachments can be distributed both electronically and by postal service.
327
328 (% dir="ltr" %)
329 To use Invoice attachment a pdf-document is required consisting of one or more pages.
330
331 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
332
333 == Protected Identity (Sweden only) ==
334
335 (% data-placeholder="Översättning" dir="ltr" id="tw-target-text" %)
336 Private individuals can be registered with the status of Protected identity at the Swedish Tax Agency (Skatteverket), meaning the personal data such as name and address are protected and not available in public population register.
337
338 (% data-placeholder="Översättning" dir="ltr" %)
339 In order to distribute invoices and letters by mail, ProtectedIdentity must be set which allows special postal distribution service handled by Skatteverket.
340
341 (% data-placeholder="Översättning" dir="ltr" %)
342 ProtectedIdentity must be set in combination with a correct RegNo in order for postal distribution via Skatteverket to work.
343
344 (% dir="ltr" %)
345 **N.B. **Every end customer with protected identity must have ProtectedIdentity set at all times, regardless of preferred distribution method, as this also sets the label of protected identity as a customer status displayed in GUI, etc.
346
347 (% id="HPayExConnectAPI" %)
348 == PayEx Invoice Service API ==
349
350 PayEx Invoice Service API is a REST API integration that enables access to PayEx services in a controlled and secure manner.
351 Access to this service requires explicit permissions on a organizational level and implementation of token based authentication for each specific ledger.
352
353 **N.B. **Can only be used if specially contracted with PayEx, contact us to learn more.
354
355 Learn more about PayEx API:s [[here>>doc:Main.Invoicing.invoice-service.invoice-service-apis.WebHome]]
356
357 Using API as an add-on to Cusin file integration for Invoice Service will give you access to the following API:s
358
359 * Customer
360 * Invoice