Java integration for Adyen Payment System API

Adyen

is the leading technology provider powering payments for global commerce in the 21st century. With a seamless solution for mobile, online and in-store transactions, our technology enables merchants to accept almost any type of payment, anywhere in the world.

Adyen Payment System, APS, lies at the heart of its payment platform and it's the service a merchant integrates with for payment processing.

adyen-api aims to be a cohesive and opinionated way for consuming APS' JSON messaging based services.

Acknowledgements

• Chrischy - Proxy configuration and CSE
• Cleverbug - Upgrade to consume Adyen's endpoints V18

Milestones

• 2.30.0cts - instituted CTS-local version of woki project, updated for v30 and recurringProcessingModel. This branch is not intended as a source for pulling code back to woki, but rather for creating local artifacts. See details in PAYMENT-704.
• 2.25.1 - Fixed URIs for v25.
• 2.25.0 - Updated to cover Adyen's endpoints new version, v25.
• 2.18.1 - Bug fixes; code rationalizations; tests correctness; replaced boon's JSON ObjectMapper w/ Jackson's to properly handle atypical collections in the response.
• 2.18.0 - Added full support for recurring resources.
• 1.3.1 - Updated to cover Adyen's endpoints new version, v18; changes were across Card, BankAccount and PaymentRequest types.
• 1.3.0 - Added support for CSE.
• 1.2.1 - Added support for proxy configuration.
• 1.0.0 - Initial.

From version 2.* on the minor version number is used to show what Adyen's API version adyen-api is compliant with. For example, 2.25.0 relates to the first release covering Adyen's V25 and so on.

Current version and Maven dependency

    <dependency>
      <groupId>com.github.woki</groupId>
      <artifactId>payments-adyen-api</artifactId>
      <version>2.25.1</version>
    </dependency>

See also this Sample Client sample built upon ayden-api. It takes an authorization or modification request in YAML format and communicates with APS.

Usage

Client instantiation

   Client client = Client
      .endpoint("https://pal-test.adyen.com")
      // .endpoint(APUtil.TEST_ENDPOINT)
      // .endpoint("https://pal-live.adyen.com")
      // .endpoint(APUtil.LIVE_ENDPOINT)
      .credentials(username, password)
      .build();

In case you are behind a proxy just add .proxyConfig() to the composition, as follows

   Client client = Client
      .endpoint("https://pal-test.adyen.com")
      .credentials(username, password)
      .proxyConfig("prxyusr:prxypass@prxysrvr:8888")
      .build();

Notice that authentication is optional. For the example above the proxy configuration descriptor would then be like this: prxysrvr:8888. Either names or IP addresses can be used as the host name.

CSE - Client Side Encryption

For Adyen's CSE documentation and usage refer to CSE Documentation. Once you have generated a RSA public key just instantiate the Client like this:

   Client client = Client
      .endpoint("https://pal-test.adyen.com")
      .credentials(username, password)
      .encryptionKey("10001|FBF867B24626DE756...") // key abbreviated for clarity sake
      .build();

The Client will encrypt sensitive card information according to CSE specifications in case there's an encryption key defined.

Authorisation

   PaymentRequest request = PaymentRequestBuilder
      .merchantAccount(merchantAccount)
      .amount(new Amount(Currency.getInstance("EUR"), 1000L))
      .card(CardBuilder.number("4111111111111111").cvc("737").expiry(2016, 6).holder("Johnny Tester Visa").build())
      .reference(reference(ReferenceType.UUID))
      .shopper(NameBuilder.first("Willian").last("Oki").build(), "willian.oki@gmail.com", "127.0.0.1",
          "Test/DAPI/Authorisation/Willian Oki", ShopperInteraction.Ecommerce)
      .build();
   PaymentResponse response = client.authorise(request);
   
   // you can check if response is valid using response.isOk()

Capture

   ModificationRequest captureRequest = ModificationRequestBuilder
      .merchantAccount(merchantAccount)
      .modificationAmount(new Amount(Currency.getInstance("EUR"), 1000L))
      .originalReference(paymentResponse.getPspReference())
      .reference(reference(ReferenceType.UUID))
      .build();
   ModificationResponse captureResponse = client.capture(captureRequest);
   
   // you can check if response is valid using response.isOk()

Cancel/Refund

   ModificationRequest cancelRequest = ModificationRequestBuilder
      .merchantAccount(merchantAccount)
      .originalReference(paymentResponse.getPspReference())
      .reference(reference(ReferenceType.UUID))
      .build();
   ModificationResponse cancelResponse = client.cancel(cancelRequest);
   
   // you can check if response is valid using response.isOk()

   ModificationRequest refundRequest = ModificationRequestBuilder
      .merchantAccount(merchantAccount)
      .modificationAmount(new Amount(Currency.getInstance("EUR"), 1000L))
      .originalReference(paymentResponse.getPspReference())
      .reference(reference(ReferenceType.UUID))
      .build();
   ModificationResponse refundResponse = client.refund(refundRequest);
   
   // you can check if response is valid using response.isOk()

   ModificationRequest cancelOrRefundRequest = ModificationRequestBuilder
       .merchantAccount(merchantAccount)
       .originalReference(paymentResponse.getPspReference())
       .reference(reference(ReferenceType.UUID))
       .build();
   ModificationResponse cancelOrRefundResponse = client.cancelOrRefund(cancelOrRefundRequest);
   
   // you can check if response is valid using response.isOk()

Recurring

List Details

   // possible ContractType: ONECLICK, RECURRING, PAYOUT
   RecurringListDetailsRequest req = new RecurringListDetailsRequest("yourMerchantAccount", ContractType.ONECLICK,
        "yourShopperReference");
   RecurringListDetailsResponse res = client.recurringListDetails(req);
   
   // you can check if response is valid using response.isOk()
   
   // ...

Disable

   RecurringDisableRequest req = new RecurringDisableRequest("yourContract", "yourMerchantAccount",
                "yourRecurringDetailReference", "yourShopperReference");
   RecurringDisableResponse res = client.recurringDisable(req);
   
   // you can check if response is valid using response.isOk()
   
   // ...