Register

 

Description

The purpose of the Register call is to send all the data needed to complete a transaction to Netaxept. During the registration, Netaxept will accept and store the transaction, and reply with a transaction ID that refers to the transaction in question.

The input data is organized into a RegisterRequest, and the output data is formatted as a RegisterResponse. Example of the Register call and the corresponding response can be found in the "Sample code" section.

 

API call

REST

Please note that Server Name Indication (SNI) is required when connecting to Netaxept test environment URL https://test.epayment.nets.eu

Web Services

Register (string merchantId, string token, RegisterRequest request) -> RegisterResponse

 

Input parameters

Available input parameters in the RegisterRequest are listed below. Please see proper validation rules at the “Validation” section.

 

Authentication

Merchant ID

REST: merchantId

WebServices: merchantId

Required

Validation: Numeric

MaxLength: 8

Merchant ID is a unique ID generated by Nets for identifying each merchant in Netaxept. You need to send this ID to Netaxept along all API calls. Test accounts may have a maximum length of 8 digits, while production accounts has a maximum length of 6 digits.

 

Token

REST: token

WebServices: token

Required

Validation: Reference

MaxLength: 32

Token is the shared secret between the merchant and Netaxept. It is used to authenticate the merchant, and is provided to you by Netaxept.

RegisterRequest

Service type

REST: serviceType

WebServices: ServiceType

Optional [B]

Validation: Alpha

MaxLength: 1

Service Type indicates which kind of payment window will be used for this transaction. If Service type is omitted, Netaxept will use the default value "B". Valid values are:

  • B = The payment window will be hosted by Netaxept.
  • M = The payment window will be hosted by the merchant.
  • C = The transaction will be a call center transaction, and no payment window will be shown to the customer.
  • A = The transaction will be processed without showing the payment window to the customer.

 

Transaction ID

REST: transactionId

WebServices: TransactionId

Optional [Netaxept generated]

Validation: Reference

MaxLength: 32

Transaction ID is a unique ID identifying each transaction within the Merchant ID in Netaxept at any point. If Transaction ID is omitted, Netaxept will generate a unique Transaction ID for the transaction.

 

Transaction reference number

REST: transactionReconRef

WebServices: TransactionReconRef

Optional

Validation: Reference

MaxLength: 32

The transaction reconciliation reference is a reference number allocated to the transaction by the merchant. The transaction reference number will be returned to the merchant with the settlement if the chosen acquirer supports the return of the transaction-specific reference number. The transaction reference number can also be seen in the merchant's bank statement when direct bank payments are in question. Read more about transaction reference numbers >

Transaction reference number can be sent to Netaxept along the Register call. This reference number will then serve as a default reference if the new transaction reference number is omitted in the Process call. The transaction reference number can also be omitted altogether.

 

Description

REST: description

WebServices: Description

Optional

Validation: Custom

MaxLength: 4000

Free-format textual description of this part of the transaction / operation determined by the merchant and displayed to the merchant in Netaxept Admin. The field can show also an IP address and/or a username that has been used for the transaction.

Please note that this is different than OrderDescription parameter and hereby is not shown to the end-customer to the payment window.

Order (Required)

The Order section is required, and contains order details for the transaction.

Order number

REST: orderNumber

WebServices: Order.OrderNumber

Required

Validation: Alpha with characters within range hex 21 to hex 7E (decimal 33 to decimal 126) in the ASCII table.

MaxLength: 32
Handelsbanken: 16
NETS Prepaid: 23

Direct banks via Paytrail: 22

A transaction identifier defined by the merchant. Nets recommends to generate each transaction a unique order number but if wanted the same order number can be used several times. Digits and letters are allowed except special characters and scandinavian letters like Æ Ø Å Ä Ö.

 

Currency code

REST: currencyCode

WebServices: Order.CurrencyCode

Required

Validation: Alpha

MaxLength: 3

The currency code for the transaction amount, following ISO 4217. For example "NOK", "SEK", "DKK", "EUR" and "USD".

 

Amount

REST: amount

WebServices: Order.Amount

Required

Validation: Numeric

MaxLength: 10

The transaction amount described as the lowest monetary unit without punctuation marks and excluding any fees. For example: 100,00 NOK is noted as "10000" and 9.99 USD is noted as "999".

The max amount possible for this value is to specify 2147483647, the maximum value of a signed 32 bit integer.

 

Force 3D Secure

REST: force3DSecure

WebServices: Order.Force3DSecure

Optional

Validation: Boolean

MaxLength: 10

Set this variable to "true" if the customer must be fully authenticated by 3D Secure (ECI = 05 or 02) to be able to complete the transaction.

 

Update stored payment info

REST: updateStoredPaymentInfo

WebServices: Order.UpdateStoredPaymentInfo

Optional

Validation: Boolean

MaxLength: 10

If this variable is set to "true", the payment window will work in "Easy Payment" mode, and will not make complete transactions. It will be changed to reflect the fact that the customer is not completing a full transaction, rather changing or updating their payment information for future transactions (either Easy payment or Recurring payments). For example when registering a payment using updateStoredPaymentInfo=true and recurring fields, transaction amount is not specified and order description text is not displayed in the payment window, and instead of "Pay" button, the customer will see "Register" button as to register their card in the payment window.

With UpdateStoredPaymentInfo, the Process (Verify) call is also available for the transaction. This call will confirm that the card used in the purchase is currently valid and active and can be used for later transactions. Read more about Process (Verify) call >

 

Delivery date

REST: deliveryDate

WebServices: Order.DeliveryDate

Optional

Validation: Numeric

MaxLength: 8

Date when Netaxept automatically executes the Process (Capture) call for the transaction, on the format YYYYMMDD. When using this parameter, the merchant needs to run the Process (Auth) after the Register call as normal but then the Process (Capture) will the taken care of by Netaxept.

 

Goods

REST:

WebServices: Order.Goods

Optional

Validation: Custom

MaxLength: N/A

The Goods list is an array of Item entries, one Item representing one product line / item. The Goods object is a mandatory object for invoice and instalment payment methods implemented via Netaxept. Read more about invoices and instalments >

For each Item in the Goods list, the following parameters are available. Also, it should be noted that when working with REST interface, the format of these parameters needs special formatting. As the number of items is variable, you need to send a parameter "numberOfGoods" indicating how many product lines / items should be expected in the Goods list. Then, indexed from 1 up to "numberOfGoods", pass the parameters as amount_N, articleNumber_N etc. where "N" is the serial number of the item. In Web services, numberOfGoods parameter is not needed.

  • Amount (required)
  • ArticleNumber (required if Title missing)
  • Discount
  • Handling
  • IsVatIncluded
  • Quantity (required)
  • Shipping
  • Title (required if ArticleNumber missing)
  • VAT

Amount

Indicates the price of the individual item including the possible VAT. It can have maximum of two decimal places. The amount needs to be described as the lowest monetary unit without punctuation marks and excluding any fees. For example: 100,00 NOK is noted as "10000" and 9.99 USD is noted as "999". Please note that when accumulating the total sum of each item, it must match the sum specified for the transaction as a whole in the Amount / Order.Amount parameter.

ArticleNumber

ArticleNumber is a string that specifies the unique identifier for the item.

Discount

Discount for the item. Use the "." character as delimiter.

Handling

Specifies whether the handling is included in the item data, on the boolean format: true or false.

IsVatIncluded

Specifies whether the VAT is included in the item price, on the boolean format: true or false.

Quantity

Quantity of items bought in the specific Item object.

Shipping

Specifies whether the shipping is included in the item data, on the boolean format: true or false.

Title

Title is a string that is the descriptive name or description for the item.

VAT

The value-added tax percentage (VAT%) for the item. Use the "." character as a delimiter. For example: VAT 24% should be set as 24.00 or 24

When refunding the payment, the VAT% for the item to be refunded should match the VAT% of the corresponding original item.

 

Environment (Required)

The Environment section is required if Web Services is used for implementation.

Web service platform

REST: N/A

WebServices: Environment.WebServicePlatform

Required (if Web Services)

Validation: Custom

MaxLength: N/A

Indicates which Web Services technology is used when calling Netaxept. This field is required to allow us to track problematic technologies which may cause merchants' Netaxept implementations to break when Netaxept interface is upgraded. Valid platforms are:

  • WCF
  • DOTNET20
  • PHP5
  • ZSI
  • SUDS

If you are using another Web Services technology, please check with our Web Services blacklist. If your technology is not on either list, please contact Netaxept Customer Support for your country to have your technology evaluated. Do not "just pick one" to get the Register call through, problems will probably occur in the future if you do this. If using Web Services and this parameter is omitted, the transaction will be rejected with a SecurityException.

 

Operating system

REST: OS

WebServices: Environment.OS

Optional

Validation: Custom

MaxLength: N/A

Indicates which operating system is being used on the merchant's platform. 

 

Language

REST: environmentLanguage

WebServices: Environment.Language

Optional

Validation: Custom

MaxLength: 1500

Indicates which programming language is being used to implement the merchant's solution.

Terminal (Optional)

The Terminal section is optional, and contains information about the behavior of the payment window. It is optional for Call centre transactions (that is, when the ServiceType is set to "C").

Order description

REST: orderDescription

WebServices: Terminal.OrderDescription

Optional

Validation: Custom

MaxLength: 1500

Free-format textual description determined by the merchant for the transaction. This can be HTML-formatted. If you are using Netaxept hosted payment window, this description will appear in the payment window for the customer. Unlike the other fields, the order description will not cause the call to fail if it exceeds its maximum amount, rather the field will be truncated to its maximum amount.

 

Language

REST: language

WebServices: Terminal.Language

Optional ["no_NO"]

Validation: Custom

MaxLength: 5

Indicates which language is used in the Netaxept hosted payment window (that is, when using ServiceType "B"). If the terminal language is omitted, the default language is set to Norwegian. Valid values are:

  • no_NO = Norwegian
  • sv_SE = Swedish
  • da_DK = Danish
  • fi_FI = Finnish
  • en_GB = English
  • de_DE = German
  • fr_FR = French
  • ru_RU = Russian
  • pl_PL = Polish
  • es_ES = Spanish
  • it_IT = Italian
  • et_EE = Estonian
  • lv_LV = Latvian
  • lt_LT = Lithuanian

 

Redirect URL

REST: redirectUrl

WebServices: Terminal.RedirectUrl

Optional

Validation: URL

MaxLength: 256

Indicates where to send the customer when the transaction after the Register call and Terminal phase. This URL can contain GET parameters.

The redirect URL is optional when using "AutoAuth", and shouldn't be used with Call centre transactions.

 

Payment method action list

REST: paymentMethodActionList

WebServices: Terminal.PaymentMethodActionList

Optional

Validation: Custom

MaxLength: N/A

The paymentMethodActionList is an array of PaymentMethodAction entries. That is, JSON objects, each representing a rule on how to handle payment methods, fees and certain actions for selected payment methods. For example:

[{"PaymentMethod":"Visa","Fee":"100"},{"PaymentMethod":null,"Fee":"200"}]

Any rules here will overrule the corresponding rules set in Netaxept Admin's "Issuer fees" section. For each rule in the action list, the following parameters are available:

  • PaymentMethod
  • Fee
  • CardType
  • CardOrigin
  • Bin
  • Action

PaymentMethod

This is used to indicate which payment methods to display in the payment window and in which order. The payment methods should be comma separated. If the payment method list is omitted, all the payment methods will be shown in the default order. Also, it should be noted that the payment window will only show payment methods that are registered to the merchant used. Valid payment methods are:

Payment cards

  • AcceptCard = AcceptCard
  • AmericanExpress = American Express
  • DanishConsumerCard = Forbrugsforeningen (Danish loyalty card)
  • DanishDebitMasterCard = MasterCard Debit (Danish merchants only)
  • DanishDebitVisa = Visa Debit (Danish merchants only)
  • Dankort = Dankort
  • DinersClubInternational = Diners Club
  • JCB = JCB
  • Maestro = Maestro
  • MasterCard = MasterCard
  • NordeaECreditWhiteCard = Nordea e-Credit whitecard
  • NordeaFinans = Nordea Finance
  • NorwegianResursBank = Resurs Bank Norway
  • ResursBank = Resurs Bank
  • SwedishDebitMasterCard = MasterCard Debit (Swedish merchants only)
  • SwedishDebitVisa = Visa Debit (Swedish merchants only)
  • SwedishResursBank = Resurs Bank Sweden
  • Visa = Visa

 

Direct banks

  • BalticBankNordea = Nordea Baltic direct bank (incl. Estonia, Latvia, Lithuania)
  • BankAxess = BankAxess
  • BankAxessMobile = BankAxess via mobile app
  • EstonianBankSEB = SEB Estonia direct bank
  • EstonianBankSwedbank = Swedbank Estonia direct bank
  • FinishBankAktia = Aktia Finland direct bank
  • FinishBankAlandsbanken = Ålandsbanken Finland direct bank
  • FinishBankHandelsbanken = Handelsbanken Finland direct bank
  • FinishBankNordea = Nordea Finland direct bank
  • FinishBankOmaSaastopankki = Oma Säästöpankki Finland direct bank
  • FinishBankOp = OP Finland direct bank
  • FinishBankPopPankki = POP Pankki Finland direct bank
  • FinishBankSaastopankki = Säästöpankki Finland direct bank
  • FinishBankSampo = Danske Bank Finland direct bank
  • FinishBankSPankki = S-Pankki Finland direct bank
  • LatvianBankDnb = DNB Latvia direct bank
  • LatvianBankSEB = SEB Latvia direct bank
  • LatvianBankSwedbank = Swedbank Latvia direct bank
  • LithuanianBankDnb = DNB Lithuania direct bank
  • LithuanianBankSEB = SEB Lithuania direct bank
  • LithuanianBankSwedbank = Swedbank Lithuania direct bank
  • PaytrailAktia = Aktia Finland direct bank via Paytrail
  • PaytrailAlandsbanken = Ålandsbanken Finland direct bank via Paytrail
  • PaytrailDanskeBank = Danske Bank Finland direct bank via Paytrail
  • PaytrailHandelsbanken = Handelsbanken Finland direct bank via Paytrail
  • PaytrailNordea = Nordea Finland direct bank via Paytrail
  • PaytrailOmaSaastopankki = Oma Säästöpankki Finland direct bank via Paytrail
  • PaytrailOP = OP Finland direct bank via Paytrail
  • PaytrailPOP = POP Pankki Finland direct bank via Paytrail
  • PaytrailSaastopankki = Säästöpankki Finland direct bank via Paytrail
  • PaytrailSPankki = S-Pankki Finland direct bank via Paytrail
  • Sofortbanking = SOFORT direct bank
  • SwedishBankDanskeBank = Danske Bank Sweden direct bank
  • SwedishBankHandelsbanken = Handelsbanken Sweden direct bank
  • SwedishBankNordea = Nordea Sweden direct bank
  • SwedishBankSEB = SEB Sweden direct bank
  • SwedishBankSEBCompany = SEB Sweden Company direct bank
  • SwedishBankSEBPrivate = SEB Sweden Private direct bank
  • SwedishBankSwedbank = Swedbank Sweden direct bank

 

Invoice and instalment

  • Collector = Collector invoice
  • CollectorAccount = Collector account
  • CollectorInstallment = Collector instalment
  • GothiaInstallment = AfterPay instalment
  • GothiaInvoice = AfterPay invoice
  • HandelsbankenInstallment = Handelsbanken instalment
  • HandelsbankenInvoice = Handelsbanken invoice
  • Klarna = Klarna invoice
  • KlarnaInstallment = Klarna instalment
  • Lindorff = Lindorff invoice and instalment

 

Prepaid solutions

  • GiftCard = Gift card / Gavekort
  • GiftCardCenter = Gift card center
  • iGiveGiftCard = iGive gift card
  • iGivePromoCard = iGive Promo gift card
  • PBSPrepaidCard = Nets Prepaid card
  • SB1GiftCard = SB1 gift card
  • SB1GiftCardCenter = SB1 gift card center

 

Wallet based payment methods

  • MasterPass = Masterpass
  • Mobilepay = MobilePay
  • Vipps = Vipps

 

Other

  • PayPal = PayPal
  • Linkmobility = Link Mobility / SMS payment

 

Fee

Fee is used to optionally add a fee to certain payment methods, described as the lowest monetary unit without punctuation marks. For example: 100,00 NOK is noted as "10000" and 9.99 USD is noted as "999". The fee will be added to the original amount. The fee will apply to all payment methods if no PaymentMethod value is specified. For example:

[{"PaymentMethod":null,"Fee":"200"}]

CardType

CardType is a string which indicates the card type (credit/debit) for which a fee is defined. It can be one of the following: Credit, Debit, All. "All" is the default value.

CardOrigin

CardOrigin is a string which incidates the country issuing the payment cards for which the fee is added. It can be one of the following: International, Domestic, All. "International" is the default value.

BIN

BIN is used to indicate the 6 digits at the beginning of the card numbers for which the rule applies. For example: "123456".

Action

Specifies the action you want to execute to the transactions that meet the rules you have defined. It can be one of the following:

  • Allow = If the payment is flagged by the rule, a fee is added. This is default value.
  • Reject = If the payment is flagged by the rule, the transaction is rejected.

 

Payment method list
[Deprecated]

REST: paymentMethodList

WebServices: Terminal.PaymentMethodList

Optional

Validation: Custom

MaxLength: N/A

Payment method list is deprecated, and we strongly urge that you do implementations through the Payment method action list (above).

This is used to indicate which payment methods to display in the payment window and in which order. The payment methods should be comma separated. If the payment method list is omitted, all the payment methods will be shown in the default order. Also, it should be noted that the payment window will only show payment methods that are registered to the merchant used. The list of the valid payment methods is specified in the description for the Payment method action list (above). An example of a valid payment method list is:

MasterCard,Visa,Dankort

 

Fee list
[Deprecated]

REST: feeList

WebServices: Terminal.FeeList

Optional

Validation: Custom

MaxLength: N/A

Payment method list is deprecated, and we strongly urge that you do implementations through the Payment method action list (above).

The fee list is used to optionally add a fee to certain payment methods. For the fee list, which is per transaction, to work as expected, the paymentMethodList must be present. The number of entries in the fee list must match the number of entries in the paymentMethodList.

An example of a feeList is: 100,200

Given a paymentMethodList of Visa,MasterCard, Visa transactions will have a 100 fee applied and MasterCard transactions will have a 200 fee applied. The amount format is in the lowest monetary unit for the given currency.

 

VAT

REST: terminalVat

WebServices: Terminal.Vat

Optional

Validation: Numeric

MaxLength: 10

Specifies how much of the transaction amount is value added tax (VAT), described as the lowest monetary unit without punctuation marks. For example: 100,00 NOK is noted as "10000" and 9.99 USD is noted as "999". The VAT will be presented in the payment window and in Netaxept Admin.

Please note that VAT is included in the original amount, meaning that Netaxept regards this amount as a part of the total transaction amount, as to not affect this amount. This is different from fee that is always added to the original amount.

 

Automatic authorization

REST: autoAuth

WebServices: Terminal.AutoAuth

Optional [false]

Validation: Boolean

MaxLength: 10

If autoAuth is set to "true", Netaxept runs automatically the Process (Auth) call to the transaction at the end of the registration process. During the authorization a cash provision is made for the customer's account for the agreed amount.

Using automatic authorization allows merchants to send out a payment request using other means than a reqular webshop, for example a payment link via email or SMS (that is, Link payment). If used without a redirect URL, the payment window will show a localized "Payment completed" type of message.

Please note that "autoAuth" and "autoSale" should not be specified together, as they are mutually exclusive.

 

Automatic sale

REST: autoSale

WebServices: Terminal.AutoSale

Optional [false]

Validation: Boolean

MaxLength: 10

If autoSale is set to "true", Netaxept runs automatically the Process (Sale) call to the transaction at the end of the registration process. During the sale, a cash provision is made for the customer's account for the agreed amount and the account is captured for the same amount.

Using automatic sale allows merchants to send out a payment request using other means than a reqular webshop, for example a payment link via email or SMS (that is, Link payment). If used without a redirect URL, the payment window will show a localized "Payment completed" type of message.

Please note that "autoAuth" and "autoSale" should not be specified together, as they are mutually exclusive.

 

Terminal design

REST: terminalDesign

WebServices: Terminal.Design

Optional [true]

Validation: Custom

MaxLength: 128

Name of the terminal template used for the payment. With Terminal design parameter you can control the look of the payment window on a per transaction basis. If this parameter is sent in, it will look up the correct template from the template names in the list of available templates. If the template cannot be looked up by name, the default template will be used.

 

Template data

REST: templateData

WebServices: Terminal.TemplateData

Optional [true]

Validation: Custom

MaxLength Key: 64  
Maxlength Value: 8000

Template data is an array of key/value pairs. This data is per transaction and will be merged into the active template. If the template contains tags on the form {keyname /}, the region will be replaced by the value associated with the key "keyname".

Using Web Services, create an array of KeyValuePair entries, and set the Key and Value fields as desired.

Using REST, use the field templateData which expects JSON data on the following form: {"key1":"value1","key2":"value2"}. Remember, that like all other input values, this field needs to be properly URL encoded.

 

Terminal single page

REST: terminalSinglePage

WebServices: Terminal.SinglePage

Optional [true]

Validation: Boolean

MaxLength: N/A

The terminal single page option can be used to change the behavior of the Netaxept hosted payment window from being multi page to being single page. Because of the nature of this mode, singlePage works only for card payments, and excludes other payment methods. Also mobile terminal doesn't support single page mode.

In single page mode, the card input fields will be consolidated into a single input field, with the different card options shown as small icons. On entering the card number, the selected card type will light up as visual feedback to the customer.

 

Terminal layout

REST: terminalLayout

WebServices: Terminal.Layout

Optional [true]

Validation: Custom

MaxLength: N/A

If Terminal layout is set to "mini", the minimized version of the payment window is activated to only cover the input fields for a payment card. The minimized version is great to use within the Terminal design templates made by you, in order to give you most of the web page area for your own design.

In mini layout mode, the error messages will not be displayed inside the mini payment window in order to keep it as minimized as possible. Instead, the error message can be placed anywhere else on the webpage when you are using a Terminal design templates that include the Netaxept tag, by using the specific error tag {netaxept:errorMessage /}. When using mini payment window, this tag is mandatory.

Given that an iPhone/iOS template is used for Netaxept mobile, the top navigation bar will not be shown if terminalLayout is specified as "mini". This doesn't currently apply to the other templates.

Customer (optional)

The Customer section is optional, and contains information about the end-customer. The data entered will be shown only to the merchant via the Query call and in the web-based Netaxept Admin.

Customer number

REST: customerNumber

WebServices: Customer.CustomerNumber

Optional

Validation: Custom

MaxLength: 64

The customer's ID that can be used to identify the end-customer or the customer group. The same customer number can be used several times.

 

Customer email

REST: customerEmail

WebServices: Customer.Email

Optional (required if direct banks via Paytrail)

Validation: Custom

MaxLength: 128

The customer's email address.

 

Customer phone number

REST: customerPhoneNumber

WebServices: Customer.PhoneNumber

Optional

Validation: Custom

MaxLength: 64

The customer's phone number. The phone number should be given on the format of +[country code][phone number]. For example: +4712345678, +469876543, +35850123456.

 

Customer first name

REST: customerFirstName

WebServices: Customer.FirstName

Optional (required if DnBNorDirectPayment or direct banks via Paytrail)

Validation: Custom

MaxLength: 64

Customer's first name.

 

Customer last name

REST: customerLastName

WebServices: Customer.LastName

Optional (required if DnBNorDirectPayment or direct banks via Paytrail)

Validation: Custom

MaxLength: 64

Customer's last name.

 

Customer address 1

REST: customerAddress1

WebServices: Customer.Address1

Optional (required if DnBNorDirectPayment or direct banks via Paytrail)

Validation: Custom

MaxLength: 64

Customer's address.

 

Customer address 2

REST: customerAddress2

WebServices: Customer.Address2

Optional

Validation: Custom

MaxLength: 64

Customer's secondary address.

 

Customer post code

REST: customerPostcode

WebServices: Customer.Postcode

Optional (required if DnBNorDirectPayment or direct banks via Paytrail))

Validation: Custom

MaxLength: 16

Customer's postal code.

 

Customer town

REST: customerTown

WebServices: Customer.Town

Optional (required if DnBNorDirectPayment or direct banks via Paytrail)

Validation: Custom

MaxLength: 64

Customer's city.

 

Customer country

REST: customerCountry

WebServices: Customer.Country

Optional (required if invoice/instalment or direct banks via Paytrail)

Validation: N/A

MaxLength: N/A

Customer's country, following ISO 3166-1 Alpha 2 code. For example: "NO", "SE", "DK", "FI".

 

Customer social security number

REST: customerSocialSecurityNumber

WebServices: Customer.SocialSecurityNumber

Optional (required if PayByBill)

Validation: Custom

MaxLength: 20

Customer's social security number.

 

Customer's company name

REST: customerCompanyName

WebServices: Customer.CompanyName

Optional (required if SEB direct payment "foretak")

Validation: Custom

MaxLength: 128

The customer's company name.

Set this field for SEB direct payment to indicate direct payment as a business customer, and let this field be empty for SEB direct payment to indicate direct payment as a private customer.

 

Customer's company registration number

REST:
CompanyRegistrationNumber

WebServices: Customer.CompanyRegistrationNumber

Optional

Validation: N/A

MaxLength: N/A

The business ID of the customer's company.

 

Customer notification mode

REST:
customerNotificationMode

WebServices: Customer.NotificationMode

Optional (used only for Klarna)

Validation: Custom

MaxLength: 32

This parameter is used only for Klarna to notify Klarna about the way how invoice is to be sent.

  • MAIL = Invoice is to be sent to customer by post.
  • EMAIL = Invoice is to be sent to customer by email.

CardInfo (optional)

The CardInfo section is optional, and contains card data needed to complete the transaction. It is only required for Call centre transactions (that is, when the Service Type is set to "C").

PAN

REST: pan

WebServices: CardInfo.Pan

Optional

Validation: Numeric

MaxLength: 20

The card number without spaces to be used for this transaction.

 

Expiry date

REST: expiryDate

WebServices: CardInfo.ExpiryDate

Optional

Validation: Numeric

MaxLength: 4

The expiry date for the card to be used for this transaction, on the format MMYY.

 

Security code

REST: securityCode

WebServices: CardInfo.SecurityCode

Optional

Validation: Numeric

MaxLength: 4

The verification code for the card to be used for this transaction.

For example the verification code for Visa (CVV2), MasterCard (CVC2) and Diners Club (CVV) is the last 3 digits printed on the back of your card. The American Express verification code (CID) is a 4-digit number printed on the front of your card.

Recurring (optional)

The Recurring section is optional, and is only used if the transaction should have subsequent withdrawals on it (that is, Easy paymen or Recurring payments). Please note that recurring functionality may or may not be available to a merchant depending on which agreements they have signed with Netaxept and their chosen acquirer.

Recurring type

REST: recurringType

WebServices: Recurring.Type

Optional (required if panHash is supplied)

Validation: Alpha

MaxLength: 1

Which kind of recurring transaction to create. Valid values are:

  • S = Store the card information needed to perform recurring transactions on a card. The customer initiates the following transaction. That is, Easy payment where the customer pays with one click for any purchases made after the initial purchase.
  • R = Store the card information needed to perform recurring transactions on a card alongside information about frequency and when the agreement expires. The merchant initiates the following transaction. That is, Recurring payment where the merchant captures the card in accordance with the agreement made between the merchant and the customer, without the customer re-entering card information during later purchases. 

 

Recurring frequency

REST: recurringFrequency

WebServices: Recurring.Frequency

Optional (required if Type = "R")

Validation: Numeric

MaxLength: 5

Indicates how often the merchant is allowed to make withdrawals based on the recurring agreement, in days. A recurring frequency of "1" will allow the merchant to make subsequent transactions on the card every day.

Minimum frequency is 0 day, meaning no limitation on the number of transactions per day. Maximum is 365 days.

 

Recurring expiry date

REST: recurringExpiryDate

WebServices: Recurring.ExpiryDate

Optional (required if Type = "R")

Validation: Numeric

MaxLength: 8

Date when the recurring agreement made between the merchant and the customer expires. The date is described on the format YYYYMMDD.

 

PanHash

REST: panHash

WebServices: Recurring.PanHash

Optional (required if subsequent transaction)

Validation: Base64

MaxLength: N/A

The token value identifying the transaction. It is independent of the PAN and is not considered as a hash value.

If the current transaction is a subsequent transaction, this parameter is required to identify the transaction. Then also recurringType needs to be supplied.

It is the merchant's responsibility to store tokens in a secure way and restrict access to data on a need to know basis. The merchant undertakes not to store tokens on a frontend system exposed to the internet or directly on mobile devices.

 

PanHash secret

REST: panhashSecret

WebServices: Recurring.PanHashSecret

Optional

Validation: Base64

MaxLength: 20

Merchants can add an extra layer of protection to their panHash parameters by adding a secret token linked to these parameters.

AvtaleGiro (optional)

The AvtaleGiro section is optional, and is only used when using AvtaleGiro as a payment method. To give the customer this option, the following parameters need to be supplied along the Register call.

KID (Customer ID)

REST: avtaleGiroKid

WebServices: AvtaleGiro.Kid

Required (if AvtaleGiro)

Validation: Numeric

Validated by AvtaleGiro to a legal KID number

MinLength: 2

MaxLength: 25

The customer's ID that can be used to identify the customer.

 

Account number

REST: avtaleGiroAccountNumber

WebServices: AvtaleGiro.AccountNumber

Optional (will be fetched from merchant's settings if not sent)

Validation: Numeric

Validated by AvtaleGiro to a legal account number

MinLength: 11

MaxLength: 11

The account number of the webshop's account to which the money should be transferred for each AvtaleGiro capture.

Netaxept will store this value in the merchant's settings, but the stored value can be overridden by sending the account number parameter along the Register call.

 

Company name

REST: avtaleGiroCompanyName

WebServices: AvtaleGiro.CompanyName

Optional (will be fetched from merchant's settings if not sent)

Validation: N/A

MaxLength: 256

The company name of the webshop. The name must match exactly the company name defined in the agreement between the merchant and AvtaleGiro.

Netaxept will store this value in the merchant's settings, but the stored value can be overridden by sending the company name parameter along the Register call.

 

Amount limit

REST: avtaleGiroAmountLimit

WebServices: AvtaleGiro.AmountLimit

Optional (a suggestion will be calculated if not sent)

Validation: Numeric

MaxLength: 16

The suggested amount limit of this AvtaleGiro agreement between the customer and his bank. That is, the maximum amount of each capture.

Please note that the amount limit can be changed by the customer when they are signing the AvtaleGiro agreement.

DnBNorDirectPayment (Optional)

The DnBNorDirectPayment section is optional, and is only used when using DnBNor direct payment as a payment method. The transaction is considered a DnBNor direct payment transaction if the "ToAccount" is present. In that case, the following fields also become required in the Register call.

  • Customer Address 1
  • Customer First Name
  • Customer Last Name
  • Customer Postcode
  • Customer Town

The credited account

REST: DnBNorDirectPaymentToAccount

WebServices: DnBNorDirectPayment.ToAccount

Required

Validation: Numeric

MaxLength: N/A

Indicates which account should be credited if the transaction succeeds.

 

KID

REST: DnBNorDirectPaymentKID

WebServices: DnBNorDirectPayment.KID

Optional

Validation: Numeric

MaxLength: N/A

An ID identifying the customer and/or transaction.

 

Message

REST: DnBNorDirectPaymentMessage

WebServices: DnBNorDirectPayment.Message

Optional

Validation: Custom

MaxLength: N/A

An ID identifying the customer.

 

Output parameters

Available output parameters in the RegisterResponse are listed below.

Transaction ID

REST: TransactionId

WebServices: RegisterResponse.TransactionId

Required

Validation: Reference

MaxLength: 32

Transaction ID is a unique ID identifying each transaction within the Merchant ID in Netaxept at any point. If merchant has generated Transaction ID by themselves and sent it along the Register call to Netaxept, the same Transaction ID value is returned in the Register response. If Transaction ID is omitted, Netaxept will generate a unique value for the transaction in question and return it in the Register response. 

 

Exceptions and response codes

If something goes wrong when communicating between your system and Netaxept or in the middle of the payment process, Netaxept declines the transaction and returns an exception. All exceptions are wrapped in the outer Exception tag, with an Error tag inside. The type (xsi:type) of the Error tag indicates which exception it is. In most cases, the exception includes the error code indicating the error, as well as an error message explaining the code. The Register call can throw the following exceptions. Read more about exceptions > and response codes >

  • AuthenticationException
  • BBSException
  • MerchantTranslationException
  • UniqueTransactionIdException
  • GenericError
  • ValidationException
  • SecurityException

 

Next step

Send the customer to the payment window

If you used service type "B" (Netaxept hosted payment window) or "M" (Merchant hosted payment window) in the Register call, use the Terminal call to send the customer to the payment window for entering their payment method information. Read more about the Terminal call >

Process Call Centre transaction

If you used service type "C" in the Register call, use the Process (Auth) call to authorize the payment or the Process (Sale) call to authorize and capture the payment. Read more about the Process calls >

Send payment link to the customer

If you don't have a webshop, but have done the registration successfully, you can send a payment link to the customer for example by SMS or email. This URL follows the same format as the URL used with the Terminal call. If you decide to send payment links to customers, it is recommended to set the AutoAuth or AutoSale (automatic authorization or automatic sale) to "true" in the Register call.