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 card payment request by a customer, also referred to as a customer-initiated transaction (CIT).
• The subsequent merchant-initiated card payment request(s), which have a customer’s consent and use the customer’s stored credentials, also referred to as a merchant-initiated transaction (MIT).

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 CIT Payment

{
  "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 CIT 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 CIT 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 REST 1.0.
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.
   • rebillingType, with possible values:
     • "MIT" – Merchant-initiated transaction without specific periodicity.
     • "Recurring" – Merchant-initiated transaction, according to rebillFrequency and rebillExpiry.
     • "NoShow" – This feature can only be enabled for specific industries. Contact your account manager to confirm usage.
     • "DelayedCharges" – This feature can only be enabled for specific industries. Contact your account manager to confirm usage.
   • relatedTransactionId: “<transactionId from the original initial CIT> (sent by Nuvei).
     
     If utilizing a auth/settle transaction flow, then relatedTransactionId should reference transactionId from the original authorization flow (not from the settle flow).

     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",
         "rebillingType": "MIT",
         "relatedTransactionId": "<transactionId from the original initial CIT>",
         "paymentOption":{
             "userPaymentOptionId": "<ID of a previously stored payment option>"
         },
         "billingAddress": {
             "country": "US",
             "email": "[email protected]"
         },
         "deviceDetails": {
             "ipAddress": "<customer's IP address>"
         }
     }

For Payments Originally Initiated by an External PSP

Sending subsequent MIT /payment requests:

1. Generate a sessionToken as described in REST 1.0.
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.
   • rebillingType, with possible values:
     • "MIT" – Merchant-initiated transaction without specific periodicity.
     • "Recurring" – Merchant-initiated transaction, according to rebillFrequency and rebillExpiry.
     • "NoShow" – This feature can only be enabled for specific industries. Contact your account manager to confirm usage.
     • "DelayedCharges" – This feature can only be enabled for specific industries. Contact your account manager to confirm usage.
   • Include the externalSchemeDetails class:
     If you are able to provide the scheme reference (Visa, Mastercard, Amex, Diners, Discover) of the original transaction, then add an externalSchemeDetails class containing these two parameters (required):
     • transactionId – This is the external scheme reference of the original CIT (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, DINERS, DISCOVER.
       • 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 Class

     {
         "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",
         "rebillingType": "MIT",
         "externalSchemeDetails": {
             "transactionId": "<transactionId from the CIT>",
             "brand": "VISA"
         },
         "paymentOption": {
             "card": {
                 "cardNumber": "4000020951595032",
                 "cardHolderName": "john smith",
                 "expirationMonth": "12",
                 "expirationYear": "25"
             }
         },
         "billingAddress": {
             "country": "US",
             "email": "[email protected]"
         },
         "deviceDetails": {
             "ipAddress": "<customer's IP address>"
         }
     }