Merge pull request #66 from saferpay/feature/SFRP-21837-update-jsonapi

SFRP-21837 add new documentation for json api
saferpay · Jan 7, 2025 · 8769950 · 8769950
2 parents 97c18dc + d34a143
commit 8769950
Show file tree

Hide file tree

Showing 6 changed files with 558 additions and 45 deletions.
diff --git a/.github/workflows/create-gh-pages.yml b/.github/workflows/create-gh-pages.yml
@@ -1,5 +1,5 @@
 name: create gh pages
-on: 
+on:
     push:
         branches:
         - master
@@ -17,8 +17,8 @@ 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.43"
-      
+        run: libs/GitHubPagesGenerator.exe -i "${{ github.workspace }}" -s "${{ github.workspace }}/Sitemap.json" -c "${{ github.workspace }}" -o _gh_pages -t "JSON API Spec-Version 1.44"
+
       - name: push updated gh pages
         uses: s0/git-publish-subdir-action@develop
         env:

diff --git a/texts/Changelog.md b/texts/Changelog.md
@@ -1,6 +1,7 @@
 # <a name="changelog"></a> Changelog
 
 ## Table of Contents
+- [Version 1.44](#v1.44.0.0.20250121)
 - [Version 1.43](#v1.43.0.0.20241112)
 - [Version 1.42](#v1.42.0.0.20240917)
 - [Version 1.41](#v1.41.0.0.20240716)
@@ -42,6 +43,29 @@
 - [Version 1.5](#v1.5.0.20170207)
 - [Version 1.4](#v1.4.0.20161015)
 
+## <a name="v1.44.0.0.20250121"></a> Version 1.44 (released 2025-01-21)
+- available on Sandbox: 2025-01-07
+- introduced version 1.44
+- added value `1.44` for _SpecVersion_
+- relax definitions to allow new payment methods for old api versions in these requests:
+  - [PaymentPage/Assert](index.html#Payment_v1_PaymentPage_Assert)
+  - [Transaction/Inquire](index.html#Payment_v1_Transaction_Inquire)
+- added new function to [Saferpay Management API](index.html#ChapterManagementApi) for deleting Fields AccessTokens
+- added new function [Alias\Inquire](index.html#Payment_v1_Alias_Inquire)
+- added new `Tokenization` container to the following responses:
+  - [PaymentPage\Assert](index.html#Payment_v1_PaymentPage_Assert)
+  - [Transaction\Authorize](index.html#Payment_v1_Transaction_Authorize)
+  - [Transaction\AuthorizeDirect](index.html#Payment_v1_Transaction_AuthorizeDirect)
+  - [Alias\AssertInsert](index.html#Payment_v1_Alias_AssertInsert)
+  - [Alias\InsertDirect](index.html#Payment_v1_Alias_InsertDirect)
+  - [Alias\Update](index.html#Payment_v1_Alias_Update)
+- added masked token PAN and expiry date to `Card` container to the following responses:
+  - [Transaction\Authorize](index.html#Payment_v1_Transaction_Authorize)
+  - [Transaction\AuthorizeDirect](index.html#Payment_v1_Transaction_AuthorizeDirect)
+  - [Transaction\RefundDirect](index.html#Payment_v1_Transaction_RefundDirect)
+  - [Transaction\Refund](index.html#Payment_v1_Transaction_Refund)
+  - [Transactzion\Inquire](index.html#Payment_v1_Transaction_Inquire)
+
 ## <a name="v1.43.0.0.20241112"></a> Version 1.43 (released 2024-11-12)
 - available on Sandbox: 2024-10-29
 - introduced version 1.43
@@ -60,7 +84,7 @@
 - introduced version 1.42
 - added value `1.42` for _SpecVersion_
 - added iDEAL with AccountHolderName to `PaymentMethodsOptions` of [Transaction/Refund](index.html#Payment_v1_Transaction_Refund)
-  
+
 ## <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/ChapterAliasStore.md b/texts/ChapterAliasStore.md
@@ -505,6 +505,20 @@ Id[1..50]<br />
 	<div style="padding-bottom: 10px">Contains general information about the response.</div>
 	<i class="small text-muted">
 			</i>
+</td>
+						</tr>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>Tokenization</strong><br />
+	<span class="text-muted small">
+				
+				<a class="type-details in" href="#Payment_Models_SecureCardData_Tokenization_TokenizationInfo">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">result of external tokenization</div>
+	<i class="small text-muted">
+			</i>
 </td>
 						</tr>
 
@@ -762,6 +776,20 @@ This method may be used to insert an alias directly with card-data collected by
 	<div style="padding-bottom: 10px">Contains general information about the response.</div>
 	<i class="small text-muted">
 			</i>
+</td>
+						</tr>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>Tokenization</strong><br />
+	<span class="text-muted small">
+				
+				<a class="type-details in" href="#Payment_Models_SecureCardData_Tokenization_TokenizationInfo">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">result of external tokenization</div>
+	<i class="small text-muted">
+			</i>
 </td>
 						</tr>
 
@@ -971,6 +999,20 @@ This method may be used to update an alias' lifetime and / or its credit card ex
 	<div style="padding-bottom: 10px">Contains general information about the response.</div>
 	<i class="small text-muted">
 			</i>
+</td>
+						</tr>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>Tokenization</strong><br />
+	<span class="text-muted small">
+				
+				<a class="type-details in" href="#Payment_Models_SecureCardData_Tokenization_TokenizationInfo">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">result of external tokenization</div>
+	<i class="small text-muted">
+			</i>
 </td>
 						</tr>
 
@@ -1146,4 +1188,216 @@ Id[1..40]<br />
 
 
 
+## <a name="Payment_v1_Alias_Inquire"></a>Alias Inquire
+
+<span class="POST request-method">POST</span><br>
+This method can be used to get the latest details of an alias
+
+--->>>
+
+<div class="info"><p><strong>Request URL:</strong></p><p><strong>POST:</strong> /Payment/v1/Alias/Inquire</p></div>
+
+<<<---
+
+#### Request
+
+
+
+
+
+<table class="table">
+			<thead>
+				<tr>
+					<th colspan="2">Arguments</th>
+				</tr>
+			</thead>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>AliasId</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 alias for which you want to receive details.</div>
+	<i class="small text-muted">
+Id[1..40]<br />
+				    <span>Example: <code>alias35nfd9mkzfw0x57iwx</code></span>
+	</i>
+</td>
+						</tr>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>RequestHeader</strong><br />
+	<span class="text-muted small">
+			<span>
+				<span class="text-mandatory">mandatory</span>,
+			</span>
+				
+				<a class="type-details in" href="#Common_RequestHeader">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">General information about the request.</div>
+	<i class="small text-muted">
+			</i>
+</td>
+						</tr>
+
+</table>
+
+
+--->>>
+
+<p>Example:</p>
+<pre class="prettyprint">
+{
+  "RequestHeader": {
+    "SpecVersion": "[current Spec-Version]",
+    "CustomerId": "[your customer id]",
+    "RequestId": "[unique request identifier]",
+    "RetryIndicator": 0
+  },
+  "AliasId": "alias35nfd9mkzfw0x57iwx"
+}
+</pre>
+
+<<<---
+
+
+#### Response
+
+
+
+
+
+<table class="table">
+			<thead>
+				<tr>
+					<th colspan="2">Arguments</th>
+				</tr>
+			</thead>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>Alias</strong><br />
+	<span class="text-muted small">
+			<span>
+				<span class="text-mandatory">mandatory</span>,
+			</span>
+				
+				<a class="type-details in" href="#Payment_Models_Data_AliasInfo">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">Information about the registered alias.</div>
+	<i class="small text-muted">
+			</i>
+</td>
+						</tr>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>CheckResult</strong><br />
+	<span class="text-muted small">
+				
+				<a class="type-details in" href="#Payment_Models_Data_AliasInsertCheckResult">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">Result of the Check</div>
+	<i class="small text-muted">
+			</i>
+</td>
+						</tr>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>PaymentMeans</strong><br />
+	<span class="text-muted small">
+			<span>
+				<span class="text-mandatory">mandatory</span>,
+			</span>
+				
+				<a class="type-details in" href="#Payment_Models_Data_AliasPaymentMeansInfo">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">Information about the registered means of payment</div>
+	<i class="small text-muted">
+			</i>
+</td>
+						</tr>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>ResponseHeader</strong><br />
+	<span class="text-muted small">
+			<span>
+				<span class="text-mandatory">mandatory</span>,
+			</span>
+				
+				<a class="type-details in" href="#Common_ResponseHeader">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">Contains general information about the response.</div>
+	<i class="small text-muted">
+			</i>
+</td>
+						</tr>
+						<tr>
+							<td class="col-sm-4 text-right">
+	<strong>Tokenization</strong><br />
+	<span class="text-muted small">
+				
+				<a class="type-details in" href="#Payment_Models_SecureCardData_Tokenization_TokenizationInfo">object</a>
+	</span>
+</td>
+<td class="col-sm-8">
+	<div style="padding-bottom: 10px">result of external tokenization</div>
+	<i class="small text-muted">
+			</i>
+</td>
+						</tr>
+
+</table>
+
+
+--->>>
+
+<p>Example:</p>
+<pre class="prettyprint">
+{
+  "ResponseHeader": {
+    "SpecVersion": "[current Spec-Version]",
+    "RequestId": "[your request id]"
+  },
+  "Alias": {
+    "Id": "alias35nfd9mkzfw0x57iwx",
+    "Lifetime": 1000
+  },
+  "PaymentMeans": {
+    "Brand": {
+      "PaymentMethod": "VISA",
+      "Name": "VISA Saferpay Test"
+    },
+    "DisplayText": "9123 45xx xxxx 1234",
+    "Card": {
+      "MaskedNumber": "912345xxxxxx1234",
+      "ExpYear": 2015,
+      "ExpMonth": 9,
+      "HolderName": "Max Mustermann",
+      "CountryCode": "CH"
+    }
+  }
+}
+</pre>
+
+<<<---
+
+
+
+
+
+