Merchant-Initiated Transactions (MIT)

On this page:

Overview

A merchant-initiated transaction (MIT) is a payment transaction 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.

This topic describes the parameters to include in the initial and the subsequent MIT card payment requests.

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

MITs use “cardholder details” (stored credentials), which are stored on behalf of the customer.

  • It is recommended to access stored credentials via our Card-on-File/UPO solution (see User Payment Management (Tokenization), which seamlessly handles card schemes’ “Stored Credentials” requirements on your behalf.
  • Only merchants who have the relevant level of PCI compliance are allowed to store cardholder credentials, and payment transactions need to conform to the card schemes’ “Stored Credentials” requirements (see Handling Stored Credentials Yourself).

Some APM providers offer recurring APM payment services (for example: PayPal, Skrill, and Post finance). After the initial APM payment request, subsequent (recurring) payment requests are sent directly via server-to-server and do not redirect the customer. See the APM subMethod Class topic for details.

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)

      We recommend setting rebillExpiry to a value of no more than 5 years from the date of the initial transaction processing date.

    • card.threeD.v2AdditionalParams.rebillFrequency – (Required)(format: in number of days)
    Example of an Initial MIT Payment Request with 3D 2.0 using the /payment Method 
    { 
   "sessionToken":"<sessionToken from getSessionToken>",
   "merchantId":"<merchantId>",
   "merchantSiteId":"<merchantSiteId>",
   "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. These requests are identified by setting "isRebilling":"1" and are structured differently depending if the original initial MIT was initiated by Nuvei or by another PSP as described below.

Submitting subsequent MIT payments:

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 /payment Request

    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": "<sessionToken from getSessionToken>",
    "merchantId": "<merchantId>",
    "merchantSiteId": "<merchantSiteId>",
    "userTokenId":"230811147",
    "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"
    }
}

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 the externalSchemeDetails block:
    If you are able to provide the scheme reference (Visa/Mastercard/Amex) of the original transaction, then add an  externalSchemeDetails block containing these two parameters (required) into the subsequent payment requests:
    • transactionId – Generated in external system for the initial payment.
    • brand – The card brand, (use the full brand name): Visa, Mastercard, or Amex.

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

    Example /payment Request

    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": "<sessionToken from getSessionToken>",
    "merchantId": "<merchantId>",
    "merchantSiteId": "<merchantSiteId>",
    "userTokenId":"230811147",
    "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"
    }
}