Merchant Initiated Transactions (MIT)

Last changes: 06-23-2023

Merchant Initiated Unscheduled Recurring Payments (MIT) are performed on an irregular bases for a given stored payment option marked as default by the user.

1. Authorization

All Payment Providers

The authorization of a payment is performed in single call of the API method 1.27 Authorize.

In the example below, we authorize 3.99 EUR for the payment option associated with the “storedPaymentOptionReference” (see Get Stored Payment Options) as part of the purchase of two premium widgets from Widgets GmbH. The shopper's full name is provided alongside their address.

Please note the Payment Provider may NOT permit processing for Non-Decimal Currencies if the "presentationAmount" does NOT contain a whole number.

Authorization Request

Path:: PUT {baseURL}/payment/authorize
Header:: Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
    "partnerReference": "DEV-SVR001-DE_CUSTID-JWRT7HJKK6_CARTID-4HP4YVWF44_F7XMHFR9H3",
    "programAccno": "1679541175",
    "accno": "MERCHANT-DE4321",
    "accnoType": "00",
    "storedPaymentOptionReference": "8ac7a4a266aab3ce0166c0602bf26dae",
    "presentationAmount": 3.99,
    "presentationCurrCode": "EUR",
    "presentationUsage": "Purchase:2xPremiumWidgets. Merchant:WidgetsGmbH. CUSTREF:52650FD95.",
    "useDifferentBillingAddress": false,
    "localDate": "2018-10-30",
    "localTime": "151506",
    "custom1": "WVWZZZ3BZWE689725"
}

The maximum character length of the presentation usage (see variable "presentationUsage" in the example above) varies between payment options i.e. it may be that with certain payment options the specified presentation usage may be less than 127 and consequently be truncated. It would thus be strongly recommended that the most pertinent information be placed at the beginning of the presentation usage. To be compatible with most payment options we suggest, that the presentation usage may already be truncated at the 22nd character.

Authorization Response

Status Code:: 201 (Created)
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "programAccno": "1679541175",
    "accno": "MERCHANT-DE4321",
    "uniqueReference": "ddMfQRG8TUi1SlrgeJjA7A",
    "loadAccountReference": "NvPoE85cZE6FguOfrC7Fmw",
    "storedPaymentOptionReference": "8ac7a4a266aab3ce0166c0602bf26dae",
    "presentationAmount": 3.99,
    "presentationCurrCode": "EUR",
    "presentationUsage": "Purchase:2xPremiumWidgets. Merchant:WidgetsGmbH. CUSTREF:52650FD95.",
    "processedAmount": 3.99,
    "processedCurrCode": "EUR",
    "custom1": "WVWZZZ3BZWE689725",
    "statusCode": "AUTHORIZED",
    "statusReason": "Request successfully processed in 'Merchant in Integrator Test Mode'",
    "paymentProviderResponse": {
        "id": "8ac7a4a266aab3ce0166c553d26a5d3f",
        "paymentType": "PA",
        "amount": "3.99",
        "currency": "EUR",
        "descriptor": "ddMfQRG8TUi1SlrgeJjA7A",
        "merchantTransactionId": "ddMfQRG8TUi1SlrgeJjA7A",
        "result": {
            "code": "000.100.110",
            "description": "Request successfully processed in 'Merchant in Integrator Test Mode'"
        },
        "risk": {
            "score": "0"
        },
        "buildNumber": "b7d22ea931a7f282ca7196b253acdf74fa1a99b3@2018-10-26 09:11:00 +0000",
        "timestamp": "2018-10-30 14:14:57+0000",
        "ndc": "8a82941866453ec60166457e642b0084_0a15f49b85e14121a81e8580f30d1242"
    },
    "partnerReference": "DEV-SVR001-DE_CUSTID-JWRT7HJKK6_CARTID-4HP4YVWF44_63P2X2KF2D",
    "localDate": "2018-10-30",
    "localTime": "151455",
    "sysDate": "2018-10-30",
    "sysTime": "141457",
    "responseCode": "0000",
    "responseDescription": "Successful execution",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

Please note the exact contents and structure of "paymentProviderResponse" differs based on the Payment Provider used to authorize the transaction.

The response includes the desired unique reference under the return parameter "uniqueReference", which is required to Capture the initiated transaction.

The “statusCode” AUTHORIZED implies that the payment has been successfully authorized. A list of all transaction status codes can be found in Lookups. The appropriate amount is blocked on the customer’s payment option and can be captured at a later point in time.

Previous

Next