openapi: 3.0.0
info:
  title: Novalnet API (2.0.0 v)
  description: >-
    ## Novalnet API (2.0.0 V) Postman Collection


    This is a postman collection covering the Novalnet API. See


    [https://developer.novalnet.de/onlinepayments/apiparameterreference](https://developer.novalnet.de/onlinepayments/apiparameterreference)


    for more details.


    ## Prerequisites


    [Postman](https://www.getpostman.com/downloads/)


    [Novalnet Account](https://admin.novalnet.de/)


    To start, fork the collection from [Novalnet's public
    workspace](https://www.postman.com/stripedev/workspace/stripe-developers/overview)
    within Postman.


    <img
    src="https://content.pstmn.io/14b7af7c-7fb4-4cfa-ab4c-f7291668b5b7/aW1hZ2UucG5n"
    alt="Fork%20Collection" width="376" height="437">


    Enter a name for your fork and select the workspace where it will be
    created:


    <img
    src="https://content.pstmn.io/ef0e5d61-f400-4b40-9c4e-e7c7ef160ddd/U2VsZWN0aW9uXzQ3NC5wbmc="
    alt="Fork%20form">


    ### Set your API Signature & Tariff ID


    To run requests, you must supply your [API Signature and Tariff
    ID](https://admin.novalnet.de/) and set it as an [environment
    variable](https://learning.postman.com/docs/sending-requests/variables/)
    within your workspace.


    To set any environment variable, You can fork the environment template from
    the Novalnet Public Workspace.


    <img
    src="https://content.pstmn.io/8af501dc-3db9-4bc9-aec6-8dbcc9622c90/cG9zdG1hbl9jcmVhdGVfbmV3X2Vudi5wbmc="
    alt="Environments" width="379" height="405">


    <img
    src="https://content.pstmn.io/8623b0f5-3284-4f91-a9d5-8d7ba2cb0296/U2VsZWN0aW9uXzQ3NS5wbmc="
    alt="Create%20a%20fork">


    Add your credentials listed below as a variable to the environment and save:


    - signature

    - payment access key

    - tariff

    - subscription tariff
        

    <img
    src="https://content.pstmn.io/66220cef-dc40-42a0-bcf6-85ae7298c070/U2VsZWN0aW9uXzQ3Ny5wbmc="
    alt="Set%20Signature,%20Payment%20access%20key%20and%20Tariff">


    Set the Novalnet Test Environment to active


    <img
    src="https://content.pstmn.io/92c3b1bd-214d-455c-9271-1aed453f568f/aW1hZ2UucG5n"
    alt="Set%20active" width="426" height="343">


    If your environment is set up correctly, you should see your base URL if you
    mouse over the `base_URL` variable in the URL field:


    <img
    src="https://content.pstmn.io/dcf94ebc-63d4-408d-966e-4dfdb1819779/aW1hZ2UucG5n"
    alt="base%20url%20mouseover" width="721" height="284">


    Ensure the configured payment access key is reflected by the mouse over in
    all the request file headers with base64 encoded format.


    <img
    src="https://content.pstmn.io/cff4dec7-4c83-47a2-8618-209a63e62976/aW1hZ2UucG5n"
    alt="Encoded%20Payment%20access%20key" width="804" height="354">


    ## Make a test transaction


    You should be ready now to make a test transaction. Choose any of the
    requests from **Payments** or **Authorize** folder to initiate a
    transaction.


    <img
    src="https://content.pstmn.io/9b419cb6-7018-4723-8d62-b4f3b1f0c7d6/aW1hZ2UucG5n"
    alt="Overall%20Collection" width="357" height="810">


    <img
    src="https://content.pstmn.io/65036184-f038-447d-b5e4-3a9f0571da5d/U2VsZWN0aW9uXzQ3OS5wbmc="
    alt="Request%20and%20Response">


    Verify the Test result of the execution


    <img
    src="https://content.pstmn.io/c37cc051-c174-4549-9416-316a86ec28cb/U2VsZWN0aW9uXzQ4MC5wbmc="
    alt="Test%20Results">


    You can change the parameters in the collection variables you need to
    change. To know about the parameter in details refer to the link -
    [https://developer.novalnet.de/onlinepayments/apiparameterreference](https://developer.novalnet.de/onlinepayments/apiparameterreference)


    <img
    src="https://content.pstmn.io/7cfb021f-9535-41c0-a86b-c7af76f96bc1/U2VsZWN0aW9uXzQ3Ni5wbmc="
    alt="Collection%20variables">


    ## Tokenization


    Select the Payment folder under One click or Zero amount and choose as Run
    folder.


    <img
    src="https://content.pstmn.io/39e4a6a5-4230-408c-9d1c-6a38f7b45258/aW1hZ2UucG5n"
    alt="Run%20folder" width="291" height="391">


    Now click the Run Novalnet API button.


    <img
    src="https://content.pstmn.io/fa32614f-880e-4de7-a969-67c16350b752/aW1hZ2UucG5n"
    alt="Run%20Novalnet%20API" width="1253" height="592">


    Verify the Test result of the execution of one click or zero amount process
    with token


    <img
    src="https://content.pstmn.io/b0e78c18-852b-40db-bd14-26e58d62aafd/aW1hZ2UucG5n"
    alt="Tokenization%20test%20results" width="830" height="450">
  version: 1.0.0
servers:
  - url: http://{{base_url}}
  - url: https://payport.novalnet.de
tags:
  - name: Payments
    description: >-
      This action immediately books the desired amount. The payment API is
      equivalent to doing an authorization and captures all at once
  - name: Authorize
    description: >-
      As the name suggests, this action only performs the basic authorization
      and will not book the amount immediately. A Payment action - Capture is
      required to book the authorized amount later.
  - name: Tokenization
    description: >-
      Tokenization is a process of replacing sensitive data with non-sensitive
      data. Our tokenization service provides a token that can be used in the
      place of card/account data, and to perform transactions using that token.
  - name: Tokenization > One Click
    description: >-
      One-Click Shopping as the name suggests is the feature that offers
      end-customers to have a faster checkout experience. To process this, we
      have been offering our server tokenization methodology.
  - name: Tokenization > One Click > Direct Debit SEPA
  - name: Tokenization > One Click > Guaranteed Direct Debit SEPA B2C
  - name: Tokenization > One Click > Guaranteed Direct Debit SEPA B2B
  - name: Tokenization > One Click > Instalment Direct Debit SEPA B2C
  - name: Tokenization > One Click > Instalment Direct Debit SEPA B2B
  - name: Tokenization > One Click > Direct Debit ACH
  - name: Tokenization > Zero Amount
    description: >-
      Tokenization service also facilitate the zero amount transaction purposes.
      The zero amount transaction is used if you wish that your customers should
      not be charged during the initial transaction, but still, their data and
      payment details are to be verified. Later, you can also book/charge the
      corresponding customer with the amount using the token generated during
      the initial zero amount transaction.
  - name: Tokenization > Zero Amount > Direct Debit SEPA
  - name: Tokenization > Zero Amount > Direct Debit ACH
  - name: Payment Action
    description: |-
      Payment Action contains

      - [Capture](https://developer.novalnet.de/apireference/transactioncapture)
      - [Refund](https://developer.novalnet.de/apireference/transactionrefund)
      - [Update](https://developer.novalnet.de/apireference/transactionupdate)
      - [Cancel](https://developer.novalnet.de/apireference/transactioncancel)
  - name: Instalment Action
    description: >-
      This action will
      [cancel](https://developer.novalnet.de/apireference/instalmentcancel) the
      existing instalments or remaining cycles.
  - name: Subscription
    description: >-
      Here you can pass the amount, currency, subscription cycle and period
      during the payment transaction This can be up to two different
      subscription cycle and period with various amounts, for eg: if you have a
      business where the end customer pays first month amount 20.00 € and then
      each quartal 50.00 € endlessly as long as the end customer (or merchant)
      does not cancel this subscription.
  - name: Subscription Action
    description: >-
      **Subscription Action contains**


      -
      [Suspend](https://developer.novalnet.de/apireference/subscriptionsuspend)

      -
      [Reactivate](https://developer.novalnet.de/apireference/subscriptionreactivate)

      - [Amount/Date
      update](https://developer.novalnet.de/apireference/subscriptionamountupdate)

      - [Payment
      change](https://developer.novalnet.de/apireference/subscriptionpaymentupdate)

      - [Cancel](https://developer.novalnet.de/apireference/subscriptioncancel)
  - name: Marketplace
    description: >-
      The entire process - from revenue sharing to settling your affiliates - is
      managed by us automatically. Our affiliate program platform, in direct
      combination with our reliable and secure payment processing, provides you
      with an additional interface for managing your affiliates.
  - name: Affiliate
    description: >-
      The entire process - from revenue sharing to settling your affiliates - is
      managed by us automatically. Our affiliate program platform, in direct
      combination with our reliable and secure payment processing, provides you
      with an additional interface for managing your affiliates.
  - name: Marketplace Action
    description: This action is used to create/add the new affiliate.
  - name: Customer Invoice
    description: This action is used to create the Customer Invoice pdf generation.
  - name: Customer Update
    description: >-
      This action will update a customer's details for all their existing
      transactions.
  - name: Verify Payment data
    description: >-
      Novalnet offers this effective payment data check feature which would
      allow you to manage the payment data involving Credit Card or Direct Debit
      SEPA in your web-shop.  
        
      Suppose if the payment data has been entered into your shop and you want
      to verify & manage if the payment data was used already with a different
      user in Novalnet system, then you can explore this feature.
  - name: Webhook
    description: This action is used to configure webhook URL for notification handling.
  - name: Retrieve
    description: >-
      This API will list the available payment methods along with the merchant
      credentials like Vendor ID, Project ID, available tariff, etc.,
  - name: External Fraud Check
    description: >-
      Module API is relevant when you want to use the risk modules without
      entering into the transaction flow. Typical use case includes:


      - Acquiring a customer's credit score.

      - Identifying an IP location of an IP.

      - Verifying if the VAT ID is valid.
          

      And as this API does not involve a transaction flow, no transaction will
      be created, and your account will be charged based on the per-service
      usage.
paths:
  /payment:
    post:
      tags:
        - Verify Payment data
      summary: Instalment Direct Debit SEPA B2B
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n\t\"merchant\": {\n\t\t\"signature\":
                \"{{signature}}\",\n\t\t\"tariff\":
                \"{{tariff}}\"\n\t},\n\t\"customer\": {\n        \"gender\":
                \"m\",\n        \"first_name\": \"{{b2b_firstname}}\",\n       
                \"last_name\": \"{{b2b_lastname}}\",\n        \"email\":
                \"{{email}}\",\n        \"billing\": {\n            \"company\":
                \"{{billing_company}}\",\n            \"house_no\":
                \"{{b2b_house_no}}\",\n            \"street\":
                \"{{b2b_street}}\",\n            \"city\":
                \"{{b2b_city}}\",\n            \"zip\":
                \"{{b2b_zip}}\",\n            \"country_code\":
                \"{{billing_country_code}}\"\n        },\n\t\t\"customer_ip\":
                \"{{customer_ip}}\",\n\t\t\"customer_no\":
                \"{{customer_no}}\",\t\t\n        \"tel\": \"{{tel}}\",\n       
                \"mobile\": \"{{mobile}}\",\n        \"fax\":
                \"{{fax}}\",\n        \"shipping\": {\n           
                \"same_as_billing\": \"1\"           \n\t\t},\n       
                \"vat_id\":\"{{vat_id}}\",\n        \"tax_id\":\"{{tax_id}}\",  
                \n        \"reg_no\":\"{{reg_no}}\",   \n       
                \"session\":\"{{session}}\"\n\t},\n\t\"transaction\": {\n       
                \"test_mode\": \"{{test_mode}}\",\n\t\t\"payment_type\":
                \"INSTALMENT_DIRECT_DEBIT_SEPA\",\n\t    \"amount\":
                \"5000\",\t\n    \t\"currency\": \"{{currency}}\",\n       
                \"order_no\": \"{{order_no}}\",\n        \"hook_url\":
                \"{{hook_url}}\",\n\t\t\"invoice_ref\":
                \"{{invoice_ref}}\",\n       
                \"mandate_ref\":\"{{mandate_ref}}\",\n       
                \"mandate_date\":\"{{mandate_date}}\",\n       
                \"verify_payment_data\":\"1\",\n       
                \"invoice_no\":\"{{invoice_no}}\",\n        \"payment_data\":
                {\n            \"account_holder\":
                \"{{account_holder}}\",\n            \"iban\":
                \"{{nn_iban}}\",\n            \"bic\":\"{{nn_bic}}\"\n       
                },\n        \"debit_reason_1\":\"{{debit_reason_1}}\"\n\t},\n   
                \"instalment\":{\n       
                \"interval\":\"{{interval}}\",\n        \"cycles\":\"3\"\n   
                },    \n\t\"custom\": {\n\t\t\"lang\": \"EN\",\n       
                \"input1\":\"{{input1}}\",\n       
                \"inputval1\":\"{{inputval1}}\"\n\t}\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /authorize:
    post:
      tags:
        - Authorize
      summary: SEPA Credit
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n\t\"merchant\": {\n\t\t\"signature\":
                \"{{signature}}\",\n\t\t\"tariff\":
                \"{{tariff}}\"\n\t},\n\t\"customer\": {\n\t\t\"gender\": \"m\",
                \n\t\t\"first_name\": \"{{first_name}}\",\n\t\t\"last_name\":
                \"{{last_name}}\",\n\t\t\"email\": \"{{test_email}}\",\n       
                \"billing\": {\n\t\t\t\"company\":
                \"{{billing_company}}\",\n\t\t\t\"house_no\":
                \"{{billing_house_no}}\",\n\t\t\t\"street\":
                \"{{billing_street}}\",\n\t\t\t\"city\":
                \"{{billing_city}}\",\n\t\t\t\"zip\":
                \"{{billing_zip}}\",\n            \"country_code\":
                \"{{billing_country_code}}\",\n            \"state\":
                \"{{billing_state}}\"\n\t\t},\n\t\t\"customer_ip\":
                \"{{customer_ip}}\",\n\t\t\"customer_no\":
                \"{{customer_no}}\",\n\t\t\"birth_date\":
                \"{{birth_date}}\",\n        \"tel\": \"{{tel}}\",\n       
                \"mobile\": \"{{mobile}}\",\n        \"fax\":
                \"{{fax}}\",\n        \"shipping\": {\n\t\t\t\"first_name\":
                \"{{shipping_first_name}}\",\n\t\t\t\"last_name\":
                \"{{shipping_last_name}}\",\n\t\t\t\"email\":
                \"{{shipping_email}}\",\n\t\t\t\"company\":
                \"{{shipping_company}}\",\n            \"house_no\":
                \"{{shipping_house_no}}\",\n            \"street\":
                \"{{shipping_street}}\",\n            \"city\":
                \"{{shipping_city}}\",\n            \"zip\":
                \"{{shipping_zip}}\",\n            \"country_code\":
                \"{{shipping_country_code}}\",\n            \"tel\":
                \"{{shipping_tel}}\",\n            \"mobile\":
                \"{{shipping_mobile}}\",\n            \"state\":
                \"{{shipping_state}}\"\n\t\t},\n       
                \"vat_id\":\"{{vat_id}}\",\n        \"tax_id\":\"{{tax_id}}\",  
                \n        \"reg_no\":\"{{reg_no}}\",   \n       
                \"session\":\"{{session}}\"\n\t},\n\t\"transaction\": {\n       
                \"test_mode\": \"{{test_mode}}\",\n\t\t\"payment_type\":
                \"SEPA_CREDIT\",\n\t\t\"amount\": \"100\",\n\t\t\"currency\":
                \"{{currency}}\",\n        \"order_no\":
                \"{{order_no}}\",\n        \"hook_url\":
                \"{{hook_url}}\",\n       
                \"order_date\":\"2021-06-10\",\n       
                \"order_amount\":\"2000\",\n       
                \"order_reference\":\"XXXYYYZZZ\",\n       
                \"credit_reason_1\":\"Test Product\",\n\t\t\"invoice_ref\":
                \"{{invoice_ref}}\",\n       
                \"invoice_no\":\"{{invoice_no}}\",\n        \"payment_data\":
                {\n            \"account_holder\":
                \"{{account_holder}}\",\n            \"iban\":
                \"{{nn_iban}}\"\n        }\n\t},\n\t\"custom\": {\n\t\t\"lang\":
                \"EN\",\n        \"input1\":\"{{input1}}\",\n       
                \"inputval1\":\"{{inputval1}}\"\n\t}\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /transaction/capture:
    post:
      tags:
        - Payment Action
      summary: Capture
      description: This action collects the funds due from the completed authorizations
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n  \"transaction\":{\n    \"tid\":\"###NOVALNET_TID###\"\n  
                // \"amount\":\"###CAPTURE_AMOUNT###\",\n   
                //\"capture\":{\n    //    \"type\":\"PARTIAL\", //FINAL\n   
                //    \"reference\":\"Reference\"\n    //}\n  },\n 
                \"custom\":{\n    \"lang\":\"EN\"\n  }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /transaction/cancel:
    post:
      tags:
        - Payment Action
      summary: Cancel
      description: >-
        This action is used to avoid collecting the funds from previously
        completed authorizations
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n  \"transaction\":{\n    \"tid\":\"###TID##\"\n  },\n 
                \"custom\":{\n    \"lang\":\"EN\"\n  }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /transaction/refund:
    post:
      tags:
        - Payment Action
      summary: Refund
      description: >-
        This action returns funds that were already collected by a Payment or a
        Capture transaction
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n   \"transaction\":{\n      \"tid\":\"###TID###\",\n     
                \"amount\":\"###REFUND_AMOUNT###\",\n      \"reason\":\"Product
                not satisfied\"\n   },\n   \"custom\":{\n     
                \"lang\":\"EN\"\n   }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /transaction/update:
    post:
      tags:
        - Payment Action
      summary: Amount & Due Date Update
      description: >-
        This action will update the existing transaction\`s attributes like
        amount, Due date, and Order number.
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n  \"transaction\":{\n    \"tid\":\"###TID###\",\n   
                \"due_date\":\"###DUE_DATE###\",//YYYY-MM-DD\n    \"amount\":
                \"###AMOUNT###\"\n\n  },\n  \"custom\":{\n    \"lang\":\"EN\"\n 
                }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /instalment/cancel:
    post:
      tags:
        - Instalment Action
      summary: Cancel
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n   \"instalment\":{\n     
                \"tid\":\"###NOVALNET_TID###\",\n     
                \"cancel_type\":\"CANCEL_REMAINING_CYCLES\"
                //CANCEL_ALL_CYCLES\n   }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /subscription/suspend:
    post:
      tags:
        - Subscription Action
      summary: Suspend
      description: This action will pause the existing subscription.
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n   \"subscription\":{\n     
                \"tid\":\"###NOVALNET_TID###\"\n   },\n   \"custom\":{\n     
                \"lang\":\"EN\"\n   }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /subscription/reactivate:
    post:
      tags:
        - Subscription Action
      summary: Reactivate
      description: >-
        This action will reactivate the existing subscription which has been
        suspended before.
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n   \"subscription\":{\n     
                \"tid\":\"###NOVALNET_TID###\"\n   },\n   \"custom\":{\n     
                \"lang\":\"EN\"\n   }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /subscription/update:
    post:
      tags:
        - Subscription Action
      summary: Amount/Date Update
      description: >-
        This action will update the existing subscription\`s attributes like
        amount or next recurring date.
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n   \"subscription\":{\n     
                \"tid\":\"###NOVALNET_TID###\",\n     
                \"amount\":\"###UPDATE_AMOUNT###\",\n     
                \"next_cycle_date\":\"###NEXT_CYCLE_DATE###\"\n   },\n  
                \"custom\":{\n      \"lang\":\"EN\"\n   }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /v2/subscription/update:
    post:
      tags:
        - Subscription Action
      summary: Payment Update
      description: >-
        This action will be useful if you want to update the existing
        subscription\`s payment data or the payment type for the subsequent
        renewals.
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n\t\"subscription\": {\n\t\t\"tid\":
                \"###TID###\"\n\t},\n\t\"customer\": {\n\t\t\"first_name\":
                \"Max\",\n\t\t\"last_name\": \"Mustermann\",\n\t\t\"email\":
                \"test@novalnet.de\",\n\t\t\"tel\": \"+49 089
                123456\",\n\t\t\"mobile\": \"+49 174 7781423\",\n\t\t\"gender\":
                \"u\",\n\t\t\"fax\": \"+49 89 654321\",\n\t\t\"billing\":
                {\n\t\t\t\"street\": \"Musterstr\",\n\t\t\t\"house_no\":
                \"2\",\n\t\t\t\"city\": \"Musterhausen\",\n\t\t\t\"zip\":
                \"12345\",\n\t\t\t\"country_code\": \"DE\",\n\t\t\t\"company\":
                \"ABC GmbH\"\n\t\t},\n\t\t\"shipping\": {\n\t\t\t\"first_name\":
                \"Norbert\",\n\t\t\t\"last_name\": \"Maier\",\n\t\t\t\"email\":
                \"test@novalnet.de\",\n\t\t\t\"street\":
                \"Hauptstr\",\n\t\t\t\"house_no\": \"9\",\n\t\t\t\"city\":
                \"Kaiserslautern\",\n\t\t\t\"zip\":
                \"66862\",\n\t\t\t\"country_code\": \"DE\",\n\t\t\t\"tel\":
                \"+49 089 123456\",\n\t\t\t\"company\": \"A.B.C. Ger\\u00fcstbau
                GmbH\",\n\t\t\t\"mobile\": \"+49 174
                7781423\"\n\t\t}\n\t},\n\t\"transaction\":
                {\n\t\t\"payment_type\":
                \"###PAYMENT_TYPE###\",\n\t\t\"payment_data\":
                {\n\t\t\t\"account_holder\": \"Max
                Mustermann\",\n\t\t\t\"iban\":
                \"DE24300209002411761956\"\n\t\t}\n\t},\n\t\"custom\":
                {\n\t\t\"lang\": \"EN\"\n\t}\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /subscription/cancel:
    post:
      tags:
        - Subscription Action
      summary: Cancel
      description: This action will cancel the existing subscription.
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n   \"subscription\":{\n      \"tid\":\"###TID###\",\n     
                \"reason\":\"####CANCEL_REASON####\"\n   },\n  
                \"custom\":{\n      \"lang\":\"EN\"\n   }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /affiliate/create:
    post:
      tags:
        - Marketplace Action
      summary: Affiliate Creation
      description: This action is used to create/add the new affiliate.
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n    \"merchant\": {\n        \"signature\":
                \"###YOUR_API_SIGNATURE###\"\n    },\n    \"affiliate\":
                {\n        \"login\": \"###AFFILIATE_LOGIN###\",\n       
                \"password\": \"###AFFILIATE_PASSWORD###\",\n       
                \"reference\": \"affiliateXXX\",\n        \"gender\":
                \"u\",\n        \"first_name\": \"Max\",\n        \"last_name\":
                \"Mustermann\",\n        \"email\":
                \"test@novalnet.de\",\n        \"company_email\":
                \"info@novalnet.de\",\n        \"address\": {\n           
                \"company\": \"ABC GmbH\",\n            \"house_no\":
                \"2\",\n            \"street\": \"Musterstr\",\n           
                \"city\": \"Musterhausen\",\n            \"zip\":
                \"12345\",\n            \"country_code\": \"DE\"\n       
                },\n        \"tel\": \"+49 089 123456\",\n        \"mobile\":
                \"+49 174 7781423\",\n        \"fax\": \"+49 89
                654321\",\n        \"vat_id\": \"DE123456\",\n       
                \"account_holder\": \"###ACCOUNT_HOLDER###\",\n        \"iban\":
                \"###IBAN###\"\n    },\n    \"custom\": {\n        \"lang\":
                \"EN\"\n    }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /customer/update:
    post:
      tags:
        - Customer Update
      summary: Update
      description: >-
        This action will update a customer's details for all their existing
        transactions.
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n  \"transaction\":{\n    \"tid\":\"###NOVALNET_TID####\"\n 
                },\n  \"customer\":{\n    \"first_name\":\"Max\",\n   
                \"last_name\":\"Mustermann\",\n    \"gender\":\"m\",\n   
                \"email\":\"test@novalnet.de\",\n   
                \"customer_no\":\"1234\",\n    \"billing\" :
                {\n\t\t\"street\":\"Musterstr\",\n\t\t\"house_no\":\"2\",\n\t\t\"city\":\"Musterhausen\",\n\t\t\"zip\":\"12345\",\n\t\t\"country_code\":\"DE\",\n\t\t\"company\":\"ABC
                GmbH\"\n    },\n    \"mobile\":\"+49 174 7781423\",\n   
                \"tel\":\"+49 089 123456\",\n    \"fax\":\"+49 89 654321\"\n 
                },\n  \"custom\":{\n    \"lang\":\"EN\"\n   }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /webhook/configure:
    post:
      tags:
        - Webhook
      summary: Configure
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n  \"merchant\":{\n   
                \"signature\":\"###YOUR_API_SIGNATURE###\"\n  },\n 
                \"webhook\":{\n    \"url\":\"###YOUR_HOOK_URL###\"\n  },\n 
                \"custom\":{\n    \"lang\":\"EN\"\n  }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /merchant/details:
    post:
      tags:
        - Retrieve
      summary: Merchant Information
      description: >-
        This API will list the available payment methods along with the merchant
        credentials like Vendor ID, Project ID, available tariff, etc.,
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n  \"merchant\": {\n    \"signature\": \"###SIGNATURE###\"\n 
                },\n  \"custom\": {\n    \"lang\": \"EN\"\n  }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /transaction/details:
    post:
      tags:
        - Retrieve
      summary: Transaction
      description: >-
        This action allows you to retrieve the result of a transaction sent
        previously using Novalnet\`s TID
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: '"{\n   \"transaction\":{\n      \"tid\":\"###TID###\"\n   }\n}"'
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /transaction/list:
    post:
      tags:
        - Retrieve
      summary: Transaction List
      description: >-
        This action allows you to retrieve the result of a transaction sent
        previously using Novalnet\`s TID
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n  \"merchant\": {\n    \"signature\": \"{{signature}}\"\n 
                },\n  \"transaction\":{\n   
                \"order_no\":\"###ORDER_NUMBER###\"\n  },\n  \"custom\": {\n   
                \"lang\": \"EN\"\n  }\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /module:
    post:
      tags:
        - External Fraud Check
      summary: Blacklist Check
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "{\n  \"merchant\": {\n    \"signature\": \"{{signature}}\"\n 
                },\n  \"customer\": {\n    \"email\": \"{{email}}\"\n    },\n 
                \"module\": {\n    \"type\": \"BLACKLIST_CHECK\",\n   
                \"payment_data\":{\n        \"iban\":\"####IBAN####\"\n    }\n 
                },\n    \"custom\": {\n    \"lang\": \"EN\"\n  }\n\n}"
      parameters:
        - name: X-NN-Access-Key
          in: header
          schema:
            type: string
          example: '{{encoded_Payment_Access_Key}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: Charset
          in: header
          schema:
            type: string
          example: utf-8
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
