Merchant-Initiated Transactions (MIT)

On this page:

Overview

A merchant-initiated transaction (MIT) is a payment transaction initiated by a merchant, using the customer’s stored credentials, with the customer’s prior consent. (MITs are sometimes named subsequent or recurring card payment transactions.)
Card schemes require additional parameters to process MIT payments.

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

Working with MITs is a two-step process that involves:

  1. A successful “customer-initiated” transaction which is marked:
    • "isRebilling":"0" to indicate that it is an initial MIT transaction.
  2. One or more “subsequent” or “recurring” payments which are marked:
    • "isRebilling":"1" to indicate that it is a subsequent MIT transaction.
    • "relatedTransactionId": "<transactionId from the customer-initiated transaction>"

Subsequent MIT payment requests are sent by you (with the customer’s prior consent), using the customer’s “cardholder details” (stored credentials).

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

Get started by performing these steps:

Send the initial MIT /payment request with its mandatory parameters, and include these additional parameters:

  1. "isRebilling":"0" to indicate that this is the initial MIT transaction.
  2. For a 3D-Secure payment:
    • If the /initPayment returned v2supported = true, then include:
      "relatedTransactionId": "<transactionId from the initPayment request>"
    • card.threeD.v2AdditionalParams.rebillFrequency – (Required)(format: number of days)
    • card.threeD.v2AdditionalParams.rebillExpiry – (Required)(format: YYYYMMDD)

      rebillExpiry of not more than 5 years from the initial transaction date is recommended.

    Example Initial MIT /payment Request with 3D 2.0 
    { 
   "sessionToken":"<sessionToken from getSessionToken>",
   "merchantId":"<merchantId>",
   "merchantSiteId":"<merchantSiteId>",
   "userTokenId":"230811147",
   "clientRequestId":"J7HYR4S95",
   "clientUniqueId":"695701003",
   "currency":"EUR",
   "amount":"500",
   "isRebilling":"0",
   "relatedTransactionId": "<transactionId from the initPayment request>",
   "paymentOption":{ 
      "card":{
         "cardNumber":"4000020951595032",
         "cardHolderName":"john smith",
         "expirationMonth":"12",
         "expirationYear":"25",
         "CVV":"217", 
         "threeD":{ 
            "methodCompletionInd":"Y",
            "version":"2.1.0",
            "notificationURL":"<notificationURL>",
            "merchantURL":"<merchantURL>",
            "platformType":"02",
            "v2AdditionalParams":{ 
               "rebillExpiry":"20200101",
               "rebillFrequency":"30",
               "challengeWindowSize":"05"
             }
         }
      }
   },
   "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.

There are two types of subsequent MIT payment requests, depending on who sent the original initial MIT payment request, Nuvei or an external PSP:

For Payments Originally Initiated by Nuvei

Send subsequent MIT /payment requests with their mandatory parameters, and include these additional parameters:

  1. "isRebilling": "1" to indicate that this is a subsequent MIT transaction.
  2. "relatedTransactionId": "<transactionId from the customer-initiated transaction>", sent by Nuvei.
    Example Subsequent MIT /payment Request 
    {
    "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": "<transactionId from the customer-initiated transaction>",
    "paymentOption":{
        "userPaymentOptionId": "1459503"
    },
    "billingAddress": {
        "firstName": "John",
        "lastName": "Smith",
        "address": "340689 main St.",
        "city": "London",
        "country": "GB",
        "email": "john.smith@safecharge.com"
    },
    "deviceDetails": {
        "ipAddress": "93.146.254.172"
    }
}

For Payments Originally Initiated by an External PSP

Background

When sending subsequent MIT card payment requests (or recurring card payment transactions), there are cases where the original MIT payment transaction was initiated by an External PSP (acquirer). For example, when a merchant previously used an external PSP, and has now switched to Nuvei as their PSP.

If you have access to the following data, then you can include the externalSchemeDetails block when sending subsequent MIT card payment requests (or recurring card payment transactions):

  • The transactionId (this is the external scheme reference) of the original initial MIT payment transaction (provided by the external PSP).
  • The brand of the card.
If you do not have access this data, then you cannot send the externalSchemeDetails block.
Instead, follow the steps in the For Payments Originally Initiated by Nuvei section.

Send subsequent MIT /payment requests (or recurring card payment transactions) with their mandatory parameters, and include these additional parameters:

  1. "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):
    • transactionId – This is the external scheme reference of the original the customer-initiated transaction (provided by the external PSP).
    • brand – The card brand. Possible values: VISA, MASTERCARD, or AMEX.
      • Use the full brand name, all in UPPER CASE.
      • Currently, these are the only brands. (Using other brands returns an error.)
    Example Subsequent /payment Request with 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": "<transactionId from the customer-initiated transaction>",
        "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"
    }
}