Open Banking

Create bank checkout session

post

Starts a new bank 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

browserIpstring · max: 45Required

User's browser IP address

browserUserAgentstring · min: 1Required

Exact content of the HTTP user-agent header

preferredLocalestring · enumOptional

Preferred locale for the checkout page, defaults to the locale sent in payment initiation request

Possible values:

Responses

200

OK

application/json

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

HTTPcURLJavaScriptPython

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

{
  "bank": {
    "bankId": "text"
  },
  "browserIp": "text",
  "browserUserAgent": "text",
  "preferredLocale": "cz"
}

{
  "action": {
    "_links": {
      "scaRedirect": {
        "href": "text"
      }
    },
    "type": "REDIRECT_TO_SCA"
  },
  "sessionId": "text",
  "sessionStatus": "INITIALIZED"
}

Create consent

patch

Create consent for the payment, after completing pre-step SCA

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

preferredLocalestring · enumOptional

Preferred locale for the checkout page, defaults to the locale sent in payment initiation request

Possible values:

Responses

200

OK

application/json

Response with Strong Customer Authentication redirect URL for creating a consent for the payment

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

patch

/egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/consent

HTTPcURLJavaScriptPython

PATCH /egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/consent 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: 24

{
  "preferredLocale": "cz"
}

{
  "action": {
    "_links": {
      "scaRedirect": {
        "href": "text"
      }
    },
    "type": "REDIRECT_TO_SCA"
  },
  "sessionId": "text",
  "sessionStatus": "INITIALIZED"
}

Get bank accounts

get

Get available bank accounts for the user

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

Response containing a list of available bank accounts

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

get

/egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/accounts

HTTPcURLJavaScriptPython

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

{
  "action": {
    "accounts": [
      {
        "balance": "text",
        "currency": "text",
        "displayName": "text",
        "iban": "text",
        "ownerName": "text"
      }
    ],
    "type": "SELECT_ACCOUNT"
  },
  "sessionId": "text",
  "sessionStatus": "INITIALIZED"
}

Confirm payment

patch

Confirm and initiate 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

ibanstring · max: 34Optional

International Bank Account Number of the bank account to be used for the payment

preferredLocalestring · enumOptional

Preferred language for the checkout page. Defaults to language sent in one-off or CIT request, if missing

Possible values:

Responses

200

OK

application/json

Response with Strong Customer Authentication redirect URL for confirming the payment

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

patch

/egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/confirm

HTTPcURLJavaScriptPython

PATCH /egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/confirm 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: 38

{
  "iban": "text",
  "preferredLocale": "cz"
}

{
  "action": {
    "_links": {
      "scaRedirect": {
        "href": "text"
      }
    },
    "type": "REDIRECT_TO_SCA"
  },
  "sessionId": "text",
  "sessionStatus": "INITIALIZED"
}

Complete payment

patch

Check the status of the payment and mark as completed

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

Response containing the status of the payment

completionStatusstring · enumOptional

Status of the payment

Possible values:

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

patch

/egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/complete

HTTPcURLJavaScriptPython

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

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