Token

Create token checkout session

post

Starts a new token checkout session for the payment.

Further processing continues according to the underlying payment method stored in the token, e.g. card session flow.

This endpoint is available for both customer-initiated and merchant-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

gatewayTokenIdstring · max: 64Required

Unique ID of the token to use for the payment

Responses

200

OK

application/json

actionone ofOptional

or

or

sessionIdstring · max: 64Optional

Unique ID of the checkout session

sessionStatusstring · enumOptional

Status of the checkout session

Possible values:

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

HTTPcURLJavaScriptPython

POST /egw/{version}/payments/{paymentId}/sessions/token 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: 25

{
  "gatewayTokenId": "text"
}

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