CompleteAuthentications


Use CompleteAuthentications to complete a 3DS 2.x authentication session that has the REQUIRED or TRY_AGAIN authentication status.

Endpoints

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

Completes 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
authenticationResultParameter Required The formatted string that contains the result of an authentication. String

Sample request

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/completeauthentications

Request body example

{
   "authenticationResultParameter":"ewogICAiYWNzUmVmZXJlbmNlTnVtYmVyIiA6ICJBQ1NFbXUyIiwKICAgImFjc1RyYW5zSUQiIDogIjAwMDAwMDAwLTAwMDUtNWE1YS04MDAwLTAxNzA2NzQ2ZjUwMCIsCiAgICJtZXNzYWdlVHlwZSIgOiAiQ1JlcyIsCiAgICJtZXNzYWdlVmVyc2lvbiIgOiAiMi4xLjAiLAogICAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogImY5MmI3NDczLWZjNTQtNWM1YS04MDAwLTAwMDAwMDAwZjAyNSIsCiAgICJ0cmFuc1N0YXR1cyIgOiAiWSIKfQ"
}

Sample response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
    "mid": 1570616552,
    "orderId": "order_example_1",
    "orderAmount": 0,
    "fulfilmentAmount": 0,
    "capturedAmount": 0,
    "refundedAmount": 0,
    "currency": "EUR",
    "baseCurrency": "EUR",
    "baseOrderAmount": 0,
    "baseFulfilmentAmount": 0,
    "baseCapturedAmount": 0,
    "baseRefundedAmount": 0,
    "capturable": false,
    "cancelable": false,
    "refundable": false,
    "completable": false,
    "dccIndicator": false,
    "timestamp": "2020-02-21T10:07:22.870Z",
    "transactionReferences": [
        {
            "transactionId": 10042958345,
            "transactionTypeId": 156,
            "mid": 1570616552,
            "orderId": "order_example_1",
            "transactionType": "CompleteAuthentication",
            "transactionDate": "2020-02-21T10:12:44.612Z",
            "refTransactionId": 10042959355,
            "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": "MDAwMDAwMDAwMTAwNDI5NTkzNTU=",
                "cavv": "QUNTRU1VamhjJmE/OllcJERoY2A=",
                "eci": "5",
                "authRequired": "Y",
                "authenticationResult": "Y",
                "authenticationProtocolVersion": "3DS2.1.0",
                "authenticationDsTransId": "1bcd3518-97fb-5cd0-8000-00000000f023"
            },
            "authenticationStatus": "SUCCESSFUL"
        }
    ]
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
    "mid": 1570616552,
    "orderId": "order_example_1",
    "orderAmount": 0,
    "fulfilmentAmount": 0,
    "capturedAmount": 0,
    "refundedAmount": 0,
    "currency": "EUR",
    "baseCurrency": "EUR",
    "baseOrderAmount": 0,
    "baseFulfilmentAmount": 0,
    "baseCapturedAmount": 0,
    "baseRefundedAmount": 0,
    "capturable": false,
    "cancelable": false,
    "refundable": false,
    "completable": false,
    "dccIndicator": false,
    "timestamp": "2020-02-21T10:24:21.983Z",
    "transactionReferences": [
        {
            "transactionId": 10042960002,
            "transactionTypeId": 156,
            "mid": 1570616552,
            "orderId": "order_example_1",
            "transactionType": "CompleteAuthentication",
            "transactionDate": "2020-02-21T10:29:52.425Z",
            "refTransactionId": 10042959583,
            "transactionDesc": "Transaction Accepted",
            "statusCode": 0,
            "status": "Processed",
            "amount": 10.50,
            "currency": "EUR",
            "baseAmount": 10.50,
            "baseCurrency": "EUR",
            "paymentMethod": "Visa",
            "paymentMethodId": 1001,
            "maskedAccountNumber": "411111xxxxxx1111",
            "cardExpiryDate": "02-2021",
            "cardAuthenticationInfo": {
                "xid": "MDAwMDAwMDAwMTAwNDI5NTk1ODM=",
                "cavv": "QUNTRU1VW3BMJV9NUCRFcyZ/alc=",
                "eci": "5",
                "authRequired": "Y",
                "authenticationResult": "Y",
                "authenticationProtocolVersion": "3DS2.1.0",
                "authenticationDsTransId": "f92b7473-fc54-5c5a-8000-00000000f025"
            },
            "authenticationStatus": "SUCCESSFUL"
        }
    ]
}