Skip to content

API Sunset

Helena Vitásková edited this page Apr 12, 2023 · 6 revisions

The payment gateway allows merchants to create transactions using an eAPI interface that has historically been available in several versions (Legacy API, eAPI 1.0, 1.5, 1.6, 1.7, 1.8, 1.9).

Due to the requirements for transaction verification that result from regulations (e.g. PSD2) and the requirements of card schemes (mainly Mastercard and VISA), older versions of the eAPI that do not allow full transaction verification will be phased out. For this reason, we recommend migrating to the latest available version of eAPI 1.9 as soon as possible.

The termination will first apply to selected payment methods within older eAPI versions, but subsequently also to entire eAPI versions.

If the payment method is terminated, the eAPI call returns a response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "resultCode": 170,
  "resultMessage": "Payment method unavailable, see https://github.com/csob/paymentgateway/wiki/API-Sunset"
}

If the entire legacy eAPI is terminated, this response is returned:

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "resultCode": 170,
  "resultMessage": "Payment method unavailable, see https://github.com/csob/paymentgateway/wiki/API-Sunset"
}

Termination is planned according to the following schedule:

1/2/2023

  • Termination of OneClick payments for eAPI 1.8 and below (all OneClick templates created in older eAPI versions can be used in eAPI 1.9)
  • Termination of the Apple Pay payment method integrated directly into the merchant's e-shop (applepay@shop) for eAPI 1.8 and below

1/3/2023

  • Termination of eAPI 1.0

1/4/2023

  • Termination of LegacyAPI that could have been used as part of the migration from GP Webpay
  • Termination of eAPI 1.5
  • Termination of eAPI 1.6

1/5/2023

  • Termination of eAPI 1.7

The eAPI version 1.8 does not have a termination date set yet. However, in the near future you can expect the announcement of the termination date of this version as well.

Clone this wiki locally