Developers

Merchant-Initiated Transactions (MIT)

Overview

A merchant-initiated transaction (MIT) is initiated by a merchant with the customer’s prior consent. Subsequent MITs or recurring card payment transactions are performed on behalf of the customer using their stored credentials.

Card schemes require some additional fields to process MIT payments, which should be included when calling:

This section describes the additional fields that should be included in the initial and the subsequent MIT payment requests:

  • MITs use cardholder credentials which are stored on behalf of the customer. Only merchants who have the relevant level of PCI compliance are allowed to store cardholder credentials. Nuvei’s tokenization and payment option management solution can manage cardholder credentials on your behalf. See the Card-on-File topic for details.

    Some APMs support MITs (for example: PayPal, Skrill, Trustly, and Post finance). APM MIT payment requests are sent directly via server-to-server calls and do not redirect the user. See the APM subMethod Classes topic for details.

    The Nuvei Checkout Page manages MITs seamlessly.

Submit the Initial MIT Payment

Include the following in the initial MIT payment request:

  1. Set "isRebilling":"0", to indicate that this is the initial MIT transaction.
  2. For a 3D-Secure payment, add and set these two additional fields:
    • card.threeD.v2AdditionalParams.rebillExpiry – (Required)(format: YYYYMMDD)
    • card.threeD.v2AdditionalParams.rebillFrequency – (Required)(format: in number of days)
    Example:

    This is an example of an initial MIT payment request with 3D 2.0 using the /openOrder method:

    { 
   "sessionToken":"2636e845-7a0d-46ee-b07e-afcfcebc124e",
   "merchantId":"2502136204546424962",
   "merchantSiteId":"126006",
   "userTokenId":"230811147",
   "clientRequestId":"J7HYR4S95",
   "clientUniqueId":"695701003",
   "currency":"USD",
   "amount":"500",
   "isRebilling":"0",
   "paymentOption":{ 
      "card":{ 
         "threeD":{ 
            "v2AdditionalParams":{ 
               "rebillExpiry":"20200101",
               "rebillFrequency":"30"
            }
         }
      }
   },
   "billingAddress":{ 
      "firstName":"John",
      "lastName":"Smith",
      "address":"340689 main St.",
      "city":"London",
      "country":"UK",
      "email":"john.smith@safecharge.com"
   },
   "deviceDetails":{ 
      "ipAddress":"93.146.254.172"
   },
   "timeStamp":"20191105091105",
   "checksum":"328bd06ea3f696229d1387c9313dfd1e"
}

Submit Subsequent MIT Payments

After the initial MIT payment is processed you can begin sending subsequent MIT payment requests, which are identified by setting "isRebilling":"1". If the original initial MIT was initiated by Nuvei, then include the relatedTransactionId field. If the original initial MIT was initiated by another PSP, then include either the relatedTransactionId field or the externalSchemeDetails block, but not both, as described below.

Submit subsequent MIT payments:

Subsequent MIT Payments for transactions originally initiated by Nuvei

Include the following in subsequent MIT payment requests:

  1. Set "isRebilling":"1", to indicate that this is a subsequent MIT transaction.
  2. Add the relatedTransactionId field to the subsequent payment requests, and set the value to the transactionId of the original initial MIT transaction.
    Example:

    This is an example of a recurring (“subsequent” MIT) payment request using the /payment method, which includes the relatedTransactionId field (which is the transactionId of the initial MIT transaction), which was originally initiated by Nuvei:

    {
    "sessionToken": "4130c37c-d79c-4a34-8f7c-154afa7099fb",
    "merchantId": "479748173730597238",
    "merchantSiteId": "204388",
    "clientRequestId": "20201213144725",
    "timeStamp": "20201213144725",
    "checksum": "00ab48043a85c53a1ffa230eb485df16f3d510439a9c24047867c5c1b5565e5f",
    "currency": "EUR",
    "amount": "200",
    "transactionType": "Sale",
    "isRebilling": "1",
    "relatedTransactionId": "1110000000010251739",
    "paymentOption": {
        "card": {
            "cardNumber": "4000020951595032",
            "cardHolderName": "john smith",
            "expirationMonth": "12",
            "expirationYear": "25",
            "CVV": "217"
        }
    },
    "billingAddress": {
        "firstName": "John",
        "lastName": "Smith",
        "address": "340689 main St.",
        "city": "London",
        "country": "GB",
        "email": "john.smith@safecharge.com"
    },
    "deviceDetails": {
        "ipAddress": "93.146.254.172"
    }
}

Subsequent MIT Payments for transactions originally initiated by another PSP

Submit subsequent MIT card payment requests or recurring card payment transactions, where the original MIT transaction was initiated by another PSP (acquirer). For example, when a merchant switches to Nuvei as their PSP.
Include the following in subsequent MIT payment requests:

  1. Set "isRebilling":"1" to indicate that this is a subsequent MIT transaction.
  2. Include either the relatedTransactionId field or the externalSchemeDetails block, (but not both):

    Sending both relatedTransactionId and externalSchemeDetails in the same request will return an error.

    • Including a relatedTransactionId field:

      If you are not able to provide the scheme reference (Visa/Master card/Amex) of the original transaction, then you can just add the relatedTransactionId field to the subsequent payment requests, and set the value to the transactionId of the original initial MIT transaction. (See the example above.)

    • Including the externalSchemeDetails block:

      If you are able to provide the scheme reference (Visa/Master card/Amex) of the original transaction, then add an  externalSchemeDetails block containing these two parameters (required), into the subsequent payment requests:

      • transactionId – This the original transactionId for the initial payment as originated in external system.
      • brand – This is the card brand (values: V, M, A):
        • V – Visa
        • M – Master card
        • A – Amex

        • At this point, any other value will return an error… (More values in the future.)

        Example:

        This is an example of a recurring (“subsequent” MIT) card payment MIT or recurring card payment transaction using the /payment method, where the original MIT transaction was initiated by another PSP (acquirer), showing an externalSchemeDetails block:

        {
    "sessionToken": "4130c37c-d79c-4a34-8f7c-154afa7099fb",
    "merchantId": "479748173730597238",
    "merchantSiteId": "204388",
    "clientRequestId": "20201213144725",
    "timeStamp": "20201213144725",
    "checksum": "00ab48043a85c53a1ffa230eb485df16f3d510439a9c24047867c5c1b5565e5f",
    "currency": "EUR",
    "amount": "200",
    "transactionType": "Sale",
    "isRebilling": "1",
    "externalSchemeDetails": {
        "transactionId": "1234567687980",
        "brand": "VISA"
    },
    "paymentOption": {
        "card": {
            "cardNumber": "4000020951595032",
            "cardHolderName": "john smith",
            "expirationMonth": "12",
            "expirationYear": "25",
            "CVV": "217"
        }
    },
    "billingAddress": {
        "firstName": "John",
        "lastName": "Smith",
        "address": "340689 main St.",
        "city": "London",
        "country": "GB",
        "email": "john.smith@safecharge.com"
    },
    "deviceDetails": {
        "ipAddress": "93.146.254.172"
    }
}