Skip to content

Commit c2f533b

Browse files
rkewlanirkewlani
authored
Merge pull request #100 from Adyen/gh_pages_PW_496
Added documentation for Checkout and Checkout Utility API.
2 parents 2e2eebf + 96e1c41 commit c2f533b

File tree

13 files changed

+968
-3
lines changed

13 files changed

+968
-3
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Add this dependency to your project's POM:
2323
<dependency>
2424
<groupId>com.adyen</groupId>
2525
<artifactId>adyen-java-api-library</artifactId>
26-
<version>1.4.1</version>
26+
<version>1.5.0</version>
2727
</dependency>
2828
```
2929

‎docs/checkout-api.html‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title>Adyen-java-api-library by Adyen</title>
7+
8+
<link rel="stylesheet" href="stylesheets/styles.css">
9+
<link rel="stylesheet" href="stylesheets/github-light.css">
10+
<meta name="viewport" content="width=device-width">
11+
<!--[if lt IE 9]>
12+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13+
<![endif]-->
14+
</head>
15+
<body>
16+
<div class="wrapper">
17+
<header>
18+
<h1>Adyen-java-api-library</h1>
19+
<p>Adyen API Library for Java</p>
20+
21+
<p class="view"><a href="https://github.com/Adyen/adyen-java-api-library">View the Project on GitHub
22+
<small>Adyen/adyen-java-api-library</small>
23+
</a></p>
24+
25+
26+
<ul>
27+
<li><a href="https://github.com/Adyen/adyen-java-api-library/zipball/master">Download <strong>ZIP
28+
File</strong></a></li>
29+
<li><a href="https://github.com/Adyen/adyen-java-api-library/tarball/master">Download <strong>TAR
30+
Ball</strong></a></li>
31+
<li><a href="https://github.com/Adyen/adyen-java-api-library">View On <strong>GitHub</strong></a></li>
32+
</ul>
33+
</header>
34+
<section>
35+
<h1>Checkout API integration</h1>
36+
<p>
37+
The Checkout API service has the following methods:
38+
</p>
39+
<h2><a id="paymentMethods_27"></a>paymentMethods</h2>
40+
<p>Queries the available payment methods for a transaction based on the transaction context (like amount,
41+
country, and currency). Besides giving back a list of the available payment methods, the response also
42+
returns which input details you need to collect from the shopper (to be submitted to <strong>payments(
43+
)</strong>).</p>
44+
<p>Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list
45+
of payment methods, its usage is optional. You can, for example, also cache the <strong>paymentMethods(
46+
)</strong> response and update it once a week.</p>
47+
<pre><code class="language-java">Checkout checkout = <span class="hljs-keyword">new</span> Checkout(client);
48+
PaymentMethodsRequest paymentMethodsRequest = <span class="hljs-keyword">new</span> PaymentMethodsRequest();
49+
paymentMethodsRequest.setMerchantAccount(<span class="hljs-string">"YourMerchantAccount"</span>);
50+
PaymentMethodsResponse response = checkout.paymentMethods(paymentMethodsRequest);
51+
</code></pre>
52+

53+
<h2><a id="payments_0"></a>payments</h2>
54+
<p>Sends payment parameters (like amount, country, and currency) together with the input details collected from
55+
the shopper. The response returns the result of the payment request:</p>
56+
<ul>
57+
<li>For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you’ll get a final state in the
58+
<strong>resultCode</strong> (e.g. <strong>authorised</strong> or <strong>refused</strong>).
59+
</li>
60+
<li>For other payment methods, you’ll receive <strong>redirectShopper</strong> as
61+
<strong>resultCode</strong> together with a <strong>redirectUrl</strong>. In this case, the shopper must
62+
finalize the payment on the page behind the redirectUrl.
63+
</li>
64+
</ul>
65+
<pre><code class="language-java">Checkout checkout = <span class="hljs-keyword">new</span> Checkout(client);
66+
PaymentsRequest paymentsRequest = <span class="hljs-keyword">new</span> PaymentsRequest();
67+
Amount amount = <span class="hljs-keyword">new</span> Amount();
68+
amount.setCurrency(<span class="hljs-string">"USD"</span>);
69+
amount.setValue(<span class="hljs-number">1000L</span>);
70+
paymentsRequest.setReference(<span class="hljs-string">"Your order number"</span>);
71+
paymentsRequest.setAmount(amount);
72+
paymentsRequest.setPaymentMethod(<span class="hljs-keyword">new</span> HashMap&lt;String, String&gt;());
73+
paymentsRequest.putPaymentMethodItem(<span class="hljs-string">"number"</span>, <span class="hljs-string">"4111111111111111"</span>);
74+
paymentsRequest.putPaymentMethodItem(<span class="hljs-string">"type"</span>, <span class="hljs-string">"scheme"</span>);
75+
paymentsRequest.putPaymentMethodItem(<span class="hljs-string">"expiryMonth"</span>, <span
76+
class="hljs-string">"08"</span>);
77+
paymentsRequest.putPaymentMethodItem(<span class="hljs-string">"expiryYear"</span>, <span
78+
class="hljs-string">"2018"</span>);
79+
paymentsRequest.putPaymentMethodItem(<span class="hljs-string">"holderName"</span>, <span class="hljs-string">"John Smith"</span>);
80+
paymentsRequest.putPaymentMethodItem(<span class="hljs-string">"cvc"</span>, <span class="hljs-string">"737"</span>);
81+
paymentsRequest.setReturnUrl(<span class="hljs-string">"https://your-company.com/..."</span>);
82+
paymentsRequest.setMerchantAccount(<span class="hljs-string">"YOUR_MERCHANT_ACCOUNT"</span>);
83+
PaymentsResponse paymentResponse = checkout.payments(paymentsRequest);
84+
</code></pre>
85+
86+
<h2><a id="paymentsDetails_37"></a>payments/details</h2>
87+
<p>Submits details for a payment created using <strong>payments( )</strong>. This step is only needed when no
88+
final state has been reached on the <strong>payments( )</strong> request (for example for 3D Secure, or when
89+
getting redirected back directly from a payment method using an app switch).</p>
90+
<p>The exact details, which need to be sent to this endpoint, are always specified in the response of the
91+
associated <strong>payments( )</strong> request. When sending in the request to <strong>paymentsDetails(
92+
)</strong>, make sure you send the corresponding paymentData as obtained during the <strong>payments(
93+
)</strong> call.</p>
94+
<p>In addition, the endpoint can be used to verify a <strong>payload</strong>, which is returned after coming
95+
back from the Checkout SDK or any of the redirect based methods on the Checkout API.</p>
96+
<pre><code class="language-java">Checkout checkout = <span class="hljs-keyword">new</span> Checkout(client);
97+
PaymentsDetailsRequest paymentsDetailsRequest = <span class="hljs-keyword">new</span> PaymentsDetailsRequest();
98+
paymentsDetailsRequest.setPaymentData(<span class="hljs-string">"Hee57361f99...."</span>);
99+
HashMap&lt;String, String&gt; details = <span class="hljs-keyword">new</span> HashMap&lt;&gt;();
100+
details.put(<span class="hljs-string">"MD"</span>, <span class="hljs-string">"sdfsdfsdf..."</span>);
101+
details.put(<span class="hljs-string">"PaRes"</span>, <span class="hljs-string">"sdfsdfsdf..."</span>);
102+
paymentsDetailsRequest.setDetails(details);
103+
PaymentsResponse paymentsResponse = checkout.paymentsDetails(paymentsDetailsRequest);
104+
</code></pre>
105+
106+
107+
</section>
108+
<footer>
109+
<p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
110+
<p>
111+
<small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a>
112+
</small>
113+
</p>
114+
</footer>
115+
</div>
116+
<script src="javascripts/scale.fix.js"></script>
117+
118+
</body>
119+
</html>

‎docs/checkout-sdk.html‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title>Adyen-java-api-library by Adyen</title>
7+
8+
<link rel="stylesheet" href="stylesheets/styles.css">
9+
<link rel="stylesheet" href="stylesheets/github-light.css">
10+
<meta name="viewport" content="width=device-width">
11+
<!--[if lt IE 9]>
12+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13+
14+
<![endif]-->
15+
</head>
16+
<body>
17+
<div class="wrapper">
18+
<header>
19+
<h1>Adyen-java-api-library</h1>
20+
<p>Adyen API Library for Java</p>
21+
22+
<p class="view"><a href="https://github.com/Adyen/adyen-java-api-library">View the Project on GitHub
23+
<small>Adyen/adyen-java-api-library</small>
24+
</a></p>
25+
26+
27+
<ul>
28+
<li><a href="https://github.com/Adyen/adyen-java-api-library/zipball/master">Download <strong>ZIP
29+
File</strong></a></li>
30+
<li><a href="https://github.com/Adyen/adyen-java-api-library/tarball/master">Download <strong>TAR
31+
Ball</strong></a></li>
32+
<li><a href="https://github.com/Adyen/adyen-java-api-library">View On <strong>GitHub</strong></a></li>
33+
</ul>
34+
</header>
35+
<section>
36+
<h1>Checkout SDK integration</h1>
37+
<p>
38+
The Checkout SDK service has the following methods:
39+
</p>
40+
<h2><a id="paymentSession_54"></a>paymentSession</h2>
41+
<p>Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.</p>
42+
<pre><code class="language-java">Checkout checkout = <span class="hljs-keyword">new</span> Checkout(client);
43+
PaymentSessionRequest paymentSessionRequest = <span class="hljs-keyword">new</span> PaymentSessionRequest();
44+
paymentSessionRequest.setAmount(createAmountObject(<span class="hljs-string">"EUR"</span>, <span class="hljs-number">17408L</span>));
45+
paymentSessionRequest.setReference(<span class="hljs-string">"Your order number"</span>);
46+
paymentSessionRequest.returnUrl(<span class="hljs-string">"https://www.yourshop.com/checkout/result"</span>);
47+
paymentSessionRequest.merchantAccount(<span class="hljs-string">"YOUR_MERCHANT_ACCOUNT"</span>);
48+
paymentSessionRequest.setCountryCode(<span class="hljs-string">"NL"</span>);
49+
paymentSessionRequest.setSdkVersion(<span class="hljs-string">"1.3.0"</span>);
50+
PaymentSessionResponse paymentSessionResponse = checkout.paymentSession(paymentSessionRequest);
51+
</code></pre>
52+
<h2><a id="paymentsresult_67"></a>payments/result</h2>
53+
<p>Verifies the payment result using the payload returned from the Checkout SDK.</p>
54+
<pre><code class="language-java">Checkout checkout = <span class="hljs-keyword">new</span> Checkout(client);
55+
PaymentResultRequest paymentResultRequest = <span class="hljs-keyword">new</span> PaymentResultRequest();
56+
paymentResultRequest.setPayload(<span class="hljs-string">"This is a test payload"</span>);
57+
PaymentResultResponse paymentResultResponse = checkout.paymentResult(paymentResultRequest);
58+
</code></pre>
59+
60+
</section>
61+
<footer>
62+
<p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
63+
<p>
64+
<small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a>
65+
</small>
66+
</p>
67+
</footer>
68+
</div>
69+
<script src="javascripts/scale.fix.js"></script>
70+
71+
</body>
72+
</html>

‎docs/checkout-util.html‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title>Adyen-java-api-library by Adyen</title>
7+
8+
<link rel="stylesheet" href="stylesheets/styles.css">
9+
<link rel="stylesheet" href="stylesheets/github-light.css">
10+
<meta name="viewport" content="width=device-width">
11+
<!--[if lt IE 9]>
12+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13+
<![endif]-->
14+
</head>
15+
<body>
16+
<div class="wrapper">
17+
<header>
18+
<h1>Adyen-java-api-library</h1>
19+
<p>Adyen API Library for Java</p>
20+
21+
<p class="view"><a href="https://github.com/Adyen/adyen-java-api-library">View the Project on GitHub
22+
<small>Adyen/adyen-java-api-library</small>
23+
</a></p>
24+
25+
26+
<ul>
27+
<li><a href="https://github.com/Adyen/adyen-java-api-library/zipball/master">Download <strong>ZIP
28+
File</strong></a></li>
29+
<li><a href="https://github.com/Adyen/adyen-java-api-library/tarball/master">Download <strong>TAR
30+
Ball</strong></a></li>
31+
<li><a href="https://github.com/Adyen/adyen-java-api-library">View On <strong>GitHub</strong></a></li>
32+
</ul>
33+
</header>
34+
<section>
35+
<h1>Checkout Utility Service</h1>
36+
<p>
37+
The Checkout Utility service has the following method:
38+
</p>
39+
<h2>OriginKeys</h2>
40+
<p>
41+
This operation takes the origin domains and returns a JSON object containing the corresponding origin keys
42+
for the domains.
43+
</p>
44+
<pre><code class="language-java">CheckoutUtility checkoutUtility = <span class="hljs-keyword">new</span> CheckoutUtility(client);
45+
OriginKeysRequest originKeysRequest = <span class="hljs-keyword">new</span> OriginKeysRequest();
46+
originKeysRequest.setOriginDomains(<span class="hljs-keyword">new</span> ArrayList&lt;String&gt;(Arrays.asList(<span
47+
class="hljs-string">"https://www.your-domain1.com"</span>, <span class="hljs-string">"https://www.your-domain2.com"</span>)));
48+
OriginKeysResponse originKeysResponse = checkoutUtility.originKeys(originKeysRequest);
49+
</code></pre>
50+
51+
</section>
52+
<footer>
53+
<p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
54+
<p>
55+
<small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a>
56+
</small>
57+
</p>
58+
</footer>
59+
</div>
60+
<script src="javascripts/scale.fix.js"></script>
61+
62+
</body>
63+
</html>

‎docs/images/Adyen_logo_rgb.png‎

2.63 KB
Loading

‎docs/index.html‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title>Adyen-java-api-library by Adyen</title>
7+
8+
<link rel="stylesheet" href="stylesheets/styles.css">
9+
<link rel="stylesheet" href="stylesheets/github-light.css">
10+
<meta name="viewport" content="width=device-width">
11+
<!--[if lt IE 9]>
12+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13+
<![endif]-->
14+
</head>
15+
<body>
16+
<div class="wrapper">
17+
<header>
18+
<h1>Adyen-java-api-library</h1>
19+
<p>Adyen API Library for Java</p>
20+
21+
<p class="view"><a href="https://github.com/Adyen/adyen-java-api-library">View the Project on GitHub
22+
<small>Adyen/adyen-java-api-library</small>
23+
</a></p>
24+
25+
26+
<ul>
27+
<li><a href="https://github.com/Adyen/adyen-java-api-library/zipball/master">Download <strong>ZIP
28+
File</strong></a></li>
29+
<li><a href="https://github.com/Adyen/adyen-java-api-library/tarball/master">Download <strong>TAR
30+
Ball</strong></a></li>
31+
<li><a href="https://github.com/Adyen/adyen-java-api-library">View On <strong>GitHub</strong></a></li>
32+
</ul>
33+
</header>
34+
<section>
35+
<h1><a id="adyen-apis-library-for-java" class="anchor" href="#adyen-apis-library-for-java"
36+
aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Adyen API Library for
37+
Java</h1>
38+
<p>
39+
This manual describes API communication to the Adyen payment system using this API library for Java.
40+
You will get familiar with the following concepts and scenarios:
41+
</p>
42+
<ul>
43+
<li><a title="Install the library" href="install-library.html">Install the library</a></li>
44+
<li><a title="Using the library" href="using-library.html">Using the library</a></li>
45+
</ul>
46+
<h2>DISCLAIMER</h2>
47+
<p>The ownership of the content of the Adyen API Library remains with Adyen. The content of the Adyen API
48+
Library may only be used in connection with the services of Adyen and subject to the applicable license
49+
(Apache License, Version 2.0, the “License”), a copy of which is included in the library. Unless required by
50+
applicable law or agreed to in writing, the library is offered and/or distributed on an "AS IS" BASIS,
51+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Adyen does not warrant that the
52+
library or any content will be available uninterrupted or error free, that defects will be corrected, or
53+
that the library or its supporting systems are free of viruses or bugs. Please refer to the License for the
54+
specific language governing permissions and limitations under the License.</p>
55+
</section>
56+
<footer>
57+
<p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
58+
<p>
59+
<small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a>
60+
</small>
61+
</p>
62+
</footer>
63+
</div>
64+
<script src="javascripts/scale.fix.js"></script>
65+
66+
</body>
67+
</html>

0 commit comments

Comments
 (0)