Merchant Initiated Transactions (MIT)

Cardholder Initiated Transaction

Please use the following mandatory parameters to submit initial recurring payment:

storedCredentials Description
sequencerepresents the sequence, available values for recurring payments are:
'FIRST' - initial payment
scheduledindicator, if the payment is part of scheduled or unscheduled transaction, for MIT payments must be always set to 'false'
initiatorrepresents transaction initiator, available values;
'CARDHOLDER' - to be used for the FIRST transaction

The following is an example of a first Credentials-on-File (COF) transaction indicating 3DS requestor’s preference to challenge a cardholder:

{
    "requestType": "PaymentCardSaleTransaction",
    "transactionAmount": {
        "total": "12.00",
        "currency": "EUR"
    },
    "paymentMethod": {
        "paymentCard": {
            "number": "414746******0083",
            "securityCode": "XXX",
            "expiryDate": {
                "month": "12",
                "year": "28"
            }
        }
    },
    "storedCredentials": {
        "sequence": "FIRST",
        "scheduled": false,
        "initiator": "CARDHOLDER"
    },   
    "authenticationRequest": {
        "authenticationType": "Secure3DAuthenticationRequest",
        "termURL": "https://test.ipg-online.com/webshop/simulator/secure3d/return",
        "methodNotificationURL": "https://test.ipg-online.com/ipgconfirmation/services/secure3ds",
        "challengeIndicator": "04"
    }
}

After this request the transaction processing continues with EMV 3-D Secure flow and authorization is triggered automatically once the authentication has been successfully completed.

The API response you received after your customer got authenticated successfully contains also the element schemeTransactionId what must be submitted in your next MIT transaction request in referencedSchemeTransactionIdparameter.

{
    "type": "transactionResponse",
    "clientRequestId": "4e7c624f-8a69-4b80-ba13-cf90e62a8a77",
    "apiTraceId": "Zvu_eOuxkeIY0d0V3XDsHAAAAZ4",
    "ipgTransactionId": "84668628125",
    "orderId": "R-3e2522f8-7d5b-4ec5-97b0-f65caa2994c0",
    "transactionType": "SALE",
    "paymentToken": {
        "reusable": true,
        "declineDuplicates": false,
        "brand": "VISA",
        "type": "PAYMENT_CARD"
    },
    "transactionOrigin": "ECOM",
    "paymentMethodDetails": {
        "paymentCard": {
            "expiryDate": {
                "month": "12",
                "year": "2028"
            },
            "bin": "414746",
            "last4": "0083",
            "brand": "VISA"
        },
        "paymentMethodType": "PAYMENT_CARD",
        "paymentMethodBrand": "VISA"
    },
    "country": "Singapore",
    "terminalId": "72088002",
    "merchantId": "720888002",
    "transactionTime": 1727774584,
    "approvedAmount": {
        "total": 12.00,
        "currency": "EUR",
        "components": {
            "subtotal": 12.00
        }
    },
    "transactionAmount": {
        "total": 12.00,
        "currency": "EUR",
        "components": {
            "subtotal": 12.00
        }
    },
    "transactionStatus": "APPROVED",
    "approvalCode": "Y:886591:4668628125:PPX :511392",
    "secure3dResponse": {
        "responseCode3dSecure": "1"
    },
    "schemeTransactionId": "249771795129519",
    "processor": {
        "referenceNumber": "084668628125",
        "authorizationCode": "886591",
        "responseCode": "00",
        "responseMessage": "Function performed error-free",
        "avsResponse": {
            "streetMatch": "NO_INPUT_DATA",
            "postalCodeMatch": "NO_INPUT_DATA"
        },
        "taxRefundData": {}
    }
}

Merchant Initiated Transaction

After you completed the previous step successfully, you will be able to initiate an MIT transaction:

storedCredentials Parameter description
sequencerepresents the sequence, available values for recurring payments are:
'SUBSEQUENT' - subsequent payment
scheduledindicator, if the payment is part of scheduled or unscheduled transaction, for MIT payments must be always set to 'false'
initiatorrepresents transaction initiator, available values;
'MERCHANT' - to be used for SUBSEQUENT transaction
referencedSchemeTransactionIdvalue received in the response from "FIRST" transaction in the response parameterschemeTransactionId

The following JSON document represents an example of a MIT transaction with minimal set of elements:

{
  "requestType": "PaymentCardSaleTransaction",
  "transactionAmount": {
  	"total": "12.00",
  	"currency": "EUR"
  },
  "paymentMethod": {
  	"paymentCard": {
  		"number": "414746******0083",
  		"securityCode": "XXX",
  		"expiryDate": {
  			"month": "12",
            "year": "28"
  		}
  	}
  },
  "storedCredentials": {
          "sequence": "SUBSEQUENT",
          "scheduled": false,
          "initiator": "MERCHANT",
    			"referencedSchemeTransactionId": "249771795129519"
    }
}
{
    "type": "transactionResponse",
    "clientRequestId": "a2685efc-750b-4ba7-b8e9-a17319e5f560",
    "apiTraceId": "ZvvGY3PrgEwsK5TTx7oExgAAAj4",
    "ipgTransactionId": "84668630629",
    "orderId": "R-34c1dcae-75d5-42af-8340-08aa31c1ab68",
    "transactionType": "SALE",
    "paymentToken": {
        "reusable": true,
        "declineDuplicates": false,
        "brand": "VISA",
        "type": "PAYMENT_CARD"
    },
    "transactionOrigin": "ECOM",
    "paymentMethodDetails": {
        "paymentCard": {
            "expiryDate": {
                "month": "12",
                "year": "2028"
            },
            "bin": "414746",
            "last4": "0083",
            "brand": "VISA"
        },
        "paymentMethodType": "PAYMENT_CARD",
        "paymentMethodBrand": "VISA"
    },
    "country": "Singapore",
    "terminalId": "72088002",
    "merchantId": "720888002",
    "transactionTime": 1727776355,
    "approvedAmount": {
        "total": 12.00,
        "currency": "EUR",
        "components": {
            "subtotal": 12.00
        }
    },
    "transactionAmount": {
        "total": 12.00,
        "currency": "EUR",
        "components": {
            "subtotal": 12.00
        }
    },
    "transactionStatus": "APPROVED",
    "approvalCode": "Y:271812:4668630629:PPX :512076",
    "schemeTransactionId": "119022149996541",
    "processor": {
        "referenceNumber": "084668630629",
        "authorizationCode": "271812",
        "responseCode": "00",
        "responseMessage": "Function performed error-free",
        "avsResponse": {
            "streetMatch": "NO_INPUT_DATA",
            "postalCodeMatch": "NO_INPUT_DATA"
        },
        "taxRefundData": {}
    }
}

Want a quick overview?