Skip to content

Implement shopper redirect handling in CheckoutResource #569

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
gcatanese merged 1 commit into from
Oct 3, 2025
Merged

Implement shopper redirect handling in CheckoutResource #569

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
57 changes: 52 additions & 5 deletions checkout-example/src/main/java/com/adyen/checkout/api/CheckoutResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
import com.adyen.Client;
import com.adyen.checkout.ApplicationProperty;
import com.adyen.enums.Environment;
import com.adyen.model.checkout.Amount;
import com.adyen.model.checkout.CreateCheckoutSessionRequest;
import com.adyen.model.checkout.CreateCheckoutSessionResponse;
import com.adyen.model.checkout.LineItem;
import com.adyen.model.checkout.*;
import com.adyen.service.checkout.PaymentsApi;
import com.adyen.service.exception.ApiException;
import jakarta.servlet.http.HttpServletRequest;
Expand All @@ -15,6 +12,7 @@
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.view.RedirectView;

import java.io.IOException;
import java.util.Arrays;
Expand Down Expand Up @@ -59,7 +57,8 @@ public ResponseEntity<CreateCheckoutSessionResponse> sessions(@RequestHeader Str
// (optional) set WEB to filter out payment methods available only for this platform
checkoutSession.setChannel(CreateCheckoutSessionRequest.ChannelEnum.WEB);
checkoutSession.setReference(orderRef); // required
checkoutSession.setReturnUrl(request.getScheme() + "://" + host + "/redirect?orderRef=" + orderRef);
checkoutSession.setReturnUrl(request.getScheme() + "://" + host + "/api/handleShopperRedirect"); // Redirect flow

checkoutSession.setAmount(amount);
// set lineItems required for some payment methods (ie Klarna)
checkoutSession.setLineItems(Arrays.asList(
Expand All @@ -71,4 +70,52 @@ public ResponseEntity<CreateCheckoutSessionResponse> sessions(@RequestHeader Str
var response = paymentsApi.sessions(checkoutSession);
return ResponseEntity.ok().body(response);
}

/**
* {@code GET /api/handleShopperRedirect} : Handle redirect during payment. This gets called during the redirect flow, you can specify this in the `returnUrl`-field when constructing the /payments request to Adyen.
*
* @return the {@link RedirectView} with status {@code 302}
* @throws IOException from Adyen API.
* @throws ApiException from Adyen API.
*/
@GetMapping("/handleShopperRedirect")
public RedirectView redirect(@RequestParam(required = false) String payload, @RequestParam(required = false) String redirectResult) throws IOException, ApiException {
// Sends a request to /payments/completionDetails when redirect occurs
PaymentCompletionDetails completionDetails = new PaymentCompletionDetails();
if (redirectResult != null && !redirectResult.isEmpty()) {
// For redirect, you are redirected to an Adyen domain to complete the 3DS2 challenge
// After completing the 3DS2 challenge, you get the redirect result from Adyen in the returnUrl
// We then pass the redirectResult to the /completionDetails call to Adyen.
completionDetails.redirectResult(redirectResult);
} else if (payload != null && !payload.isEmpty()) {
completionDetails.payload(payload);
}

PaymentDetailsRequest detailsRequest = new PaymentDetailsRequest();
detailsRequest.setDetails(completionDetails);

log.info("Sending request to /payments/details {}", detailsRequest);
PaymentDetailsResponse paymentDetailsResponse = paymentsApi.paymentsDetails(detailsRequest);
log.info("Adyen: /payments/details response: {}", paymentDetailsResponse);

// Handle redirect after getting the /payment/completionDetails paymentDetailsResponse
String redirectURL = "/result/";
switch (paymentDetailsResponse.getResultCode()) {
case AUTHORISED:
redirectURL += "success";
break;
case PENDING:
case RECEIVED:
redirectURL += "pending";
break;
case REFUSED:
redirectURL += "failed";
break;
default:
redirectURL += "error";
break;
}
return new RedirectView(redirectURL + "?reason=" + paymentDetailsResponse.getResultCode());
}

}