Merge pull request #63 from saferpay/feature/changelog_for_version_1.42

changes for api version 1.42
saferpay · Sep 3, 2024 · 5319a1c · 5319a1c
2 parents 574b987 + c29b8c3
commit 5319a1c
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 14 deletions.
diff --git a/.github/workflows/create-gh-pages.yml b/.github/workflows/create-gh-pages.yml
@@ -17,7 +17,7 @@ jobs:
             path: _gh_pages
 
       - name: build new version page
-        run: libs/GitHubPagesGenerator.exe -i "${{ github.workspace }}" -s "${{ github.workspace }}/Sitemap.json" -c "${{ github.workspace }}" -o _gh_pages -t "JSON API Spec-Version 1.41"
+        run: libs/GitHubPagesGenerator.exe -i "${{ github.workspace }}" -s "${{ github.workspace }}/Sitemap.json" -c "${{ github.workspace }}" -o _gh_pages -t "JSON API Spec-Version 1.42"
 
       - name: push updated gh pages
         uses: s0/git-publish-subdir-action@develop

diff --git a/texts/Changelog.md b/texts/Changelog.md
@@ -1,6 +1,7 @@
 # <a name="changelog"></a> Changelog
 
 ## Table of Contents
+- [Version 1.42](#v1.42.0.0.20240917)
 - [Version 1.41](#v1.41.0.0.20240716)
 - [Version 1.40](#v1.40.0.0.20240521)
 - [Version 1.39](#v1.39.0.0.20240319)
@@ -40,6 +41,12 @@
 - [Version 1.5](#v1.5.0.20170207)
 - [Version 1.4](#v1.4.0.20161015)
 
+## <a name="v1.42.0.0.20240917"></a> Version 1.42 (released 2024-09-17)
+- available on Sandbox: 2024-09-03
+- introduced version 1.42
+- added value `1.42` for _SpecVersion_
+- added `PaymentMethodsOptions` to [Transaction/Refund](index.html#Payment_v1_Transaction_Refund) for iDEAL AccountHolderName
+
 ## <a name="v1.41.0.0.20240716"></a> Version 1.41 (released 2024-07-16)
 - available on Sandbox: 2024-07-02
 - introduced version 1.41

diff --git a/texts/ChapterTransaction.md b/texts/ChapterTransaction.md
@@ -87,7 +87,7 @@ This method may be used to start a transaction which may involve either DCC and
 	</span>
 </td>
 <td class="col-sm-8">
-	<div style="padding-bottom: 10px">This parameter let you define your payment page config (PPConfig) by name. If this parameters is not set, your default PPConfig will be applied if available.<br> When the PPConfig can't be found (e.g. wrong name), the Saferpay basic style will be applied to the payment page.</div>
+	<div style="padding-bottom: 10px">This parameter let you define your payment page config (PPConfig) by name. If this parameter is not set, your default PPConfig will be applied if available.<br> When the PPConfig can't be found (e.g. wrong name), the Saferpay basic style will be applied to the payment page.</div>
 	<i class="small text-muted">
 Id[1..20]<br />
 				    <span>Example: <code>name of your payment page config (case-insensitive)</code></span>
@@ -3888,7 +3888,7 @@ This method can be used to get the details of a transaction that has been author
 <pre class="prettyprint">
 {
   "RequestHeader": {
-    "SpecVersion": "1.11",
+    "SpecVersion": "[current Spec-Version]",
     "CustomerId": "[your customer id]",
     "RequestId": "[unique request id]",
     "RetryIndicator": 0
@@ -4031,7 +4031,7 @@ This method can be used to get the details of a transaction that has been author
 <pre class="prettyprint">
 {
   "ResponseHeader": {
-    "SpecVersion": "1.11",
+    "SpecVersion": "[current Spec-Version]",
     "RequestId": "[your request id]"
   },
   "Transaction": {
@@ -4257,7 +4257,7 @@ Numeric[8..8]<br />
 <pre class="prettyprint">
 {
   "RequestHeader": {
-    "SpecVersion": "1.12",
+    "SpecVersion": "[current Spec-Version]",
     "CustomerId": "[your customer id]",
     "RequestId": "[your request id]",
     "RetryIndicator": 0
@@ -4579,7 +4579,7 @@ Id[1..50]<br />
 <pre class="prettyprint">
 {
   "ResponseHeader": {
-    "SpecVersion": "1.12",
+    "SpecVersion": "[current Spec-Version]",
     "RequestId": "[your request id]"
   },
   "Transaction": {

diff --git a/texts/ContainerDictionary.md b/texts/ContainerDictionary.md
@@ -1390,8 +1390,8 @@ Range: inclusive between 0 and 9<br />
 <td class="col-sm-8">
 	<div style="padding-bottom: 10px">Version number of the interface specification. For new implementations, the newest Version should be used.</div>
 	<i class="small text-muted">
-Possible values: 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25, 1.26, 1.27, 1.28, 1.29, 1.30, 1.31, 1.32, 1.33, 1.34, 1.35, 1.36, 1.37, 1.38, 1.39, 1.40, 1.41<br />
-				    <span>Example: <code>1.41</code></span>
+Possible values: 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25, 1.26, 1.27, 1.28, 1.29, 1.30, 1.31, 1.32, 1.33, 1.34, 1.35, 1.36, 1.37, 1.38, 1.39, 1.40, 1.41, 1.42<br />
+				    <span>Example: <code>1.42</code></span>
 	</i>
 </td>
 							</tr>
@@ -1431,8 +1431,8 @@ Id[1..50]<br />
 <td class="col-sm-8">
 	<div style="padding-bottom: 10px">Version number of the interface specification.</div>
 	<i class="small text-muted">
-Possible values: 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25, 1.26, 1.27, 1.28, 1.29, 1.30, 1.31, 1.32, 1.33, 1.34, 1.35, 1.36, 1.37, 1.38, 1.39, 1.40, 1.41<br />
-				    <span>Example: <code>1.41</code></span>
+Possible values: 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25, 1.26, 1.27, 1.28, 1.29, 1.30, 1.31, 1.32, 1.33, 1.34, 1.35, 1.36, 1.37, 1.38, 1.39, 1.40, 1.41, 1.42<br />
+				    <span>Example: <code>1.42</code></span>
 	</i>
 </td>
 							</tr>
@@ -2513,7 +2513,7 @@ Utf8[1..1000]<br />
 	</span>
 </td>
 <td class="col-sm-8">
-	<div style="padding-bottom: 10px">Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.</div>
+	<div style="padding-bottom: 10px">Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.<br> Please note that for some payment methods e.g. TWINT, iDEAL only 50 characters are supported, the remaining characters are truncated.</div>
 	<i class="small text-muted">
 Id[1..80]<br />
 				    <span>Example: <code>c52ad18472354511ab2c33b59e796901</code></span>
@@ -4182,7 +4182,7 @@ Id[1..35]<br />
 	</span>
 </td>
 <td class="col-sm-8">
-	<div style="padding-bottom: 10px">Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.</div>
+	<div style="padding-bottom: 10px">Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.<br> Please note that for some payment methods e.g. TWINT, iDEAL only 50 characters are supported, the remaining characters are truncated.</div>
 	<i class="small text-muted">
 Id[1..80]<br />
 				    <span>Example: <code>c52ad18472354511ab2c33b59e796901</code></span>
@@ -4682,7 +4682,7 @@ Id[1..35]<br />
 	</span>
 </td>
 <td class="col-sm-8">
-	<div style="padding-bottom: 10px">Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.</div>
+	<div style="padding-bottom: 10px">Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.<br> Please note that for some payment methods e.g. TWINT, iDEAL only 50 characters are supported, the remaining characters are truncated.</div>
 	<i class="small text-muted">
 Id[1..80]<br />
 				    <span>Example: <code>c52ad18472354511ab2c33b59e796901</code></span>
@@ -5010,7 +5010,7 @@ Id[1..35]<br />
 	</span>
 </td>
 <td class="col-sm-8">
-	<div style="padding-bottom: 10px">Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.</div>
+	<div style="padding-bottom: 10px">Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.<br> Please note that for some payment methods e.g. TWINT, iDEAL only 50 characters are supported, the remaining characters are truncated.</div>
 	<i class="small text-muted">
 Id[1..80]<br />
 				    <span>Example: <code>c52ad18472354511ab2c33b59e796901</code></span>
@@ -6846,6 +6846,29 @@ Range: inclusive between 2000 and 9999<br />
 Possible values: APPROVED, CHALLENGED.<br />
 				    <span>Example: <code>APPROVED</code></span>
 	</i>
+</td>
+							</tr>
+					</tbody>
+				</table>
+			<h2>Container "Payment_Models_IdealRefund"</h2>
+				<table class="table" id="Payment_Models_IdealRefund">
+					<tbody>
+							<tr>
+								<td class="col-sm-4 text-right">
+	<strong>AccountHolderName</strong><br />
+	<span class="text-muted small">
+			<span>
+				<span class="text-mandatory">mandatory</span>,
+			</span>
+				string
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">The account holder name will be used if not already present in the authorization.<br> If no account holder name is present in the authorization and none provided in the refund request, the refund cannot be processed.</div>
+	<i class="small text-muted">
+Utf8[1..140]<br />
+				    <span>Example: <code>John Doe</code></span>
+	</i>
 </td>
 							</tr>
 					</tbody>
@@ -6898,6 +6921,20 @@ Possible values: APPROVED, CHALLENGED.<br />
 	<div style="padding-bottom: 10px">Optional. Options which only apply to account to account</div>
 	<i class="small text-muted">
 			</i>
+</td>
+							</tr>
+							<tr>
+								<td class="col-sm-4 text-right">
+	<strong>Ideal</strong><br />
+	<span class="text-muted small">
+				
+				<a class="type-details in" href="#Payment_Models_IdealRefund">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">Optional. Options which only apply to iDEAL</div>
+	<i class="small text-muted">
+			</i>
 </td>
 							</tr>
 					</tbody>