Skip to content

    Netaxept Soap API

    The Netaxept Soap API provides the following methods that enable you to perform and manage transactions through Netaxept:

    • Register
    • Terminal redirect
    • Process
    • Query
    • Get batch
    • Get card info

    Each method with its corresponding data types for input and output is fully documented on this page.

    Exceptions and error codes are documented separately on the page Exceptions and error codes.

    Register

    Once the customer has confirmed the order, send the Register call to Netaxept. 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.

    Signature

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

    Input parameters - Register

    • merchantIdstring (Numeric, MaxLength: 8)required

      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 6 digits.

    • tokenstring (Reference, MaxLength: 32)required

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

    • requestobjectrequired

      The request object.

      • ServiceTypestring (Alpha, Max length: 1)optional

        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.

      • TransactionIdstring (Reference, Max length: 32)optional

        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.

      • TransactionReconRefstring (Reference, Max length: 25)optional

        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.

      • Descriptionstring (Custom, Max length: 4000)optional

        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.

      • IsAppbooleanoptional

        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.

      • DigitalWalletIdstring (Custom, Max length: 32)required

        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.

      • Orderobjectrequired
        • OrderNumberstring (Alpha, Max length: 32)required

          Transaction identifier defined by the merchant. Nets recommends to generate each transaction unique order number, but the same order number can be used several times if desired. 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.

        • CurrencyCodestring (Alpha, Max length: 3)required

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

        • Amountstring (Numeric)required

          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.

        • Force3DSecurebooleanoptional

          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.

        • UpdateStoredPaymentInfostring (Boolean)optional

          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 "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.

        • SCAExemptionstring (Alpha, Max length: 1)optional

          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.

        • ValidateCustomerbooleanoptional

          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.

        • DeliveryDatestring (Numeric, Length: 8)optional

          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.

        • AuthTypestring (Alpha, Max length: 32)required

          Indicates the authorization type. These features are in pilot phase with selected merchants. Valid values are:

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

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

        • Goodsarrayrequired

          An array of Item entries, one Item representing one product line row. The Goods object is a mandatory object for invoice and installment payment methods implemented via Netaxept. Read more about invoices and installments.

          • Amountstringoptional

            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.

          • ArticleNumberstringoptional

            Specifies the unique identifier for the item.

          • Discountfloatoptional

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

          • Handlingbooleanoptional

            Specifies whether the handling is included in the item data.

          • IsVatIncludedbooleanoptional

            Specifies whether the VAT is included in the item price.

          • Quantityintoptional

            Quantity of items bought.

          • Shippingbooleanoptional

            Specifies whether the shipping is included in the item data.

          • Titlestringoptional

            A descriptive name for the item.

          • UnitCodestringoptional

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

          • VATfloatoptional

            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.

      • Environmentobjectrequired
        • WebServicePlatformstring (Custom)required

          Indicates which Web Services technology is used when calling Netaxept. This field is required to allow us to track problematic technologies which might cause merchants' implementations to break when Netaxept API is upgraded. If using Web Services and this parameter is omitted, the transaction will be rejected with SecurityException.

          Check our whitelisted and blacklisted Web Services platforms](). 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 randomly to get the Register call through - problems will probably occur in the future if you do this.

        • OSstring (Custom)optional

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

        • Languagestring (Custom, Max length: 1500)optional

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

      • Terminalobjectoptional
        • OrderDescriptionstring (Custom, Max length: 1500)optional

          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.

        • Languagestring (Custom, Max length: 5)optional

          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.

        • RedirectUrlstring (Url, Max length: 1024)optional

          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.

        • PaymentMethodActionListstring (Custom)optional

          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.

        • PaymentMethodListstring (Custom)optional

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

        • FeeListstring (Custom)optional

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

        • Vatstring (Numeric)optional

          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.

        • AutoAuthstring (Boolean)optional

          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.

        • AutoSalestring (Boolean)optional

          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.

        • Designstring (Custom, Max length: 128)optional

          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.

        • TemplateDatastring (Custom)optional

          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.

        • SinglePagestring (Boolean)optional

          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.

        • Layoutstring (Custom)optional

          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'.

        • RedirectOnErrorstring (Boolean)optional

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

      • Customerobjectoptional
        • SocialSecurityNumberstring (Custom, Max length: 20)optional

          Customer's social security number.

        • CompanyNamestring (Custom, Max length: 128)optional

          The customer's company name.

        • CompanyRegistrationNumberstring (Custom)optional

          The business ID of the customer's company.

        • NotificationModestring (Custom, Max length: 32)optional

          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 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.

        • CustomerIsCompanystring (Boolean)optional

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

        • AccountNumberstring (Max length: 32)optional

          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.

      • CardInfoobjectoptional
        • Panstring (Numeric, Max length: 20)optional

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

        • ExpiryDatestring (Numeric, Length: 4)optional

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

        • SecurityCodestring (Numeric, Max length: 4)optional

          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.

      • Recurringobjectoptional
        • Typestring (Alpha, Length: 1)required

          Defines the tokenization type. Valid values 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'.

        • Frequencystring (Numeric, Max length: 5)required

          Indicates how often the merchant is allowed to charge the card based on the customer 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.

        • ExpiryDatestring (Numeric, Max length: 8)required

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

        • RecurringTransactionTypestring (Alpha, Length: 1)required

          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).

        • PanHashstring (Base64)required

          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.

        • PanHashSecretstring (Base64, Max length: 20)optional

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

        • Use3DSstring (Boolean)optional

          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.

      • LoyaltyInformationstring (object)optional
        • CustomerLoyaltyIdstring (Custom, Max length: 32)optional

          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.

        • TransactionLoyaltyAmountstring (Numeric)optional

          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'.

        • PaymentMethodBenefitAmountstring (Numeric)optional

          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'.

        • EnableCardLinkstring (Boolean)optional

          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.

      • PaymentFacilitatorstring (object)optional
        • MCCstring (Custom, Max length: 4)required

          Sub-merchant's merchant category code (MCC) assigned by the acquirer.

        • MerchantDescriptorstring (Custom, Max length: 64)required

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

        • SubMerchantIdstring (Custom, Max length: 15)required

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

      • AvtaleGiroobjectoptional
        • Kidstring (Numeric, Max length: 25)required

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

        • AccountNumberstring (Numeric, Length: 11)optional

          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.

        • CompanyNamestring (Custom, Max length: 256)optional

          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.

        • AmountLimitstring (Numeric, Max length: 16)optional

          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.

      • DnBNorDirectPaymentobjecoptional
        • ToAccountstring (Numeric)required

          Indicates which account should be credited if the transaction succeeds.

        • KIDstring (Numeric)optional

          An ID identifying the customer and/or transaction.

        • Messagestring (Custom)optional

          An ID identifying the customer.

      • PPROobjectoptional
        • PPRODynamicDescriptorstring (Alphanumeric, Max length: 142)optional

          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, that 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.

        • SepaModelTypestring (Custom, Max length: N/A)required

          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.
        • SepaMandateUrlstring (Url, Max length: N/A)optional

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

    SOAP Register Response

    • RegisterResponseobjectoptional

      The object returned from a successful Register call.

      • TransactionIdstring (Reference, Max length: 32)required

        Unique ID identifying each transaction within the Merchant ID in Netaxept at any point. If the merchant has generated the 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 omitted, Netaxept will generate a unique value for the transaction in question and return it in the Register response.

      • WalletURLstring (Custom)optional

        The app switch URL to be used to enable app-switching from the merchant app to the payment method's app.

    Exceptions


    Terminal redirect

    After a successful Register call, you need to direct the customer’s web browser to the payment window in order for the customer to choose the payment method and enter payment method information.

    The terminal redirect is not part of the Soap API, instead it is documented in the Netaxept REST API.

    Process

    After the successful Register call and terminal phase, you can create a financial operation for the transaction. Available financial operations are AUTH, VERIFY, SALE, CAPTURE, ADJUST, CREDIT and ANNUL, and they all are encapsulated by the Process call. The Process must be made at the latest 365 days (1 year) after the initial Register call for the transaction. Some operations have time restrictions that are different from this:

    • Authorization (AUTH), account verification (VERIFY) and authorization & capture (SALE), must for most payment methods, be done within 24 hours of the time the customer is redirected back from the payment window. We recommend doing the further action as soon as possible.
    • CAPTURE must be done while the authorization is still valid, if applicable. Many card issuers use a 21-day limit. Beyond this, the response depends on the card issuer and the specific account.
    • CREDIT is available for 365 days.

    If you are using CAPTURE in conjunction with the fee, you need to run the Query call to get the total amount of the transaction before capturing, because the amount might have changed during the terminal phase. You can always CAPTURE up to the total amount regardless of whether or not you use fees.

    Signature

    Process(string merchantId, string token, ProcessRequest request) ->  ProcessResponse

    Input parameters - Process Request

    • merchantIdstring (Numeric, MaxLength: 8)required

      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 6 digits.

    • tokenstring (Reference, MaxLength: 32)required

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

    • ProcessRequestobjectrequired
      • Operationstring (Alpha)required

        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 Flow outline page.

      • TransactionIdstring (Reference, Max length: 32)required

        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.

      • SubTransactionIdstring (Reference, Max length: 32)optional

        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.

      • Descriptionstring (Custom, Max length: 4000)optional

        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.

      • TransactionAmountstring (Numeric)optional

        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.

      • AdjustmentTypestring (Alpha, Max length: 50)required

        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.

      • TransactionReconRefstring (Reference)optional

        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

      • Goodsarrayoptional

        An array of Item entries, one Item representing one product line row. The Goods object is mandatory object for invoice and instalment payment methods implemented via Netaxept. Read more about invoices and installments.

        • Amountstringoptional

          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.

        • ArticleNumberstringoptional

          Specifies the unique identifier for the item.

        • Discountfloatoptional

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

        • Handlingbooleanoptional

          Specifies whether the handling is included in the item data.

        • IsVatIncludedbooleanoptional

          Specifies whether the VAT is included in the item price.

        • Quantityintoptional

          Quantity of items bought.

        • Shippingbooleanoptional

          Specifies whether the shipping is included in the item data.

        • Titlestringoptional

          A descriptive name for the item.

        • UnitCodestringoptional

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

        • VATfloatoptional

          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.

      • CustomerLoyaltyIdstring (Custom, MaxLength: 32)optional

        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.

      • TransactionLoyaltyAmountstring (Numeric)optional

        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'.

      • PaymentMethodBenefitAmountstring (mumeric)optional

        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'.

      • PPRODynamicDescriptorstring (Alphanumeric, Max length: 142)optional

        Only used for the payment method SEPA Direct Debit via PPRO. The description that appears on the customer’s bank statement to indicate customer what the direct debit on their bank account is about. Description sent to Register call is reused for credit. Note, that it is up to each bank how many characters will be displayed on customer's bank statement. The bank might even ignore the description altogether.

    Response

    • ProcessResponseobjectoptional

      The object returned from a successful Process call.

      • Operationstring (Alpha)required

        Echoed from the Process call.

      • TransactionIdstring (Reference, Max length: 32)required

        Echoed from the Process call.

      • SubTransactionIdstring (Reference, Max length: 32)optional

        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.

      • MerchantIdstring (Reference, Max length: 32)required

        Echoed from the Process call.

      • ResponseCodestring (Alpha)required

        The response code will be set to the string 'OK' if the transaction was processed correctly. Any other response is an error, and should be logged with the Response Source and the Response Text. Read more about response codes.

      • ResponseSourcestring (Alpha)optional

        Textual description of which part of the system generated the response code. The response codes are divided into groups according to the source. Read more about response codes.

      • ResponseTextstring (Custom)optional

        Explains the response code and gives more detailed description of the response code. Read more about response codes.

      • AuthorizationIdstring (Custom, Max length: 64)required

        The unique ID given to an authorized transaction by the Issuer.

      • ExecutionTimestring (Timestamp)required

        A timestamp indicating when the operation in question was finished. This timestamp is generated on the Netaxept server.

      • BatchNumberstring (Numeric)required

        Specifies which settlement batch this operation belongs to.

    Exceptions


    Query

    The Query call can be used to request information related to the transaction from Netaxept. Netaxept then returns detailed information concerning the transaction, such as the status of the transaction and the payment method used.

    Signature

    Query(string merchantId, string token, QueryRequest request) ->  QueryResponse

    Input parameters

    • merchantIdstring (Numeric, MaxLength: 8)required

      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 6 digits.

    • tokenstring (Reference, MaxLength: 32)required

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

    • requestobjectrequired

      The request object.

      • TransactionIdstring (Reference, MaxLength: 32)required

        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.

      • SubTransactionIdstring (Reference, MaxLength: 32)optional

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

    Query Response

    • QueryResponseobjectoptional

      The object returned from a successful Query call.

      • MerchantIdstring (Reference, Max length: 32)required

        Echoed from the Query call.

      • TransactionIdstring (Reference, Max length: 32)required

        Echoed from the Query call.

      • ChildTransactionidstring (Reference)optional

        Unique ID identifying the remaining part of the gift card transaction that has been paid using another payment method.

      • QueryFinishedstring (Timestamp)required

        Timestamp indicating when the Query operation was finished. This timestamp is generated on the Netaxept server.

      • OrderInformationobjectoptional
        • OrderNumberstring (Reference, Max length: 32)required

          Transaction identifier defined by the merchant. Nets recommends that you generate a unique order number for each transaction, but the same order number can be used several times if desired. Digits and letters are allowed except special characters and Scandinavian letters like Ø Ä Ö.

        • Amountstring (Numeric)required

          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.

        • Currencystring (Alpha, Max length: 3)required

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

        • DeliveryDatestring (Numeric, Max length: 8)optional

          For card payments this is the date when Netaxept automatically executes the Process (Capture) call for the transaction, in the format YYYYMMDD. When using this parameter, you must run the Process (Auth) after the Register call as normal but then the Process (Capture) will be managed by Netaxept. For SEPA Direct Debit it is the planned due date (the earliest day when the money will be debited from the customer's bank account.

        • Feestring (Numeric, Max length: 10)required

          An additional charge determined by the merchant for the transaction, 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.

        • OrderDescriptionstring (Custom, Max length: 1500)optional

          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.

        • Timestampstring (Timestamp)required

          Timestamp indicating when the operation in question was finished. This timestamp is generated on the Netaxept server.

        • Totalstring (Numeric, Max length: 10)required

          The sum of transaction amount fee 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'.

        • RoundingAmountstring (Numeric)optional

          Rounding amount defined by the merchant for the transaction, 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'.

        • SCAExemptionstring (Alpha, Max length: 1)optional

          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.

      • AuthenticationInformationobjectoptional
        • AuthenticatedWithstring (Printable)optional

          Identifies which external authentication protocol, if any, has been used for the transaction. This field is set only for card transactions and currently can only be '3-D Secure'.

        • AuthenticatedStatusstring (Printable)optional

          The status of the 3D Secure authentication. Valid values are:

          • Y: Authentication successful. Cardholder was successfully authenticated.

          • N: Cardholder not enrolled in 3D Secure or equivalent authentication service.

          • U: Authentication could not be performed. Authentication could not be completed, due to technical problem.

          • A: Authentication attempted. Performed authentication could not be completed, but proof of authentication attempt (CAVV) was generated.

        • ECIstring (Numeric, Max length: 2)optional

          The authentication result that is returned if the transaction has been authenticated by 3D Secure authentication services:

          • 05 or 02: Card enrolled, authenticated OK.

          • 06 or 01: Authentication attempted, but the payment card was not enrolled for the authentication service.

          • 07 or 00: The merchant was not registered for the authentication service.

        • ECIDowngradedstring (Boolean)optional

          Indicates whether the transaction was downgraded by the card issuer and is returned only in that case. If ECI value is downgraded from fully authenticated transaction value, your chargeback rights will be diminished.

      • AvtaleGiroInformationobjectrequired
        • AvtaleGiroStatusstring (Custom)required

          If AvtaleGiro data was sent on the current transaction, an AvtaleGiro status is required to give the status of the signing of the AvtaleGiro agreement. Valid values are:

          • Ok: The signing of the AvtaleGiro agreement was OK.

          • Cancel: The signing of the AvtaleGiro agreement was cancelled by the customer.

          • Error: Something went wrong when signing the AvtaleGiro agreement.

      • CardInformationobjectoptional
        • MaskedPANstring (Custom, Max length: 19)optional

          Card number used for this transaction, masked with asterisks.

        • Issuerstring (Alpha, Max length: 32)optional

          Indicates which payment method was used for this transaction. This parameter will contain the same value as CardInformation.PaymentMethod.

        • ExpiryDatestring (Numeric, Max length: 4)optional

          Expiry date for the card used for this transaction, on the format YYMM.

        • PanHashstring (Base64)optional

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

        • IssuerCountrystring (Alpha, Max length: 2)optional

          Country where the payment card used for the transaction was issued, formatted following ISO 3166-1 Alpha code. For example: 'NO', 'SE', 'DK', 'FI'.

        • IssuerIdstring (Numeric, Max length: 4)optional

          Identifier for the payment method being used. May be either positive or negative.

        • PaymentMethodstring (Alpha, Max length: 32)optional

          Indicates which payment method was used for this transaction. Please see the valid payment methods at the Register call page in the 'Payment Method Action List' => 'PaymentMethod' parameter. For wallet based transactions, this parameter shows information about the underlying card whereas the name of the wallet used for the payment can be found in the 'Wallet' section.

      • CustomerInformationobjectoptional
        • Emailstring (Custom, Max length: 128)optional

          Customer's email address. Returned if the merchant has sent it to Netaxept along the Register call.

        • PhoneNumberstring (Custom, Max length: 64)optional

          Customer's phone number. Returned if the merchant has sent it to Netaxept along the Register call. The phone number should be given on the format of +[country code][phone number], for example: +4712345678, +469876543, +35850123456.

        • IPstring (Custom, Max length: 15)optional

          IP address of the customer's browser connection.

        • CustomerNumberstring (Custom, Max length: 64)optional

          Customer's ID that can be used to identify the customer or the customer group. The same customer number can be used several times. Returned if the merchant has sent it to Netaxept along the Register call.

        • FirstNamestring (Custom, Max length: 128)optional

          Customer's first name. Returned if the merchant has sent it to Netaxept along the Register call.

        • LastNamestring (Custom, Max length: 128)optional

          Customer's last name. Returned if the merchant has sent it to Netaxept along the Register call.

        • Address1string (Custom, Max length: 64)optional

          Customer's address. Returned if the merchant has sent it to Netaxept along the Register call.

        • Address2string (Custom, Max length: 64)optional

          Customer's secondary address. Returned if the merchant has sent it to Netaxept along the Register call.

        • Postcodestring (Custom, Max length: 16)optional

          Customer's postal code. Returned if the merchant has sent it to Netaxept along the Register call.

        • Townstring (Custom, Max length: 64)optional

          Customer's city. Returned if the merchant has sent it to Netaxept along the Register call.

        • Countrystring (Custom)optional

          Customer's country, following ISO 3166-1 Alpha code. For example: 'NO', 'SE', 'DK', 'FI' Returned if the merchant has sent it to Netaxept along the Register call.

        • SocialSecurityNumberstring (Custom, Max length: 32)optional

          Customer's social security number. Returned if the merchant has sent it to Netaxept along the Register call. Mandatory for certain payment methods.

        • CompanyNamestring (Custom, Max length: 128)optional

          Customer's company name. Returned if the merchant has sent it to Netaxept along the Register call.

        • CompanyRegistrationNumberstring (Custom)optional

          Business ID of the customer's company. Returned if the merchant has sent it to Netaxept along the Register call.

        • IsCompanybooleanoptional

          Indicates that only B-to-B payment window (company related fields) have been displayed to the customer. Returned true if the merchant has sent customerIsCompany=true to Netaxept along the Register call.

      • Recurringobjectrequired
        • Typestring (Custom)required

          Indicates which tokenization type is used for this transaction. Valid values are:

          • Recurring (Init)

          • Recurring (Pull)

          • Store (Init)

          • Store (Pull)

          'Recurring' refers to recurringType=R and 'Store' refers to recurringType=S. In addition, 'Init' means the initial transaction where card details have been stored for subsequent transactions whereas 'Pull' means the later transaction where panHash connected to the initial transaction is used.

        • Frequencystring (Numeric)optional

          Indicates how often the merchant is allowed to charge card based on the agreement made with the customer, in days. frequency of '1' will allow the merchant to make recurring payments on the card every day. Minimum frequency is day, meaning no limitation on the number of transactions per day. Maximum is 365 days.

        • ExpiryDatestring (Numeric, Max length: 8)optional

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

        • PanHashstring (Base64)required

          The token value identifying the card transaction. It is independent of the PAN and is not considered as hash value. If recurringType was specified, and no panHash was supplied, this is the panHash generated by the payment card registration and should be used for the later transaction.

        • PanHashSecretstring (Base64, Max length: 20)optional

          Secret token linked to their panHash parameters by the means of adding an extra layer of protection to their panHash parameters.

        • Use3DSbooleanoptional

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

      • PaymentErrorobjectoptional

        This section will contain the latest / newest element from the ErrorLog, and can be used for a comparison instead of running through the whole ErrorLog each time.

        • Operationstring (Alpha)required

          Specifies which financial operation was tried to perform for the transaction when the error occured. Valid values are: 'REGISTER', 'AUTH', 'ACCOUNT', 'VERIFICATION' 'SALE', 'CAPTURE', 'CREDIT', 'ANNUL', 'QUERY', 'ADJUST(Positive)' or 'ADJUST(Negative)'. Read more about the different operations at the Flow outline section . Max length: 16

        • ResponseCodestring (Alpha)required

          Response code for this part of the transaction. Only failed operations are entered into the error log, so this parameter will never contain the string 'OK'. Read more about response codes > Max length: 4

        • ResponseTextstring (Custom)required

          Response text message explains the error code and gives more detailed description of the error helping the merchant to find out why the transaction failed. Read more about response messages Max length: Custom

        • ResponseSourcestring (Alpha)required

          Textual description of which part of the system generated the error code. The error codes are divided into groups according to the source. Read more about error sources Max length: 16

        • DateTimestring (Timestamp)required

          Timestamp indicating when the operation in question was finished. This timestamp is generated on the Netaxept server.

      • SecurityInformationobjectoptional

        This section is present if sub-merchant data is sent along the transaction in payment facilitator setup.

        • CustomerIPCountrystring (Alpha, Max length: 2)required

          Country of the IP address of the customer's browser connection, following ISO 3166-1 Alpha 2 code. For example: 'NO', 'SE', 'DK', 'FI'.

        • IPCountryMatchesIssuingCountrybooleanoptional

          Indicates whether or not the country of the customer's IP address matches the country of the card Issuer.

      • TerminalInformationobjectoptional

        This section is present if sub-merchant data is sent along the transaction in payment facilitator setup.

        • Browserstringoptional

          Customer's browser information.

        • CustomerEnteredstring (Timestamp)optional

          Timestamp indicating when the customer has visited in the payment window. This timestamp is generated on the Netaxept server.

        • CustomerRedirectedstring (Timestamp)optional

          Timestamp indicating when the customer has been redirected or has been attempted to redirect from the payment window to the URL specified by the merchant. This timestamp is generated on the Netaxept server. Check this parameter to verify when Netaxept redirected the customer or tried to redirect.

      • PaymentFacilitatorInformationobjectrequired

        This section is present if sub-merchant data is sent along the transaction in payment facilitator setup.

        • MCCstring (Custom, Max length: 4)required

          Sub-merchant's merchant category code (MCC) assigned by the acquirer.

        • MerchantDescriptorstring (Custom, Max length: 64)required

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

          Testi Oy Kaitalantie Helsinki 00510 FIN

        • SubMerchantIdstring (Custom, Max length: 15)required

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

        • Issuerstring (Alpha)required

          Tells the name of the wallet based payment method being used. The actual payment card used for the payment can be found in CardInformation.PaymentMethod.

      • Walletobjectoptional

        This section is present if wallet based payment method was used for the payment.

        • Issuerstring (Alpha)required

          Tells the name of the wallet based payment method being used. The actual payment card used for the payment can be found in CardInformation.PaymentMethod.

      • InvoiceInformationobjectoptional

        This section is present if sub-merchant data is sent along the transaction in payment facilitator setup.

        • InvoiceIdstring (Numeric, Max length: 32)optional

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

      • FinancialSummaryobjectoptional
        • AmountCapturedstring (Numeric, Max length: 10)required

          Amount captured on this transaction, 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'. Check this parameter to confirm the payment is made.

        • AmountCreditedstring (Numeric, Max length: 10)required

          Amount credited on this transaction, 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'.

        • AdjustedAmountobjectrequired

          Amount which has been adjusted (either positive or negative) on this transaction.

          • NegativeAdjustedstring (Numeric, Max length: 10)optional

            Amount which has been adjusted negative on this transaction, 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'.

          • PositiveAdjustedstring (Numeric, Max length: 10)optional

            Amount which has been adjusted positive on this transaction, 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'.

        • Annulledbooleanrequired

          Indicates whether or not the authorization of this transaction has been cancelled.

        • AuthorizationIdstring (Custom, Max length: 64)optional

          ID given to an authorized transaction by the issuer.

        • Authorizedbooleanrequired

          Indicates whether or not this transaction has been authorized. Transaction is flagged as authorized if it has been processed with AUTH or SALE call. Max length: Custom

        • ChargeBackAmountstring (Numeric, Max length: 10)optional

          Only used for the payment method SEPA Direct Debit via PPRO. Indicates if transaction has received chargeback. The amount is described as the lowest monetary unit for the given currency without punctuation marks. For example: 100,00 EUR is noted as '10000'.

    Exceptions


    Get batch

    The Get batch call can be used to request data on transactions included with certain settlement batches. Netaxept then returns detailed information concerning the batches and their transactions.

    Signature

    Batch(string merchantId, string token, BatchRequest request) ->  BatchResponse

    Input parameters

    • merchantIdstring (Numeric, MaxLength: 8)required

      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 6 digits.

    • tokenstring (Reference, MaxLength: 32)required

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

    • requestobjectrequired

      The request object.

      • BatchNumberstring (Numeric)required

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

      • FromTimestampstring (Custom)required

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

      • ToTimestampstring (Custom)required

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

    Batch Response

    • BatchResponseobjectoptional

      The object returned from a successful Get batch call.

      • Summaryobjectrequired
        • TotalCapturedstring (Numeric)required

          Aggregated amount captured in the transactions displayed.

        • TotalCreditedstring (Numeric)required

          Aggregated amount credited in the transactions displayed.

        • TotalAdjustedPositivestring (Numeric)optional

          Aggregated amount positively adjusted in the transactions displayed.

        • TotalAdjustedNegativestring (Numeric)optional

          Aggregated amount negatively adjusted in the transactions displayed.

      • Itemsarrayrequired

        An array of BatchResponseItem(s) with one line for each transaction operation (Capture, Credit, Adjust). To get specific information on these transactions, please run the Query call to the transaction.

        • BatchResponseItemobjectoptional
          • Timestampstring (Timestamp)required

            Timestamp indicating when the operation in question was finished, on the format YYYY-MM-DDTHH:MM:SS.milliseconds+TZ. Timezone is optional. For example: 2010-02-15T14:35:19.305+01:00. This timestamp is generated on the Netaxept server.

          • Issuerstring (Alpha)required

            Indicates which payment method was used for this transaction. Max length: 32

          • Operationstring (Alpha, Max length: 7)required

            Specifies which operation was performed for the transaction. Valid values are:

            • CAPTURE (incl. Sale)

            • CREDIT ADJUST(Positive) or ADJUST(Negative)

            Read more about the different operations at the 'Flow outline' section.

          • MaskedPanstring (Custom, Max length: 19)required

            Card number used for this transaction, masked with asterisks.

          • Amountstring (Numeric)required

            Amount of this part of the transaction operation 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'.

          • AuthorizationIdstring (Custom, Max length: 64)required

            ID given to an authorized transaction by the Issuer.

          • Currencystring (Alpha, Max length: 3)required

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

          • BatchNumberstring (Numeric, Max length: 4)required

            Specifies which settlement batch this operation belongs to.

          • OrderNumberstring (Reference, Max length: 32)required

            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 Ø Ä Ö.

          • TransactionIdstring (Reference, Max length: 32)required

            Unique ID identifying each transaction within the Merchant ID in Netaxept at any point.

          • TransactionReconRefstring (Reference, Max length: 25)required

            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.

          • CustomerLoyaltyIdstring (Custom, Max length: 32)optional

            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.

          • TransactionLoyaltyAmountstring (Numeric)optional

            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'.

          • PaymentMethodBenefitAmountstring (Numeric)optional

            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'.

    Exceptions


    Get card information

    The GetCardInformation call can be used to retrieve information about the card used for the transaction. It is supported for all cards. Netaxept then returns detailed information concerning the card, such as issuer country, card type, card country code, card country name and card product type. The GetCardInformation call can be used, for example, to apply surcharging logic for saved card details when processing subsequent payments. When the customer is about to check out with saved card details, the merchant can retrieve the detailed information about that card and then assign and display a fee for the subsequent payment.

    If the GetCardInformation call is sent after the Register call, but before the Terminal call, Netaxept throws the GenericError with message "No card Information". The GetCardInformation call can be used for cards originally saved in Netaxept. If the card details have been imported from another PSP to Netaxept, retrieving all card details might not be possible.

    Signature

    GetCardDetails(string merchantId, string token, GetCardInfoRequest request) ->  GetCardDetailsResponse

    Input parameters

    • merchantIdstring (Numeric, MaxLength: 8)required

      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 6 digits.

    • tokenstring (Reference, MaxLength: 32)required

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

    • requestobjectrequired

      The request object.

      • Transactionidstring (Reference, Max length: 32)optional

        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.

      • MaskedPanstring (Numeric, Max length: 19)optional

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

      • PanHashstring (Base64)optional

        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.

    Response

    • GetCardInfoResponseobjectoptional

      The object returned from a successful Get card info call.

      • Issuerstring (Alpha, Max length: 32)required

        Indicates which payment method was used for the transaction. Valid values are listed in the tables found under the Payment methods section.

      • CardTypestring (Alpha)required

        Type of card used for the transaction. Valid values are: 'Debit', 'Credit'.

      • CountryCodestring (Numeric, Max length: 3)required

        Numeric code for the country where the card used for the transaction was issued, according to ISO 3166-1. For example: '246' for Finland and '752' for Sweden.

      • CountryNamestring (Alpha, Max length: 2)required

        Country where the card used for the transaction was issued, according to ISO 3166-1 Alpha code. For example: 'NO', 'SE', 'DK', 'FI'.

      • CardProductTypestring (Alpha)required

        Product type of the card used for the transaction. Valid values are: 'Private', 'Corporate'.

      • CardOriginstring (Alpha)required

        Origin of the country where the card used for the transaction was issued. Valid values are: 'Domestic', 'International' 'EU/EEA', 'Outside EU/EEA'.

      • Brandstring (Alpha)optional

        Brand of the card used for the transaction. Returned only if present in the Netaxept BIN file.

    Exceptions