Card

Create card checkout session

post

Starts a new card checkout session for the payment.

This endpoint is available only for customer-initiated payments.

Authorizations

OAuth2ClientAuthentication

OpenID ConnectRequired

This API uses OAuth 2 with the client credentials flow. More info

Path parameters

paymentIdstring · max: 64Required

Unique ID of the payment

versionstringRequired

Header parameters

X-Request-Idstring · uuidRequired

ID of the request, unique to the call, as determined by the initiating party

Body

application/json

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

503

Service Unavailable

application/json

post

/egw/{version}/payments/{paymentId}/sessions/card

HTTPcURLJavaScriptPython

POST /egw/{version}/payments/{paymentId}/sessions/card HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "encryptedCard": {
    "jweCompact": "<header>.<encrypted key>.<initialization vector>.<ciphertext>.<authentication tag>"
  }
}

{
  "action": {
    "type": "AUTHENTICATE_WITH_3DS",
    "_links": {
      "checkoutRedirect": {
        "href": "text"
      },
      "threeDsMethod": {
        "href": "text"
      }
    }
  },
  "sessionId": "text",
  "sessionStatus": "INITIALIZED"
}

Get payment's checkout session

get

Get previously created checkout session

Authorizations

OAuth2ClientAuthentication

OpenID ConnectRequired

This API uses OAuth 2 with the client credentials flow. More info

Path parameters

paymentIdstring · max: 64Required

Unique ID of the payment

sessionIdstring · max: 64Required

Unique ID of the checkout session

versionstringRequired

Header parameters

X-Request-Idstring · uuidRequired

ID of the request, unique to the call, as determined by the initiating party

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

503

Service Unavailable

application/json

get

/egw/{version}/payments/{paymentId}/sessions/{sessionId}/card

HTTPcURLJavaScriptPython

GET /egw/{version}/payments/{paymentId}/sessions/{sessionId}/card HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

{
  "action": {
    "type": "AUTHENTICATE_WITH_3DS",
    "_links": {
      "checkoutRedirect": {
        "href": "text"
      },
      "threeDsMethod": {
        "href": "text"
      }
    }
  },
  "sessionId": "text",
  "sessionStatus": "INITIALIZED"
}

Initiate 3DS authentication

patch

Initiate 3DS authentication for the payment

Authorizations

OAuth2ClientAuthentication

OpenID ConnectRequired

This API uses OAuth 2 with the client credentials flow. More info

Path parameters

paymentIdstring · max: 64Required

Unique ID of the payment

sessionIdstring · max: 64Required

Unique ID of the checkout session

versionstringRequired

Header parameters

X-Request-Idstring · uuidRequired

ID of the request, unique to the call, as determined by the initiating party

Body

application/json

Request containing payment and 3DS browser data for 3DS authentication

browserAcceptHeaderstring · min: 1Required

Exact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder's browser

browserColorDepthstring · min: 1Required

Value representing the bit depth of the colour palette for displaying images, in bits per pixel

browserIpstring · min: 1Required

IP address of the browser as returned by the HTTP headers to the 3DS Requestor

browserJavaEnabledbooleanRequired

Boolean that represents the ability of the cardholder browser to execute Java

browserJavascriptEnabledbooleanRequired

Boolean that represents the ability of the cardholder browser to execute JavaScript

browserLanguagestring · min: 1Required

Value representing the browser language as defined in IETF BCP47

browserScreenHeightstring · min: 1Required

Total height of the Cardholder's screen in pixels

browserScreenWidthstring · min: 1Required

Total width of the Cardholder's screen in pixels

browserTZstring · min: 1Required

Time-zone offset in minutes between UTC and the Cardholder browser local time

browserUserAgentstring · min: 1Required

Exact content of the HTTP user-agent header

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

503

Service Unavailable

application/json

patch

/egw/{version}/payments/{paymentId}/sessions/{sessionId}/card/three-ds/authentication

HTTPcURLJavaScriptPython

PATCH /egw/{version}/payments/{paymentId}/sessions/{sessionId}/card/three-ds/authentication HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 261

{
  "browserAcceptHeader": "text",
  "browserColorDepth": "text",
  "browserIp": "text",
  "browserJavaEnabled": true,
  "browserJavascriptEnabled": true,
  "browserLanguage": "text",
  "browserScreenHeight": "text",
  "browserScreenWidth": "text",
  "browserTZ": "text",
  "browserUserAgent": "text"
}

{
  "action": {
    "type": "AUTHENTICATE_WITH_3DS",
    "_links": {
      "checkoutRedirect": {
        "href": "text"
      },
      "threeDsMethod": {
        "href": "text"
      }
    }
  },
  "sessionId": "text",
  "sessionStatus": "INITIALIZED"
}

Complete 3DS challenge

patch

Complete 3DS challenge for the payment

Authorizations

OAuth2ClientAuthentication

OpenID ConnectRequired

This API uses OAuth 2 with the client credentials flow. More info

Path parameters

paymentIdstring · max: 64Required

Unique ID of the payment

sessionIdstring · max: 64Required

Unique ID of the checkout session

versionstringRequired

Header parameters

X-Request-Idstring · uuidRequired

ID of the request, unique to the call, as determined by the initiating party

Body

application/json

Request to complete the 3DS challenge

cresstringRequired

Base64-encoded CRes message, as received from the ACS

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

503

Service Unavailable

application/json

patch

/egw/{version}/payments/{paymentId}/sessions/{sessionId}/card/three-ds/challenge-result

HTTPcURLJavaScriptPython

PATCH /egw/{version}/payments/{paymentId}/sessions/{sessionId}/card/three-ds/challenge-result HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "cres": "text"
}

{
  "action": {
    "type": "REDIRECT_TO_SHOP",
    "_links": {
      "shopRedirect": {
        "href": "text"
      }
    }
  },
  "sessionId": "text",
  "sessionStatus": "INITIALIZED"
}