From cca9f87dad7f14efc20d233de41e60c3da1ae6ca Mon Sep 17 00:00:00 2001 From: Casper Thomsen Date: Mon, 3 Apr 2023 14:23:28 +0200 Subject: [PATCH 1/7] Announce cleanup in changelog --- .../content/gateway/api_reference/changes/changes.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/website/content/gateway/api_reference/changes/changes.md b/website/content/gateway/api_reference/changes/changes.md index fe4c0a4..a18db18 100644 --- a/website/content/gateway/api_reference/changes/changes.md +++ b/website/content/gateway/api_reference/changes/changes.md @@ -10,6 +10,17 @@ 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-01, 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 + 2023-04-15. + #### Debits and debit refunds resources added Starting 2023-02-01, [debits](#debits) and [debit refunds](#debit_refunds) resources are available. From a0a52fcdf89899db2bcc8de925c9c42672fd45ca Mon Sep 17 00:00:00 2001 From: Casper Thomsen Date: Mon, 3 Apr 2023 14:23:47 +0200 Subject: [PATCH 2/7] Remove "too old" changelog entries --- .../gateway/api_reference/changes/changes.md | 28 ------------------- 1 file changed, 28 deletions(-) diff --git a/website/content/gateway/api_reference/changes/changes.md b/website/content/gateway/api_reference/changes/changes.md index a18db18..4130f64 100644 --- a/website/content/gateway/api_reference/changes/changes.md +++ b/website/content/gateway/api_reference/changes/changes.md @@ -46,31 +46,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. From 1777a27449d48819a94c645209a45bbf5ff291c1 Mon Sep 17 00:00:00 2001 From: Casper Thomsen Date: Mon, 3 Apr 2023 14:32:57 +0200 Subject: [PATCH 3/7] Remove deprecated recurring parameter --- .../resources/authorizations/authorizations.md | 10 ---------- .../authorizations/authorizations_methods/moto.md | 2 +- .../resources/authorizations/series/series.md | 4 ---- 3 files changed, 1 insertion(+), 15 deletions(-) diff --git a/website/content/gateway/api_reference/resources/authorizations/authorizations.md b/website/content/gateway/api_reference/resources/authorizations/authorizations.md index c4b4179..759df9b 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/moto.md b/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/moto.md index 265d9c0..4215ef4 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 3c45e16..de44b80 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 %}} From 815ed689215a1417d97962def3de3a159df9a4e2 Mon Sep 17 00:00:00 2001 From: Casper Thomsen Date: Mon, 3 Apr 2023 14:42:43 +0200 Subject: [PATCH 4/7] Remove deprecated 3DSv1 parameters --- .../authentications/3dsecure.md | 11 +---------- .../authentications/3dsecure_v1.md | 19 ------------------- .../authorizations_methods/card.md | 8 +------- .../authorizations_methods/mobilepayonline.md | 10 ---------- 4 files changed, 2 insertions(+), 46 deletions(-) delete mode 100644 website/content/gateway/api_reference/resources/authorizations/authentications/3dsecure_v1.md 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 cbfbe14..cb5ddf0 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 ddb8ac4..0000000 --- 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_methods/card.md b/website/content/gateway/api_reference/resources/authorizations/authorizations_methods/card.md index 63a1e2a..a3290a5 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 daa641b..a9f88ef 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. From 8ba3f1844a82dd4977ad15222e1f4260dccfc250 Mon Sep 17 00:00:00 2001 From: Casper Thomsen Date: Mon, 3 Apr 2023 14:44:34 +0200 Subject: [PATCH 5/7] Remove deprecated threed_secure response value --- .../3_d_sercure/secure_transactions/secure_transactions.md | 3 --- 1 file changed, 3 deletions(-) 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 7f0cc91..5bad8e3 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 %}} From 897a8148995ff2d8b75961edbe644bbb16cb15ba Mon Sep 17 00:00:00 2001 From: Casper Thomsen Date: Thu, 13 Apr 2023 15:21:48 +0200 Subject: [PATCH 6/7] Apply suggestions from code review Mostly formatting. Co-authored-by: Martin Toft Bay --- website/content/gateway/api_reference/changes/changes.md | 7 +++---- .../authorizations/authorizations_methods/card.md | 2 +- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/website/content/gateway/api_reference/changes/changes.md b/website/content/gateway/api_reference/changes/changes.md index 4130f64..d3c7a94 100644 --- a/website/content/gateway/api_reference/changes/changes.md +++ b/website/content/gateway/api_reference/changes/changes.md @@ -13,13 +13,12 @@ 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-01, but give no guarantees thereafter. +2023-05-01T00:00:00Z but give no guarantees thereafter. * Request parameter `recurring`. Please use `series[]` instead. -* Request parameters `card[pares]`, `mobilepayonline[pares]`, and +* 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 - 2023-04-15. +* Response parameter `threed_secure`, since 3DSv1 is being sunset fully on 2023-04-15. #### Debits and debit refunds resources added Starting 2023-02-01, [debits](#debits) and [debit refunds](#debit_refunds) resources are available. 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 a3290a5..6ff33a1 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 @@ -30,5 +30,5 @@ weight: 110 {{% /description_details %}} {{% /description_list %}} {{% notice %}} -**Notice:** An authorization that includes `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 %}} From 2924563c934bdee26521f1797f5656a199e04466 Mon Sep 17 00:00:00 2001 From: Casper Thomsen Date: Thu, 13 Apr 2023 15:25:42 +0200 Subject: [PATCH 7/7] Reintroduce empty line between sections --- website/content/gateway/api_reference/changes/changes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/website/content/gateway/api_reference/changes/changes.md b/website/content/gateway/api_reference/changes/changes.md index 45c0610..fe65ba3 100644 --- a/website/content/gateway/api_reference/changes/changes.md +++ b/website/content/gateway/api_reference/changes/changes.md @@ -25,6 +25,7 @@ ISK changes exponent from 2 to exponent 0. Transactions in ISK will be declined between 2023-04-13T19:00:00Z (Thursday evening) and 2023-04-17T08:00:00Z (Monday morning) (both inclusive); before this timespan, the exponent is 2; after the timespan, the exponent is 0. + #### Debits and debit refunds resources added Starting 2023-02-01, [debits](#debits) and [debit refunds](#debit_refunds) resources are available.