Overview
A merchant-initiated transaction (MIT) is a transaction initiated by a merchant with the customer’s prior consent. MIT payments can be recurring payment transactions. The MIT flow involves two or more transactions: an initial payment and one or more subsequent payments. Card schemes require additional parameters to process MIT payments.
This topic describes these transactions and the additional parameters to include in these requests when using Nuvei REST API 2.0:
- Initial MIT payment, initiated by the customer.
- Subsequent MIT payments, initiated with the customer’s prior consent.
Initial MIT Payment
Perform the relevant steps described in REST API 2.0 Non-3D-Secure.
When sending the initial MIT /payments
request with its mandatory parameters, include these additional parameters:
rebill.step:
“init” – Indicates this is the initial MIT.rebill.frequency
– Format: number of days.rebill.expiry
– Format: YYYYMMDD.
Example Initial MIT /payments
Non-3DS Request
{ "processingEntityId": "<your processingEntityId>", "amount": 12, "currency": "USD", "paymentOption": { "card": { "cardNumber": "5101081046006034", "cardHolderName": "John Smith", "expirationMonth": "10", "expirationYear": "2026", "cvv": "345" } }, "custom": { "description": "Some description" }, "deviceDetails": { "ipAddress": "<customer's IP address>" }, "rebill": { "expiry": "20251002", "frequency": "6", "step": "init" }, "buyerDetails": { "buyerId": "<unique customer identifier in your system>", "firstName": "John", "lastName": "Smith", "companyName": "Nuvei Corp", "dateOfBirth": "1978-01-01", "email": "[email protected]", "phone": "6175551414", "billingAddress": { "address": "22 Main Street", "zip": "02460", "city": "Boston", "countryCode": "US", "phone": "6175551414", "addressMatch": "true" }, "shippingAddress": { "sameAsBilling": "true", "address": "22 Main Street", "zip": "02460", "city": "Boston", "countryCode": "US", "phone": "6175551414" } } }
Subsequent MIT Payments
Using a customer’s stored credentials and with the customer’s prior consent, merchants can send Nuvei requests to process subsequent MIT payments if Nuvei processed the initial MIT payment, or if an external PSP processed it:
Stored Credentials
To access stored credentials, Nuvei recommends using our payment tokens solution, which seamlessly handles the card schemes’ stored credentials requirements on your behalf. Only merchants with the required level of PCI certification are allowed to store cardholder credentials, and payments using those credentials need to conform to those requirements (see Storing Credentials Yourself).
Nuvei Processed the Initial MIT Payment
Send subsequent MIT /payments
requests with their mandatory parameters, and include these additional parameters:
rebill.step
: “MIT” – Indicates that this is a subsequent MIT.relatedTransactionId
: “<transactionId
from the initial MIT>”
Example Subsequent MIT /payments
Non-3DS Request
{ "processingEntityId": "<your processingEntityId>", "amount": 12, "currency": "USD", "relatedTransactionId": "<transactionId from the initial MIT>", "paymentOption": { "store": "buyerToken", "card": { "cardNumber": "5101081046006034", "cardHolderName": "John Smith", "expirationMonth": "10", "expirationYear": "2026", "cvv": "345" } }, "custom": { "description": "Some description" }, "deviceDetails": { "ipAddress": "customer's IP address>" }, "rebill": { "step": "MIT" }, "buyerDetails": { "buyerId": "<unique customer identifier in your system>", "firstName": "John", "lastName": "Smith", "companyName": "Nuvei Corp", "dateOfBirth": "1978-01-01", "email": "[email protected]", "phone": "6175551414", "billingAddress": { "address": "22 Main Street", "zip": "02460", "city": "Boston", "countryCode": "US", "phone": "6175551414", "addressMatch": "true" }, "shippingAddress": { "sameAsBilling": "true", "address": "22 Main Street", "zip": "02460", "city": "Boston", "countryCode": "US", "phone": "6175551414" } } }
External PSP Processed the Initial MIT Payment
Send subsequent MIT /payments
requests with their mandatory parameters, and include these additional parameters:
rebill
: “MIT” or “recurring” for transaction indication.- Include the
externalSchemeDetails
block:
If you are able to provide the scheme reference (Visa, Mastercard, Amex, Diners, Discover) of the original transaction, then add anexternalSchemeDetails
block containing these two parameters (required): brand
– The card brand. Possible values: VISA, MASTERCARD, AMEX, DINERS, DISCOVER.
Example Subsequent /payments
Request with externalSchemeDetails
Block
{ "processingEntityId": "<your processingEntityId>", "amount": "12", "currency": "USD", "paymentOption": { "store": "buyerToken", "card": { "cardNumber": "5101081046006034", "cardHolderName": "John Smith", "expirationMonth": "10", "expirationYear": "2026", "cvv": "345" } }, "custom": { "description": "Some description" }, "deviceDetails": { "ipAddress": "customer's IP address>" }, "rebill": { "step": "MIT" }, "externalSchemeDetails": { "transactionId": "<transactionId from the initial MIT>", "brand": "MASTERCARD" }, "buyerDetails": { "buyerId": "<unique customer identifier in your system>", "firstName": "John", "lastName": "Smith", "companyName": "Nuvei Corp", "dateOfBirth": "1978-01-01", "email": "[email protected]", "phone": "6175551414", "billingAddress": { "address": "22 Main Street", "zip": "02460", "city": "Boston", "countryCode": "US", "phone": "6175551414", "addressMatch": "true" }, "shippingAddress": { "sameAsBilling": "true", "address": "22 Main Street", "zip": "02460", "city": "Boston", "countryCode": "US", "phone": "6175551414" } } }