From a93ddde0210227935ccf129f192a29316f3c459f Mon Sep 17 00:00:00 2001 From: Casper Thomsen Date: Thu, 13 Apr 2023 15:30:42 +0200 Subject: [PATCH] Deprecation cleanup (#169) Removal of `recurring`, `card[pares]`, `mobilepayonline[pares]` and `[3dsecure][v1]` on authorization request and `threed_secure` on authorization response. Co-authored-by: Martin Toft Bay --- .../gateway/api_reference/changes/changes.md | 38 +++++-------------- .../authentications/3dsecure.md | 11 +----- .../authentications/3dsecure_v1.md | 19 ---------- .../authorizations/authorizations.md | 10 ----- .../authorizations_methods/card.md | 8 +--- .../authorizations_methods/mobilepayonline.md | 10 ----- .../authorizations_methods/moto.md | 2 +- .../resources/authorizations/series/series.md | 4 -- .../secure_transactions.md | 3 -- 9 files changed, 13 insertions(+), 92 deletions(-) delete mode 100644 website/content/gateway/api_reference/resources/authorizations/authentications/3dsecure_v1.md diff --git a/website/content/gateway/api_reference/changes/changes.md b/website/content/gateway/api_reference/changes/changes.md index 0d697fd9..fe65ba3e 100644 --- a/website/content/gateway/api_reference/changes/changes.md +++ b/website/content/gateway/api_reference/changes/changes.md @@ -10,6 +10,16 @@ Follow coming changes on the [source code repository](https://github.com/clearha Sorted by descending timestamp. +#### Removal of deprecated parameters +We are removing several parameters that have been deprecated for an extended +period of time. We promise that the following parameters are functional until +2023-05-01T00:00:00Z but give no guarantees thereafter. + +* Request parameter `recurring`. Please use `series[]` instead. +* Request parameters `card[pares]`, `mobilepayonline[pares]` and + `[3dsecure][v1]` since 3DSv1 is being fully sunset 2023-04-15. +* Response parameter `threed_secure`, since 3DSv1 is being sunset fully on 2023-04-15. + #### Icelandic Krona (ISK) exponent change ISK changes exponent from 2 to exponent 0. Transactions in ISK will be declined between 2023-04-13T19:00:00Z (Thursday @@ -41,31 +51,3 @@ The currency SLL has been changed to SLE on 2022-10-07. #### Accept travel data [Travel data](#travel-data) can be [supplied for a capture](#captures) as of 2022-02-11. - - -#### Removing VES from supported currencies -The currency VES will not be supported after 2021-10-01T04:00:00Z. - - -#### Update authorization parameters -Replace `recurring` with `series[type]=recurring` and add `series[previous]` as a way of pointing to the previous-in-series authorization (either via a Clearhaus authorization ID or via raw scheme values). - -Add also two optional parameters `credential_on_file` and `initiator` to allow for explicitly specifying if credential on file is being stored or used, and if the transaction is merchant or cardholder initiated. - - -#### Support for multiple signatures removed -Support for multiple signatures for request signing will be removed any time after 2020-10-31. - -#### 3-D Secure version 2 supported -Starting 2020-07-08 support for 3-D Secure version 2 has been added. See 3-D Secure and Authentication: [3dsecure]. - - -#### Deprecate `threed_secure` response element -The response element `threed_secure` is now deprecated; it will be available at least until 2021-02-15. - -#### Optional name on card parameter added - -Starting 2020-03-03 the optional parameter `card[name]` may be used to provide the name on the card for credits. Depending on card scheme and merchant category, the name might be necessary for approval. - -#### Request signing becomes mandatory -In the first quarter of 2020 signing of POST requests will become mandatory. We will work together with clients to ensure their requests are compliant before introducing enforcement of the requirement in the transaction gateway. diff --git a/website/content/gateway/api_reference/resources/authorizations/authentications/3dsecure.md b/website/content/gateway/api_reference/resources/authorizations/authentications/3dsecure.md index cbfbe143..cb5ddf07 100644 --- a/website/content/gateway/api_reference/resources/authorizations/authentications/3dsecure.md +++ b/website/content/gateway/api_reference/resources/authorizations/authentications/3dsecure.md @@ -12,14 +12,5 @@ Only one 3-D Secure version can be used for a given authorization. {{% /description_term %}} {{% description_details %}} 3-D Secure version 2, also known as EMV 3-D Secure. -{{% regex_optional %}}Optional. ~~Cannot be present if `v1` is present.~~{{% /regex_optional %}} +{{% regex_optional %}}Optional.{{% /regex_optional %}} {{% /description_details %}} - -{{% description_list %}} -{{% description_term %}}~~[3dsecure][v1]~~ {{% regex %}}~~dictionary~~{{% /regex %}}{{% /description_term %}} -{{% description_details %}}Deprecated! Will stop working anytime after 2022-10-18. Please use `[3dsecure][v2]`. - -~~3-D Secure version 1.~~ -{{% regex_optional %}}~~Optional. Cannot be present if `v2` is present.~~{{% /regex_optional %}}{{% /description_details %}} - -{{% /description_list %}} diff --git a/website/content/gateway/api_reference/resources/authorizations/authentications/3dsecure_v1.md b/website/content/gateway/api_reference/resources/authorizations/authentications/3dsecure_v1.md deleted file mode 100644 index ddb8ac4c..00000000 --- a/website/content/gateway/api_reference/resources/authorizations/authentications/3dsecure_v1.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "3dsecure" -date: 2022-04-13T12:37:22+02:00 -anchor: "authentication-3dsecure-v1" -weight: 145 ---- -#### ~~Authentication: [3dsecure][v1]~~ - -{{% description_list %}} -{{% description_term %}}~~[3dsecure][v1][pares]~~ {{% regex %}}~~[\:base64\:]~~{{% /regex %}}{{% /description_term %}} -{{% description_details %}}Deprecated! Will stop working anytime after 2022-10-18. Please use `[3dsecure][v2]`. - -~~See more information at [3Dsecure.io](https://www.docs.3dsecure.io).~~ -{{% regex_optional %}}~~Optional.~~{{% /regex_optional %}}{{% /description_details %}} - -{{% /description_list %}} -{{% notice %}} -~~**Notice**: A valid PARes can indicate three different levels: non-authenticated, attempted 3-D Secure, fully 3-D Secure.~~ -{{% /notice %}} diff --git a/website/content/gateway/api_reference/resources/authorizations/authorizations.md b/website/content/gateway/api_reference/resources/authorizations/authorizations.md index c4b41793..759df9bd 100644 --- a/website/content/gateway/api_reference/resources/authorizations/authorizations.md +++ b/website/content/gateway/api_reference/resources/authorizations/authorizations.md @@ -93,16 +93,6 @@ Conditional. Cannot be present if `series[type]` is present. {{% regex_optional %}}Optional, defaults to account's descriptor{{% /regex_optional %}} {{% /description_details %}} -{{% description_term %}}~~recurring~~{{% regex %}}(true|false){{% /regex %}}{{% /description_term %}} -{{% description_details %}}Deprecated! Please use `series`. - -{{% regex_optional %}}~~Optional~~{{% /regex_optional %}} -{{% regex_optional %}}~~Cannot be used with `series` or `initiator`.~~{{% /regex_optional %}} -{{% /description_details %}} -{{% /description_list %}} -{{% notice %}} -**Notice:** When `recurring` is used, Clearhaus automatically identifies if there was a previous-in-series and if that is the case uses the level of authentication (CSC, 3-D Secure, etc.) to conclude if the payment is a first-in-in-series or a subsequent-in-series recurring. -{{% /notice %}} {{% notice %}} **Notice:** Since `series[type]` cannot be supplied together with `series[previous]`, the type of a series cannot change. {{% /notice %}} diff --git a/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/card.md b/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/card.md index 63a1e2a7..6ff33a1c 100644 --- a/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/card.md +++ b/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/card.md @@ -28,13 +28,7 @@ weight: 110 {{% description_details %}}See [Authentication: [3dsecure]](#authentication-3dsecure). {{% regex_optional %}}Optional{{% /regex_optional %}} {{% /description_details %}} - -{{% description_term %}}~~card[pares]~~ {{% regex %}}[\:base64\:]{{% /regex %}}{{% /description_term %}} -{{% description_details %}}Deprecated! Please use `card[3dsecure][v1][pares].` -See more information at [3dsecure.io](https://www.3dsecure.io) -{{% regex_optional %}}Optional{{% /regex_optional %}} -{{% /description_details %}} {{% /description_list %}} {{% notice %}} -**Notice:** An authorization that includes `card[3dsecure][v1][pares]`, `card[3dsecure][v2][rreq]`, and/or `card[csc]` cannot be a subsequent-in-series authorization. +**Notice:** An authorization that includes `card[3dsecure][v2][rreq]` and/or `card[csc]` cannot be a subsequent-in-series authorization. {{% /notice %}} diff --git a/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/mobilepayonline.md b/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/mobilepayonline.md index daa641bf..a9f88ef5 100644 --- a/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/mobilepayonline.md +++ b/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/mobilepayonline.md @@ -43,16 +43,6 @@ Phone number from where the PAN originates. See [Authentication: [3dsecure]](#authentication-3dsecure). {{% regex_optional %}}Optional{{% /regex_optional %}} {{% /description_details %}} - - -{{% description_term %}}~~mobilepayonline[pares]~~ {{% regex %}}~~[\:base64\:]~~{{% /regex %}}{{% /description_term %}} -{{% description_details %}} -Deprecated! Please use `mobilepayonline[3dsecure][v1][pares]`. - -See more information at [3dsecure.io](https://www.3dsecure.io). -{{% regex_optional %}}Optional{{% /regex_optional %}} -{{% /description_details %}} - {{% /description_list %}} {{% notice %}} **Notice**: Signing is required to use the `mobilepayonline` payment method. diff --git a/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/moto.md b/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/moto.md index 265d9c03..4215ef4a 100644 --- a/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/moto.md +++ b/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/moto.md @@ -26,5 +26,5 @@ Expiry year of card to charge. {{% notice %}} **Notice**: Signing is required to use the `moto` payment method. -**Notice**: Neither `series[]` (nor `recurring`) nor `credential_on_file` is supported. Also, `initiator` cannot be `merchant`. +**Notice**: Neither `series[]` nor `credential_on_file` is supported. Also, `initiator` cannot be `merchant`. {{% /notice %}} diff --git a/website/content/gateway/api_reference/resources/authorizations/series/series.md b/website/content/gateway/api_reference/resources/authorizations/series/series.md index 3c45e163..de44b80f 100644 --- a/website/content/gateway/api_reference/resources/authorizations/series/series.md +++ b/website/content/gateway/api_reference/resources/authorizations/series/series.md @@ -48,8 +48,4 @@ Default: `recurring`. {{% description_term %}}series[previous][visa][tid] {{% regex %}}[0-9]{15}{{% /description_term %}} {{% description_details %}}Transaction ID from Field 62.2 of the first-in-series or previous-in-series authorization; to be used in Field 125, Usage 2, Dataset ID 03. {{% regex_optional %}}Conditional. Required if `series[previous][visa][type]` is present. Cannot be present if `series[previous][id]` or any `series[previous][mastercard][...]` is present.{{% /regex_optional %}}{{% /description_details %}} -{{% notice %}} -**Notice**: A series migrated to Clearhaus using these scheme references cannot be continued with the now deprecated recurring flag. Instead, the subsequent-in-series following an authorization created using scheme references must use `series[previous][id]` to point to the previous in series. - -{{% /notice %}} {{% /description_list %}} diff --git a/website/content/gateway/examples/3_d_sercure/secure_transactions/secure_transactions.md b/website/content/gateway/examples/3_d_sercure/secure_transactions/secure_transactions.md index 7f0cc910..5bad8e30 100644 --- a/website/content/gateway/examples/3_d_sercure/secure_transactions/secure_transactions.md +++ b/website/content/gateway/examples/3_d_sercure/secure_transactions/secure_transactions.md @@ -32,6 +32,3 @@ Example response (snippet): } } ``` -{{% notice %}} -**Notice:** The response element {{% highlight_text %}}threed_secure{{% /highlight_text %}} is deprecated, please use {{% highlight_text %}}3dsecure{{% /highlight_text %}}. -{{% /notice %}}