v1

latestOpenAPI 3.1.02026-07-26270268.6 KB

Authenticate Payer

post/v6/direct/authenticate/payer

Request body

sessionIdstring required

A session ID, is a unique identifier that a server generates as part of the create session API call and assigns to a merchant transaction for the duration of the session (15 min).

orderIdstring required

This is a unique identifier for this order to discern it from others order you created. If orderId is not sent with the request, an orderId is created by the server and returned in the response. The orderid can be used to refer to this order in subsequent transactions and in retrieving meta data about the order. The orderId must always be unique for every order created under your merchant profile. This must be a valid GUID.

source'HPP' | 'MobileApp' | 'DirectAPI'

Source of capturing the transaction. Use "DirectAPI" for this call.

timeZonestring

Time in minutes from UTC timezone.

Response

200

orderIdstring

threeDSecureIdstring

htmlBodyContentstring

gatewayDecisionstring

responseMessagestring

detailedResponseMessagestring

languagestring

responseCodestring

detailedResponseCodestring

Example response

{
  "orderId": "d56026ac-2784-4524-eef7-08dc33b7e268",
  "threeDSecureId": "5e3cf62a-9ec7-4d26-ca24-08dc33b7e269",
  "htmlBodyContent": "<div id=\"threedsChallengeRedirect\" xmlns=\"http://www.w3.org/1999/html\" style=\" height: 100vh\"> <form id =\"threedsChallengeRedirectForm\" method=\"POST\" action=\"https://mtf.gateway.mastercard.com/acs/mastercard/v2/prompt\" target=\"challengeFrame\"> <input type=\"hidden\" name=\"creq\" value=\"eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjlmMDZmZjc5LTVlYjUtNDdlMS05ZjZkLWU0MzQyYWUyYjFkYyJ9\" /> </form> <iframe id=\"challengeFrame\" name=\"challengeFrame\" width=\"100%\" height=\"100%\" ></iframe> <script id=\"authenticate-payer-script\"> var e=document.getElementById(\"threedsChallengeRedirectForm\"); if (e) { e.submit(); if (e.parentNode !== null) { e.parentNode.removeChild(e); } } </script> </div>",
  "gatewayDecision": "ContinueToPay",
  "responseMessage": "Success",
  "detailedResponseMessage": "The operation was successful",
  "language": "en",
  "responseCode": "000",
  "detailedResponseCode": "000"
}