Netaxept REST API

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 have a maximum length of 8 digits, while production accounts have a maximum length of 7 digits.

Shared secret between the merchant and Netaxept that is used to authenticate the merchant and is provided to you by Netaxept.

Indicates the payment window to be used for this transaction. If omitted, Netaxept will use the default value B. Valid values are:

• B: Flagged as eCommerce. Payment window is hosted by Netaxept.

• M: Flagged as eCommerce. Payment window is hosted by the merchant.

• C: Flagged as call center (MOTO). No payment window is displayed. Used in call center transactions and in subsequent merchant initiated transactions (MIT).

• A: Flagged as eCommerce. No payment window is displayed. Used especially for app payments.

A unique ID identifying each transaction within the Merchant ID in Netaxept at any point. If omitted, Netaxept will generate a unique Transaction ID for the transaction and return it in the response.

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. It can also be seen in the merchant's bank statement when direct bank payments are in question. Read more about transaction reference numbers.

The transaction reference number sent to Netaxept along the Register call will serve as a default reference unless the new transaction reference number is sent along the Process call.

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

Note that this is different than OrderDescription, which is displayed to the end customer in the payment window.

Only used for the payment method Vipps. If set to true, the customer phone number is not mandatory for Vipps payments when using ServiceType=M.

Required for delegated authentication app transactions. If you want to apply delegated authentication exemption to the transaction originated from the merchant's certified delegated authentication app, pass the card scheme certified value in this parameter together with scaExemption=3.

Transaction identifier defined by the merchant. Nets recommends to generate each transaction 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 Ø Ä Ö. Handelsbanken: 16, NETS Prepaid: 23, Direct banks via Paytrail: 22, Vipps: 30 AN.

Currency code for the transaction amount according to ISO 4217. For example 'NOK', 'SEK', 'DKK', 'EUR' and 'USD'.

Transaction amount described as the lowest monetary unit for the given currency 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 maximum amount possible for this value is 2147483647, the maximum value of a signed 32 bit integer.

Amount is optional if updateStoredPaymentInfo=true is set in the Register call.

If set to true, the customer must be fully authenticated by 3D Secure or the equivalent authentication method to be able to complete the transaction.

Used when saving card details for subsequent transactions. If set to true, it indicates card registration or update of earlier stored card details, without processing a full purchase. Read more about tokenization services.

When using updateStoredPaymentInfo=true, no transaction amount and order description are displayed in the payment window. Instead of the "Pay" button, the customer will see the "Register" button to register their card in the payment window.

When using UpdateStoredPaymentInfo, the Process (Verify) call should be used for the transaction if it is available for the payment method. 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.

Indicates the SCA exemption type applied to the transaction. Use this parameter to request an exemption from Strong Customer Authentication (SCA) without the need to perform 3D Secure authentication. Note that exemptions are not allowed to be used in connection with initial transactions when card details are saved for subsequent transactions. Valid values are:

• 1: Low value payment. Do not add this parameter if the amount is higher than 30 EUR.

• 3: Delegated authentication. Please contact Nets to enable this for your Merchant ID.

If set to true, it triggers SCA for Walley. This functionality currently works for the following countries:

• Finland when customerCountry=FI and currencyCode=EUR

• Norway when customerCountry=NO and currencyCode=NOK

• Sweden when customerCountry=SE and currencyCode=SEK

• Denmark when customerCountry=DK and currencyCode=DKK

When using this parameter, Transaction ID needs to be at least 21 characters.

Date when Netaxept automatically executes the Process (Capture) call for the transaction, in 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 be managed by Netaxept.

Indicates the authorization type. Required for AFD / EV charging transactions. These features are in pilot phase with selected merchants. Valid values are:

• Fuel: Authorization for transaction originated from automated fuel dispenser. 3D Secure (or equivalent) authentication is required for the transaction.

• Electric: Authorization for electric vehicle charging. Currently supported in Nets acquiring.

Indicates how many product lines / items should be expected in the list of goods. At least one product is required for inovice. The list of goods is defined using the following properties: amount (required), articleNumber (required), discount, handling, isVatIncluded, quantity (required), shipping, title (required), unitCode, VAT.

Each item in the list is indexed from 1 up to numberOfGoods. Pass the parameters as amount_N, articleNumber_N etc. where 'N' is the ordinal number of the item.

At least one item required for invoice and installment payment methods implemented via Netaxept. Read more about invoices and installments.

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 for the given currency 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.

Specifies the unique identifier for the item.

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

Specifies whether the handling is included in the item data.

Specifies whether the VAT is included in the item price.

Quantity of items bought.

Specifies whether the shipping is included in the item data.

A descriptive name for the item.

Assigned to each item. The unit code should start from 0 and it will get incremented based on the number of items.

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.

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

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

Free-format textual description determined by the merchant for the transaction. This can be HTML-formatted. If you are using a 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 length. Rather, the field will be truncated to its maximum length.

Indicates which language is used in the Netaxept-hosted payment window (that is, when using ServiceType=B). If omitted, the language is set to Norwegian. See also the list of valid languages.

Indicates where to send the customer after the transaction passes 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 center transactions.

An array of PaymentMethodAction entries. These are JSON objects, each representing rules on how to handle payment method, fee and certain actions for the selected payment method. The format is specified at Payment method action list.

This parameter is deprecated, and we strongly urge you to do the implementation through the Payment method action list (above).

This parameter is deprecated, and we strongly urge you to do the implementation through the Payment method action list (above).

Specifies how much of the transaction amount is value added tax (VAT), described as the lowest monetary unit for the given currency 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.

Note that VAT is included in the original amount, meaning that Netaxept regards this amount as 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.

If set to true, Netaxept runs automatically the Process (Auth) call to the transaction after the Register call and Terminal phase. During the authorization, a cash provision is made for the customer's account for the agreed amount.

Using automatic authorization enables merchants to send out payment requests using ways other than a regular 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 because they are mutually exclusive.

• By default, some payment methods (e.g. wallets and some invoice payment methods) run the Process (Auth) call to the transaction after the Terminal phase, even if the merchant does not set autoAuth=true.

If set to true, Netaxept runs automatically the Process (Sale) call to the transaction after the Register call and Terminal phase. 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 enables merchants to send out payment requests using ways other than a regular 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 because they are mutually exclusive.

• By default, some payment methods (e.g. direct bank payments) run the Process (Sale) call to the transaction after Terminal phase, even if the merchant does not set autoSale=true.

Name of the terminal template you have created in Netaxept Admin that will be used for the payment. With this parameter you can control the appearance of the payment window on a transaction basis. If this parameter is sent in, it will overrule any template that has been marked as active in Netaxept Admin and look up the correct template from the template names in the list of available templates. If the template cannot be looked up by name from Netaxept Admin, the default template will be used.

Template data is an array of key/value pairs and contains all the tags and their values that will replace the special HTML tags inside the template. This data is per transaction and will be merged into the active template. Several tags can be placed within curly brackets and different tags and their values are separated by a colon. If the template contains tags on the form {keyname /}, the region will be replaced by the value associated with the key "keyname".

Create an array of KeyValuePair entries, and set the Key and Value fields as desired.

Maximum length of key: 64. Maximum length of value: 8000.

If set to true, the Netaxept-hosted payment window changes from two-page to single page. Because of the nature of this mode, the single-page payment window works only for card payments, not for 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. When the customer enters their card number, the selected card type will be highlighted as visual feedback to the customer.

Layout of the payment window to be used for the transaction. Valid values are:

• mini: The minimized version of the payment window is used to only include input fields for cards. The minimized version is ideal within the Terminal design templates so that you can get the most out of the web page area for your own design. If 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 apply to the other templates.

• custom: If you use Custom templates, set the terminalLayout to 'custom'.

If set to true, Terminal will redirect back to the merchant site if an error occurs.

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

The customer email address. Required if direct banks via Paytrail.

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

Customer first name.

Customer last name.

Customer address.

Customer secondary address.

Customer postal code.

Customer town.

Customer country according to ISO 3166-1 Alpha 2 code. For example: 'NO', 'SE', 'DK', 'FI', 'DE'.

CustomerCountry is required when using invoice, PayPal or direct banks payment methods via Paytrail.

If set to true, only business-to-business payment window (company related fields) will be displayed to the customer. Required if a B2B payment window should be requested.

Only used for the payment method SEPA Direct Debit via PPRO. Customer's IBAN number. Required if the customers are to enter their IBAN number on your website.

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.

The customer's company name.

The business ID of the customer's company.

Indicates the way an invoice should be sent. Valid values are:

• MAIL: Invoices will be sent to customers by post after each transaction.

• EMAIL: Invoices will be sent to customers by email after each transaction. Customer email address is a mandatory in Register call.

• AGGREGATEDINVOICE: All incoming invoices during the same month will be aggregated to one invoice that has the same reference number every month and will be sent to the customer by email. Customer email address is mandatory in Register call. Can be used only for Walley invoices where it is a so-called "Account" invoice type.

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

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

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) consists of the last 3 digits printed on the back of the card. The American Express verification code (CID) is the 4-digit number printed on the front of the card.

This section contains the information needed to save card details for subsequent transactions and perform later transactions on a card. It is only required when merchant uses our tokenization services. Read more about the tokenization services.

Valid values for defining tokenization types are:

Initial transaction

• S: Indicates that card details are saved for future Easy payments or MIT transactions (excl. recurring payment).

• R: Indicates that card details are saved for future recurring payments.

Subsequent transaction

• S: Indicates that stored card details are used to perform subsequent Easy payments by card. RecurringType of the initial transaction must be 'S'.

• R: Indicates that stored card details are used to perform subsequent recurring payments by card. RecurringType of the initial transaction must be 'R'.

• M: Indicates that stored card details are used to perform MIT transactions (excl. recurring payment). RecurringType of the initial transaction can be either 'S' or 'R'.

Indicates how often the merchant is allowed to charge the card based on the custom er agreement, in days. A frequency of '1' allows the merchant to make recurring payments on the card every day.

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

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

• When recurringType=R, the recurringExpiryDate is required.

• When recurringType=S, the recurringExpiryDate is optional.

Indicates the MIT transaction type (excl. recurring payment). Valid values are:

• 1: Unscheduled card-on-file (UCOF) Supported by all acquiring connections)

• 2: Delayed charge (Not supported in Swedbank acquiring)

• 3: No-show (Not supported in Swedbank acquiring).

The token value used in subsequent transactions to identify the transaction.

It is independent of the PAN and is not considered as a hash value. 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 frontend systems exposed to the internet or directly on mobile devices.

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

If set to true, together with recurringType=S, serviceType=B and panHash is specified for the subsequent transaction, the payment window will prompt the customer to perform 3D Secure or equivalent authentication. Otherwise subsequent transactions with stored cards are non-3DS authenticated.

Membership identifier for loyalty programs. The ID is validated only by its length which can be 10 digits. The same ID can be used several times.

Eligible amount for loyalty, described as the lowest monetary unit for the given currency without punctuation marks. For example: 100,00 EUR is noted as '10000'.

Eligible amount for payment method benefits, described as the lowest monetary unit for the given currency without punctuation marks. For example: 100,00 EUR is noted as '10000'.

If set to true, the card will be enrolled in the CardLink service while saving card details for future. With the CardLink service, merchants can identify and award their loyalty customers across different sales channels.

When using enableCardLink=true, updateStoredPaymentInfo must be set to true. The parameter customerLoyaltyId is optional, however, if not specified by the merchant and present, the unique value will be created and returned to merchant.

Sub-merchant's merchant category code (MCC) assigned by the acquirer. Required if Payment facilitator.

Required if Payment facilitator. Sub-merchant's marketing name (15), address (12), city (13), postal code (10), region (3), and country (3). All subfields need to be left justified with trailing spaces (or padded from the right with blanks if necessary). For example: 'Katti Oy Kaitalantie Helsinki 00510 FIN'.

Sub-merchant's merchant ID assigned by the acquirer or Payment facilitator. Required if Payment facilitator.

The customer's ID that can be used to identify the customer. Minimum length: 2.

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.

The company name of the webshop. The name must exactly match 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.

The suggested amount limit of this AvtaleGiro agreement between the customer and their bank. This is the maximum amount of each capture.

Note that the amount limit can be changed by the customer when they sign the AvtaleGiro agreement.

Only used for the payment method SEPA Direct Debit via PPRO. Description that appears on the customer's bank statement. Description sent to Register call is reused for credit. Note, it is up to each bank how many characters will be displayed on customer's bank statement or the bank may ignore the description altogether.

Only used for the payment method SEPA Direct Debit via PPRO. Indicates the party responsible for mandate and pre-notification sent to customer. Required unless transaction is subsequent. Valid values are:

• MANAGEDBYPPRO = Mandate and pre-notification are managed by PPRO.
• MANAGEDBYMERCHANT = Mandate and pre-notification are managed by merchant. In this case, also SepaMandateUrl is required.

Only used for the payment method SEPA Direct Debit via PPRO. URL for SEPA Direct Debit mandate. Required when PPRO.SepaModelType / pproSepaMandate = MANAGEDBYMERCHANT and should start with https:// or http://

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

Unique ID identifying each transaction within the Merchant ID in Netaxept at any point. Transaction ID used in this call needs to match the Transaction ID used with the Register call and in Terminal phase.

Card number to be used for this transaction. Required if you used Service type=M (Merchant hosted payment window) in the Register call.

Expiry date for the card to be used for this transaction, on the format 'MMYY'. Required if you used Service type=M (Merchant hosted payment window) in the Register call.

Security code for the card to be used for this transaction. Required if you used Service type=M (Merchant hosted payment window) in the Register call.

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 have a maximum length of 8 digits, while production accounts have a maximum length of 7 digits.

Shared secret between the merchant and Netaxept that is used to authenticate the merchant and is provided to you by Netaxept.

Specifies which financial operation you want to run for the transaction. Valid values are:

• AUTH

• VERIFY

• SALE

• CAPTURE

• CREDIT

• ANNUL

• ADJUST

Read more about the different operations at the Process payments outline page.

Unique ID identifying each transaction within the Merchant ID in Netaxept at any point. Transaction ID used in this call needs to match the Transaction ID used with the Register call and in Terminal phase.

Invoice ID generated for each invoice. Usually one invoice transaction has one invoice ID, however, if you run for example partial capture for an invoice transaction, an invoice with its own invoice ID will be created.

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

Please note that this is different than OrderDescription that is displayed to the end-customer on payment window.

Transaction amount described as the lowest monetary unit for the given currency without punctuation marks and excluding any fees. For example 100,00 NOK is noted as '10000' and 9.99 USD is noted as '999'. Note that both CREDIT and CAPTURE support partial captures and credits.

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

If no transaction amount is specified for CAPTURE or CREDIT, the full available amount will be captured or credited, respectively.

Required for the 'Adjust' operation. Indicates whether the adjusted amount is negative or positive. Adjusting the total invoice amount is currently supported for Walley. Valid values are:

• positive: Amount will be added to invoice.

• negative: Amount will be deducted from invoice.

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 default reference if the new transaction reference number is omitted in the Process call. The transaction reference number can also be omitted altogether. MaxLength: 25

Can be used with Capture operation for reversing an unused authorization amount after final partial capture. If set to true, Netaxept will send a request to issuer to release the excess authorization that will not be captured.

Note: This parameter should be used with Capture Call.

In case of multiple partial captures, isfinalcapture=false must be sent in connection with previous partial captures.

Supported for Visa, Mastercard, Dankort and Netsprepaid. Currently limited to Nets DK acquiring connection.

Indicates how many product lines / items should be expected in the list of goods. The list of goods is defined using the following properties: amount (required), articleNumber (required if title is missing), discount, handling, isVatIncluded, quantity (required), shipping, title (required if articleNumber is missing), unitCode, VAT.

Each item in the list is indexed from 1 up to numberOfGoods. Pass the parameters as amount_N, articleNumber_N etc. where 'N' is the ordinal number of the item.

At least one item required for invoice and installment payment methods implemented via Netaxept. Read more about invoices and installments.

Indicates the price of the individual item including any VAT. It can have a maximum of two decimal places. The amount needs to be described as the lowest monetary unit for the given currency without punctuation marks and excluding any fees. For example: 100,00 NOK is noted as '10000' and 9.99 USD is noted as '999'. 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.

Specifies the unique identifier for the item.

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

Specifies whether the handling is included in the item data.

Specifies whether the VAT is included in the item price.

Quantity of items bought.

Specifies whether the shipping is included in the item data.

A descriptive name for the item.

Assigned to each item. The unit code should start at 0, and then increase in increments based on the number of items.

The value-added tax percentage (VAT%) for the item. Use the '.' character as a delimiter. For example: VAT of 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.

Membership identifier for loyalty program. The ID is validated only by its length which can be 10 digits. The same ID can be used several times.

The MemberID received from your service provider.

Eligible amount for loyalty, described as the lowest monetary unit for the given currency without punctuation marks. For example: 100,00 EUR is noted as '10000'.

Eligible amount for payment method benefit, described as the lowest monetary unit for the given currency without punctuation marks. For example: 100,00 EUR is noted as '10000'.

Only used for the payment method SEPA Direct Debit via PPRO. Description that appears on the customer's bank statement. Description sent to Register call is reused for credit. Note, it is up to each bank how many characters will be displayed on customer's bank statement or the bank may ignore the description altogether.

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 have a maximum length of 8 digits, while production accounts have a maximum length of 7 digits.

Shared secret between the merchant and Netaxept that is used to authenticate the merchant and is provided to you by Netaxept.

Unique ID identifying each transaction within the Merchant ID in Netaxept at any point. The Transaction ID used in this call needs to match the Transaction ID used with the Register call.

Invoice ID generated for each invoice. Usually one invoice transaction has one invoice ID. However, if you run a partial capture for an invoice transaction. For example, an invoice with its own invoice ID will be created.

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 have a maximum length of 8 digits, while production accounts have a maximum length of 7 digits.

Shared secret between the merchant and Netaxept that is used to authenticate the merchant and is provided to you by Netaxept.

Searches settlement batch data for a given batch number, without considering timestamp.

Note: Required unless fromTimestamp and toTimestamp are specified.

Searches batch information from this date, in the format YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Required unless batchNumber specified.

Searches batch information to this date, in the format YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Required unless batchNumber specified.

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 have a maximum length of 8 digits, while production accounts have a maximum length of 7 digits.

Shared secret between the merchant and Netaxept that is used to authenticate the merchant and is provided to you by Netaxept. MaxLength: 32

Unique ID identifying each transaction within the Merchant ID in Netaxept at any point. The Transaction ID used in this call must match the Transaction ID used with the Register call.

Note: At least one of the following parameters must be specified: transactionId, maskedPan or panHash.

First digits (can be entered also more) of the card number used for this transaction.

Note: At least one of the following parameters must be specified: transactionId, maskedPan or panHash.

Token value used in a subsequent transaction to identify the transaction.

It is independent of the PAN and is not considered as a hash value. It is the merchant's responsibility to store tokens in secure way and restrict access to data on a need-to-know basis. The merchant undertakes not to store tokens on frontend systems exposed to the internet or directly on mobile devices.

Note: At least one of the following parameters must be specified: transactionId, maskedPan or panHash.