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.

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
tokenIdstring · max: 64Required

Unique ID of the token to use for the payment

Responses
200
OK
application/json
post
POST /egw/{version}/payments/{paymentId}/sessions/token HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 18

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

Last updated

Was this helpful?