Push Version API-Spec 1.40

saferpay · May 7, 2024 · 1f9a6b3 · 1f9a6b3
1 parent 5ca1d09
commit 1f9a6b3
Show file tree

Hide file tree

Showing 7 changed files with 283 additions and 63 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.39"
+        run: libs/GitHubPagesGenerator.exe -i "${{ github.workspace }}" -s "${{ github.workspace }}/Sitemap.json" -c "${{ github.workspace }}" -o _gh_pages -t "JSON API Spec-Version 1.40"
 
       - name: push updated gh pages
         uses: s0/git-publish-subdir-action@develop

diff --git a/README.md b/README.md
@@ -8,7 +8,8 @@ To learn more about Saferpay please check www.saferpay.com.
 
 ### Versions
 
-* [Spec version 1.39 (latest)](https://saferpay.github.io/jsonapi)
+* [Spec version 1.40 (latest)](https://saferpay.github.io/jsonapi)
+* [Spec version 1.39 ](https://saferpay.github.io/jsonapi/1.39)
 * [Spec version 1.38](https://saferpay.github.io/jsonapi/1.38)
 * [Spec version 1.37](https://saferpay.github.io/jsonapi/1.37)
 * [Spec version 1.36](https://saferpay.github.io/jsonapi/1.36)

diff --git a/texts/05_Integration.md b/texts/05_Integration.md
@@ -157,7 +157,7 @@ public static JsonObject sendRequest(URL sfpUrl, JsonObject request, String sfpL
 //This is an EXAMPLE of the payload-Array.
 $payload = array(
     'RequestHeader' => array(
-        'SpecVersion' => "1.7",
+        'SpecVersion' => "[current Spec-Version]",
         'CustomerId' => "[YOUR CUSTOMERID]",
         'RequestId' => "aScdFewDSRFrfas2wsad3",
         'RetryIndicator' => 0,
@@ -181,14 +181,14 @@ $payload = array(
         'IpAddress' => "192.168.178.1",
         'LanguageCode' => "en"
     ),
-    'ReturnUrls' => array(
-        'Success' => "https://myshop.com/success",
-        'Fail' => "https://myshop.com/fail"
+    'ReturnUrl' => array(
+        'Url' => "[your shop payment url]"
     ),
     'Notification' => array(
-        'PayerEmail' => "payee@mailcom",
-        'MerchantEmail' => "merchant@mail.com",
-        'NotifyUrl' => "https://myshop/callback"
+        'PayerEmail' => "payee@mail.com",
+        'MerchantEmails' => array("merchant@mail.com"),
+        'SuccessNotifyUrl' => "[your success notify url]",
+        'FailNotifyUrl' => "[your fail notify url]"
     ),
     'DeliveryAddressForm' => array(
         'Display' => true,

diff --git a/texts/ChapterAliasStore.md b/texts/ChapterAliasStore.md
@@ -75,7 +75,7 @@ This function may be used to insert an alias without knowledge about the card de
 <td class="col-sm-8">
 	<div style="padding-bottom: 10px">Type of payment means to register</div>
 	<i class="small text-muted">
-Possible values: CARD, BANK_ACCOUNT, POSTFINANCE, TWINT.<br />
+Possible values: CARD, BANK_ACCOUNT, POSTFINANCEPAY, TWINT.<br />
 				    <span>Example: <code>CARD</code></span>
 	</i>
 </td>
@@ -102,7 +102,7 @@ Possible values: CARD, BANK_ACCOUNT, POSTFINANCE, TWINT.<br />
 	<strong>Styling</strong><br />
 	<span class="text-muted small">
 				
-				<a class="type-details in" href="#Payment_Models_Data_ExtendedStyling">object</a>
+				<a class="type-details in" href="#Payment_Models_Data_HostedFormStyling">object</a>
 	</span>
 </td>
 <td class="col-sm-8">
@@ -149,7 +149,7 @@ Possible values: CARD, BANK_ACCOUNT, POSTFINANCE, TWINT.<br />
 <td class="col-sm-8">
 	<div style="padding-bottom: 10px">Used to restrict the means of payment which are available to the payer</div>
 	<i class="small text-muted">
-Possible values: AMEX, BANCONTACT, BONUS, DINERS, DIRECTDEBIT, JCB, MAESTRO, MASTERCARD, MYONE, VISA. Additional values may be accepted but are ignored.<br />
+Possible values: AMEX, BONUS, DINERS, DIRECTDEBIT, JCB, MAESTRO, MASTERCARD, MYONE, VISA. Additional values may be accepted but are ignored.<br />
 				    <span>Example: <code>[&quot;VISA&quot;, &quot;MASTERCARD&quot;]</code></span>
 	</i>
 </td>

diff --git a/texts/ChapterPaymentPage.md b/texts/ChapterPaymentPage.md
@@ -126,7 +126,7 @@ Numeric[8..8]<br />
 <td class="col-sm-8">
 	<div style="padding-bottom: 10px">Used to restrict the means of payment which are available to the payer for this transaction. If only one payment method id is set, the payment selection step will be skipped.</div>
 	<i class="small text-muted">
-Possible values: ACCOUNTTOACCOUNT, ALIPAY, AMEX, BANCONTACT, BONUS, DINERS, CARD, DIRECTDEBIT, EPRZELEWY, EPS, GIROPAY, IDEAL, INVOICE, JCB, KLARNA, MAESTRO, MASTERCARD, MYONE, PAYCONIQ, PAYDIREKT, PAYPAL, POSTCARD, POSTFINANCE, POSTFINANCEPAY, SOFORT, TWINT, UNIONPAY, VISA, WLCRYPTOPAYMENTS.<br />
+Possible values: ACCOUNTTOACCOUNT, ALIPAY, AMEX, BANCONTACT, BONUS, DINERS, CARD, DIRECTDEBIT, EPRZELEWY, EPS, GIROPAY, IDEAL, INVOICE, JCB, KLARNA, MAESTRO, MASTERCARD, MYONE, PAYCONIQ, PAYDIREKT, PAYPAL, POSTFINANCEPAY, SOFORT, TWINT, UNIONPAY, VISA, WECHATPAY, WLCRYPTOPAYMENTS.<br />
 				    <span>Example: <code>[&quot;VISA&quot;, &quot;MASTERCARD&quot;]</code></span>
 	</i>
 </td>
@@ -169,7 +169,6 @@ Possible values: ACCOUNTTOACCOUNT, ALIPAY, AMEX, BANCONTACT, BONUS, DINERS, CARD
 <td class="col-sm-8">
 	<div style="padding-bottom: 10px">Used to control if wallets should be enabled on the payment selection page.</div>
 	<i class="small text-muted">
-Possible values: APPLEPAY, GOOGLEPAY.<br />
 Possible values: APPLEPAY, GOOGLEPAY.<br />
 				    <span>Example: <code>[&quot;APPLEPAY&quot;]</code></span>
 	</i>

diff --git a/texts/ChapterTransaction.md b/texts/ChapterTransaction.md
@@ -182,7 +182,7 @@ Numeric[8..8]<br />
 	<strong>Styling</strong><br />
 	<span class="text-muted small">
 				
-				<a class="type-details in" href="#Payment_Models_Data_ExtendedStyling">object</a>
+				<a class="type-details in" href="#Payment_Models_Data_HostedFormStyling">object</a>
 	</span>
 </td>
 <td class="col-sm-8">
@@ -682,42 +682,42 @@ Numeric[3..4]<br />
 						</tr>
 						<tr>
 							<td class="col-sm-4 text-right">
-	<strong>FraudPrevention</strong><br />
+	<strong>Liability</strong><br />
 	<span class="text-muted small">
 				
-				<a class="type-details in" href="#Payment_Models_FraudPrevention">object</a>
+				<a class="type-details in" href="#Payment_Models_Data_LiabilityInfo">object</a>
 	</span>
 </td>
 <td class="col-sm-8">
-	<div style="padding-bottom: 10px">Contains details of a performed fraud prevention check</div>
+	<div style="padding-bottom: 10px">LiabilityShift information, replaces ThreeDs Info from API version 1.8</div>
 	<i class="small text-muted">
 			</i>
 </td>
 						</tr>
 						<tr>
 							<td class="col-sm-4 text-right">
-	<strong>Liability</strong><br />
+	<strong>Dcc</strong><br />
 	<span class="text-muted small">
 				
-				<a class="type-details in" href="#Payment_Models_Data_LiabilityInfo">object</a>
+				<a class="type-details in" href="#Payment_Models_Data_DccInfo">object</a>
 	</span>
 </td>
 <td class="col-sm-8">
-	<div style="padding-bottom: 10px">LiabilityShift information, replaces ThreeDs Info from api version 1.8</div>
+	<div style="padding-bottom: 10px">Dcc information, if applicable</div>
 	<i class="small text-muted">
 			</i>
 </td>
 						</tr>
 						<tr>
 							<td class="col-sm-4 text-right">
-	<strong>Dcc</strong><br />
+	<strong>FraudPrevention</strong><br />
 	<span class="text-muted small">
 				
-				<a class="type-details in" href="#Payment_Models_Data_DccInfo">object</a>
+				<a class="type-details in" href="#Payment_Models_FraudPrevention">object</a>
 	</span>
 </td>
 <td class="col-sm-8">
-	<div style="padding-bottom: 10px">Dcc information, if applicable</div>
+	<div style="padding-bottom: 10px">Contains details of a performed fraud prevention check</div>
 	<i class="small text-muted">
 			</i>
 </td>
@@ -860,7 +860,7 @@ Numeric[8..8]<br />
 				<span class="text-mandatory">mandatory</span>,
 			</span>
 				
-				<a class="type-details in" href="#Payment_Models_Data_Payment">object</a>
+				<a class="type-details in" href="#Payment_Models_Data_P2PEnabledPayment">object</a>
 	</span>
 </td>
 <td class="col-sm-8">
@@ -1067,7 +1067,7 @@ Possible values: MERCHANT, PAYER.<br />
 				<span class="text-mandatory">mandatory</span>,
 			</span>
 				
-				<a class="type-details in" href="#Payment_Models_Data_PaymentMeansInfo">object</a>
+				<a class="type-details in" href="#Payment_Models_Data_P2PEnabledPaymentMeansInfo">object</a>
 	</span>
 </td>
 <td class="col-sm-8">
@@ -3071,7 +3071,7 @@ Numeric[8..8]<br />
 				<span class="text-mandatory">mandatory</span>,
 			</span>
 				
-				<a class="type-details in" href="#Payment_Models_Data_PaymentMeansInfo">object</a>
+				<a class="type-details in" href="#Payment_Models_Data_P2PEnabledPaymentMeansInfo">object</a>
 	</span>
 </td>
 <td class="col-sm-8">
@@ -3406,8 +3406,8 @@ Numeric[8..8]<br />
 <td class="col-sm-8">
 	<div style="padding-bottom: 10px">Service provider to be used for this payment</div>
 	<i class="small text-muted">
-Possible values: PAYPAL, POSTCARD, POSTFINANCE.<br />
-				    <span>Example: <code>PAYPAL</code></span>
+Possible values: POSTCARD, POSTFINANCE.<br />
+				    <span>Example: <code>POSTFINANCE</code></span>
 	</i>
 </td>
 						</tr>
@@ -3447,7 +3447,7 @@ Possible values: PAYPAL, POSTCARD, POSTFINANCE.<br />
 	<strong>Styling</strong><br />
 	<span class="text-muted small">
 				
-				<a class="type-details in" href="#Payment_Models_Data_ExtendedStyling">object</a>
+				<a class="type-details in" href="#Payment_Models_Data_HostedFormStyling">object</a>
 	</span>
 </td>
 <td class="col-sm-8">
@@ -3956,7 +3956,7 @@ This method can be used to get the details of a transaction that has been author
 				<span class="text-mandatory">mandatory</span>,
 			</span>
 				
-				<a class="type-details in" href="#Payment_Models_Data_PaymentMeansInfo">object</a>
+				<a class="type-details in" href="#Payment_Models_Data_P2PEnabledPaymentMeansInfo">object</a>
 	</span>
 </td>
 <td class="col-sm-8">