Overview

A merchant-initiated transaction (MIT) is a payment transaction initiated by a merchant, with the customer’s prior consent. MIT payments are sometimes named subsequent or recurring card payment transactions.

Card schemes require additional parameters to process MIT payments.

The MIT flow involves two or more transactions: an initial payment and one or more subsequent payments.

This topic describes these transactions and the additional parameters to include in these requests:

• The initial MIT card payment request, initiated by a customer.
• Subsequent MIT card payment request/s, initiated by the merchant with the customer’s prior consent, using the customer’s stored credentials.

Stored Credentials

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

Submit the Initial MIT Payment

Click tab to open…

{
  "merchantId": "<your merchantId goes here>",
  "merchantSiteId": "<your merchantSiteId goes here>",
  "clientUniqueId": "<unique transaction ID in merchant system>",
  "clientRequestId": "<unique request ID in merchant system>",
  "userTokenId": "<unique customer identifier in merchant system>",
  "currency": "USD",
  "amount": "200",
  "isRebilling": "0",
  "paymentOption": {
    "card": {
      "threeD": {
        "v2AdditionalParams": {
          "rebillExpiry": "<Recurring expiry date YYYYMMDD>",
          "rebillFrequency": "<Recurring frequency in days>"
        }
      }
    }
  },
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>"
}

Submit Subsequent MIT Payments

After the initial MIT payment was successfully processed by Nuvei, or by an external PSP, you can begin sending subsequent MIT payment requests.

Subsequent MIT payment requests are handled differently depending on who sent the original initial MIT payment request:

• For Payments Originally Initiated by Nuvei
• For Payments Originally Initiated by an External PSP

For Payments Originally Initiated by Nuvei

1. Generate a sessionToken as described in Authentication.
2. Send subsequent MIT /payment requests with their mandatory parameters, and include these additional parameters:
   • "isRebilling": "1" to indicate that this is a subsequent MIT transaction.
   • "relatedTransactionId": "<transactionId from the original initial customer-initiated transaction>", sent by Nuvei.
     

     Example Subsequent MIT /payment Request

     {
         "sessionToken": "<sessionToken from getSessionToken>",
         "merchantId": "<merchantId>",
         "merchantSiteId": "<merchantSiteId>",
         "userTokenId":"<unique customer identifier in merchant system>",
         "clientRequestId": "<unique request ID in merchant system>",
         "timeStamp": "<YYYYMMDDHHmmss>",
         "checksum": "<calculated checksum>",
         "currency": "USD",
         "amount": "200",
         "transactionType": "Sale",
         "isRebilling": "1",
         "relatedTransactionId": "<transactionId from the original initial customer-initiated transaction>",
         "paymentOption":{
             "userPaymentOptionId": "<The ID of a previously stored payment option>"
         },
         "billingAddress": {
             "country": "US",
             "email": "john.smith@email.com"
         },
         "deviceDetails": {
             "ipAddress": "127.0.0.1"
         }
     }

For Payments Originally Initiated by an External PSP

Sending subsequent MIT /payment requests:

1. Generate a sessionToken as described in Authentication.
2. Send subsequent MIT /payment requests (or recurring card payment transactions) with their mandatory parameters, and include these additional parameters:
   • "isRebilling": "1" to indicate that this is a subsequent MIT transaction.
   • 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 customer-initiated transaction (provided by the external PSP).
       
       For Mastercard the format should be:
       <3 letters><6 alphanumeric characters><date (4 digits MMDD)>

       For Visa and Amex, the structure for this parameter must be a string of up to 15 numbers.

     • brand – The card brand. Possible values: VISA, MASTERCARD, 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":"<unique customer identifier in merchant system>",
         "clientRequestId": "<unique request ID in merchant system>",
         "timeStamp": "<YYYYMMDDHHmmss>",
         "checksum": "<calculated checksum>",
         "currency": "USD",
         "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": {
             "country": "US",
             "email": "john.smith@email.com"
         },
         "deviceDetails": {
             "ipAddress": "127.0.0.1"
         }
     }