Skip to content

added idempotency key instructions. #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 29, 2018
Merged

added idempotency key instructions. #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/checkout-api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,17 @@ <h2><a id="payments_0"></a>payments</h2>
paymentsRequest.putPaymentMethodItem(<span class="hljs-string">"holderName"</span>, <span class="hljs-string">"John Smith"</span>);
paymentsRequest.putPaymentMethodItem(<span class="hljs-string">"cvc"</span>, <span class="hljs-string">"737"</span>);
paymentsRequest.setReturnUrl(<span class="hljs-string">"https://your-company.com/..."</span>);
paymentsRequest.setMerchantAccount(<span class="hljs-string">"YOUR_MERCHANT_ACCOUNT"</span>);
PaymentsResponse paymentResponse = checkout.payments(paymentsRequest);
paymentsRequest.setMerchantAccount(<span class="hljs-string">"YOUR_MERCHANT_ACCOUNT"</span>);</code></pre>
This Adyen API supports idempotency. To enable idempotent behavior on this request call, you need
to supply a RequestOptions object with idempotencyKey. In following example,&nbsp;<code class="language-java">"IDEMPOTENCY
KEY FOR THIS REQUEST"</code> is a unique identifer for the message with a maximum 64 characters (we recommend a
UUID).
<p/>
<pre><code class="language-java">RequestOptions requestOptions = <span class="hljs-keyword">new</span> RequestOptions();<br/>requestOptions.setIdempotencyKey(<span
class="hljs-string">"IDEMPOTENCY KEY FOR THIS REQUEST"</span>);<br/>PaymentsResponse paymentResponse = checkout.payments(paymentsRequest, requestOptions); </code></pre>
If you don't want to use idempotencyKey, simply send paymentRequest as shown in following example:
<p/>
<pre><code class="language-java">PaymentsResponse paymentResponse = checkout.payments(paymentsRequest);
</code></pre>

<h2><a id="paymentsDetails_37"></a>payments/details</h2>
Expand Down
18 changes: 15 additions & 3 deletions docs/checkout-sdk.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,29 @@ <h1>Checkout SDK integration</h1>
The Checkout SDK service has the following methods:
</p>
<h2><a id="paymentSession_54"></a>paymentSession</h2>
<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>
<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>
<pre><code class="language-java">Checkout checkout = <span class="hljs-keyword">new</span> Checkout(client);
PaymentSessionRequest paymentSessionRequest = <span class="hljs-keyword">new</span> PaymentSessionRequest();
paymentSessionRequest.setAmount(createAmountObject(<span class="hljs-string">"EUR"</span>, <span class="hljs-number">17408L</span>));
paymentSessionRequest.setReference(<span class="hljs-string">"Your order number"</span>);
paymentSessionRequest.returnUrl(<span class="hljs-string">"https://www.yourshop.com/checkout/result"</span>);
paymentSessionRequest.merchantAccount(<span class="hljs-string">"YOUR_MERCHANT_ACCOUNT"</span>);
paymentSessionRequest.setCountryCode(<span class="hljs-string">"NL"</span>);
paymentSessionRequest.setSdkVersion(<span class="hljs-string">"1.3.0"</span>);
PaymentSessionResponse paymentSessionResponse = checkout.paymentSession(paymentSessionRequest);
paymentSessionRequest.setSdkVersion(<span class="hljs-string">"1.3.0"</span>);</code></pre>
This Adyen API supports idempotency. To enable idempotent behavior on this request call, you need
to supply a RequestOptions object with idempotencyKey. In following example,&nbsp;<code class="language-java">"IDEMPOTENCY
KEY FOR THIS REQUEST"</code> is a unique identifer for the message with a maximum 64 characters (we recommend a
UUID).
<p/>
<pre><code class="language-java">RequestOptions requestOptions = <span class="hljs-keyword">new</span> RequestOptions();<br/>requestOptions.setIdempotencyKey(<span
class="hljs-string">"IDEMPOTENCY KEY FOR THIS REQUEST"</span>);<br/>PaymentSessionResponse paymentSessionResponse = checkout.paymentSession(paymentSessionRequest, requestOptions);</code></pre>
If you don't want to use idempotencyKey, simply send paymentRequest as shown in following example:
<p/>
<pre><code class="language-java">PaymentSessionResponse paymentSessionResponse = checkout.paymentSession(paymentSessionRequest);
</code></pre>
</code></pre>
<h2><a id="paymentsresult_67"></a>payments/result</h2>
<p>Verifies the payment result using the payload returned from the Checkout SDK.</p>
<pre><code class="language-java">Checkout checkout = <span class="hljs-keyword">new</span> Checkout(client);
Expand Down