Updated "RECURRING_CONTRACT" eventCode in webhook controller (#100)

* Updated "RECURRING_CONTRACT" eventCode in webhook controller * Updated readme to include setting up the "RECURRING_CONTRACT" eventCode * Run workflow once on push vs. pull request * Upgrade dependencies to latest versions --------- Co-authored-by: Kwok He Chu <>
adyen-examples · Jun 26, 2023 · a4a7dad · a4a7dad
1 parent e9e7231
commit a4a7dad
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 12 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,6 +2,7 @@ name: Java CI with Gradle
 
 on:
   push:
+    branches: [ main ]
   pull_request:
     branches: [ main ]
 

diff --git a/.gitignore b/.gitignore
@@ -41,3 +41,6 @@ env.tmp
 .terraform*
 terraform.tfstate*
 terraform.tfvars
+
+### Visual Studio ###
+.vs
diff --git a/checkout-example/build.gradle b/checkout-example/build.gradle
@@ -1,5 +1,5 @@
 plugins {
-	id 'org.springframework.boot' version '3.0.6'
+	id 'org.springframework.boot' version '3.1.0'
 	id 'io.spring.dependency-management' version '1.1.0'
 	id 'java'
 }
@@ -18,7 +18,7 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 	implementation 'nz.net.ultraq.thymeleaf:thymeleaf-layout-dialect'
-	implementation 'com.adyen:adyen-java-api-library:20.0.0'
+	implementation 'com.adyen:adyen-java-api-library:20.1.0'
 	developmentOnly 'org.springframework.boot:spring-boot-devtools'
 	testImplementation('org.springframework.boot:spring-boot-starter-test') {
 		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'

diff --git a/giftcard-example/build.gradle b/giftcard-example/build.gradle
@@ -1,5 +1,5 @@
 plugins {
-	id 'org.springframework.boot' version '3.0.6'
+	id 'org.springframework.boot' version '3.1.0'
 	id 'io.spring.dependency-management' version '1.1.0'
 	id 'java'
 }
@@ -18,7 +18,7 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 	implementation 'nz.net.ultraq.thymeleaf:thymeleaf-layout-dialect'
-	implementation 'com.adyen:adyen-java-api-library:20.0.0'
+	implementation 'com.adyen:adyen-java-api-library:20.1.0'
 	developmentOnly 'org.springframework.boot:spring-boot-devtools'
 	testImplementation('org.springframework.boot:spring-boot-starter-test') {
 		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'

diff --git a/paybylink-example/build.gradle b/paybylink-example/build.gradle
@@ -1,6 +1,6 @@
 plugins {
     id 'java'
-    id 'org.springframework.boot' version '3.0.6'
+    id 'org.springframework.boot' version '3.1.0'
     id 'io.spring.dependency-management' version '1.1.0'
     id "com.moowork.node" version "1.3.1"
 }
@@ -16,7 +16,7 @@ repositories {
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-web'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
-    implementation 'com.adyen:adyen-java-api-library:20.0.0'
+    implementation 'com.adyen:adyen-java-api-library:20.1.0'
 
 }
 

diff --git a/subscription-example/README.md b/subscription-example/README.md
@@ -40,7 +40,9 @@ This demo provides a simple webhook integration at `/api/webhooks/notifications`
     - Define username and password (Basic Authentication) to [protect your endpoint](https://docs.adyen.com/development-resources/webhooks/best-practices#security) - Basic authentication only guarantees that the notification was sent by Adyen, not that it wasn't modified during transmission
     - Generate the [HMAC Key](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures) and set the `ADYEN_HMAC_KEY` in your [Gitpod Environment Variables](https://gitpod.io/variables) with a scope of `*/*` -  This key is used to [verify](https://docs.adyen.com/development-resources/webhooks/best-practices#security) whether the HMAC signature that is included in the notification, was sent by Adyen and not modified during transmission
     - For the URL, enter `https://gitpod.io` for now, we will need to update this webhook URL in step 7
-    - Make sure the webhook is **Enabled** to send notifications
+    - Make sure that the `Recurring contract` setting is **enabled** on `Merchant` account-level - In the `Customer Area`, under `Developers` -> `Webhooks` -> `Settings` -> Enable `Recurring contract` on `Merchant`-level and hit "Save".
+    - Make sure that your webhook sends the `RECURRING_CONTRACT` event when you've created the webhook
+    - Make sure the webhook is **enabled** to send notifications
 
 
 5. In the Customer Area, go to `Developers` → `Additional Settings` → Under `Payment` enable `Recurring Details` for subscriptions.
@@ -103,7 +105,9 @@ If you use a tunneling service like ngrok, the webhook URL will be the generated
     - Generate the [HMAC Key](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures) - This key is used to [verify](https://docs.adyen.com/development-resources/webhooks/best-practices#security) whether the HMAC signature that is included in the notification, was sent by Adyen and not modified during transmission
     - See script below that allows you to easily set your environmental variables
     - For the URL, enter `https://ngrok.io` for now - We will need to update this webhook URL in step 10
-    - Make sure the webhook is **Enabled** to send notifications
+    - Make sure that the `Recurring contract` setting is **enabled** on `Merchant` account-level - In the `Customer Area`, under `Developers` -> `Webhooks` -> `Settings` -> Enable `Recurring contract` on `Merchant`-level and hit "Save".
+    - Make sure that your webhook sends the `RECURRING_CONTRACT` event when you've created the webhook
+    - Make sure the webhook is **enabled** to send notifications
 
 
 7. Set the following environment variables in your terminal environment: `ADYEN_API_KEY`, `ADYEN_CLIENT_KEY`, `ADYEN_MERCHANT_ACCOUNT` and `ADYEN_HMAC_KEY`. Note that some IDEs will have to be restarted for environmental variables to be injected properly.

diff --git a/subscription-example/build.gradle b/subscription-example/build.gradle
@@ -1,5 +1,5 @@
 plugins {
-	id 'org.springframework.boot' version '3.0.6'
+	id 'org.springframework.boot' version '3.1.0'
 	id 'io.spring.dependency-management' version '1.1.0'
 	id 'java'
 }
@@ -18,7 +18,7 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 	implementation 'nz.net.ultraq.thymeleaf:thymeleaf-layout-dialect'
-	implementation 'com.adyen:adyen-java-api-library:20.0.0'
+	implementation 'com.adyen:adyen-java-api-library:20.1.0'
 	developmentOnly 'org.springframework.boot:spring-boot-devtools'
 	testImplementation('org.springframework.boot:spring-boot-starter-test') {
 		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'

diff --git a/subscription-example/src/main/java/com/adyen/checkout/api/WebhookResource.java b/subscription-example/src/main/java/com/adyen/checkout/api/WebhookResource.java
@@ -66,8 +66,8 @@ public ResponseEntity<String> webhooks(@RequestBody String json) throws IOExcept
 
                 // consume payload
                 if(item.isSuccess()) {
-
-                    if (item.getEventCode().equals("AUTHORISATION") && item.getAdditionalData() != null && item.getAdditionalData().get("recurring.shopperReference") != null) {
+                    // read about eventcode "RECURRING_CONTRACT" here: https://docs.adyen.com/online-payments/tokenization/create-and-use-tokens?tab=subscriptions_2#pending-and-refusal-result-codes-1
+                    if (item.getEventCode().equals("RECURRING_CONTRACT") && item.getAdditionalData() != null && item.getAdditionalData().get("recurring.shopperReference") != null) {
                         // webhook with recurring token
                         log.info("Recurring authorized - recurringDetailReference {}", item.getAdditionalData().get("recurring.recurringDetailReference"));