Skip to content

Authentications

Use Authentications to start a 3DS 2.x authentication session by querying authentication requirements.

Endpoints

POST /api/v2/merchants/{mid}/orders/{orderId}/authentications

Starts a 3DS authentication session.

Request parameters

Path parameter Requirement Description Type
mid Required The merchant account reference number. Number
orderId Required The reference to uniquely identify a payment. String
Body parameter Requirement Description Type
amount Optional The transaction amount. Number
currency Optional The ISO 4217 currency code. String
cardNumber Required The shopper’s card account number. String
cardExpiryDate Required The shopper’s card expiry month and year in the format MM/YY. String
merchantUrl Required The URL used by an ACS or other service to send responses to the merchant. String

Sample request

CURL
curl -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172' \
    https://    /api/v2/merchants/1570616552/orders/order_example_1/authentications

Request body example

REST API
{
   "amount":{
      "amount":10.50,
      "currency":"EUR"
   },
   "cardInfo":{
      "cardNumber":"4111111111111111",
      "expirationDate":"12-2024"
   },
   "merchantUrl": "https://someurltoredirectbackto.com/callbacks"
}

Sample response

REST API
{
    "mid": 1570616552,
    "orderId": "order_example_1",
    "orderAmount": 0.00,
    "fulfilmentAmount": 0.00,
    "capturedAmount": 0.00,
    "refundedAmount": 0.00,
    "currency": "EUR",
    "baseCurrency": "EUR",
    "baseOrderAmount": 0.00,
    "baseFulfilmentAmount": 0.00,
    "baseCapturedAmount": 0.00,
    "baseRefundedAmount": 0.00,
    "capturable": false,
    "cancelable": false,
    "refundable": false,
    "completable": false,
    "dccIndicator": false,
    "timestamp": "2020-02-21T09:49:08.164Z",
    "transactionReferences": [
        {
            "transactionId": 10042959346,
            "transactionTypeId": 155,
            "mid": 1570616552,
            "orderId": "order_example_1",
            "transactionType": "InitiateAuthentication",
            "transactionDate": "2020-02-21T09:49:08.164Z",
            "transactionDesc": "Transaction Accepted",
            "statusCode": 0,
            "status": "Processed",
            "amount": 10.50,
            "currency": "EUR",
            "baseAmount": 10.50,
            "baseCurrency": "EUR",
            "paymentMethod": "Visa",
            "paymentMethodId": 1001,
            "maskedAccountNumber": "411111xxxxxx1111",
            "cardExpiryDate": "12-2024",
            "cardAuthenticationInfo": {
                "xid": "MDAwMDAwMDAwMTAwNDI5NTkzNDY=",
                "cavv": "QUNTRU1Vd1BTV28kOj1Xe2VRSUc=",
                "eci": "5",
                "authRequired": "Y",
                "authenticationResult": "Y",
                "authenticationProtocolVersion": "3DS2.1.0",
                "authenticationDsTransId": "9913d29b-c02f-5f24-8000-00000000f01d"
            },
            "authenticationStatus": "SUCCESSFUL"
        }
    ]
}
Back to top