New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

com.worldline.sips:payment-sdk-common

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

com.worldline.sips:payment-sdk-common

This library simplifies the use of SIPS 2.0, the Worldline e-payments API

  • 1.4.3
  • Source
  • Maven
  • Socket score

Version published
Maintainers
1
Source

SIPS Payment SDK Maven Central

This package provides a JAVA implementation for SIPS, a Worldline e-payments gateway.

:warning: This library was written for SIPS 2.0 and is not compatible with SIPS 1.0

Before you begin

This package contains a basic connector for SIPS, based on the SIPS Paypage JSON API. Please refer to the documentation for a better understanding.

If you find field or functionality is missing, feel free to submit a PR or create an issue.

Installing

using Gradle


dependencies {
    implementation 'com.worldline.sips:payment-sdk:1.4.3'
}

using Maven

<dependency>
    <groupId>com.worldline.sips</groupId>
    <artifactId>payment-sdk</artifactId>
    <version>1.4.3</version>
</dependency>

Usage

:bulb: Currently this library only supports SIPS in pay page mode.

Initialization

First, create a client for the desired environment using your merchant ID, key version & secret key:

PaypageClient paypageClient = new PaypageClient(
        Environment.TEST, 
        "002001000000002", 
        1, // This shouldn't be hardcoded here...
        "002001000000002_KEY1"); // ...and neither should this.

:bulb: Merchant data for SIPS TEST can be found in the documentation.

Then set up a request to initialize a session on the SIPS server:

PaymentRequest paymentRequest = new PaymentRequest();
paymentRequest.setAmount(2);
paymentRequest.setCurrencyCode(Currency.EUR);
paymentRequest.setOrderChannel(OrderChannel.INTERNET);

Add unique reference for the transaction:

paymentRequest.setTransactionReference("My awesome transaction reference");

And initialize your session on the server:

InitalizationResponse initializationResponse = paypageClient.initialize(paymentRequest);

The initializationResponse you'll receive from the server contains all information needed to continue handling your transaction. If your initialization was successful, your response will contain a RedirectionStatusCode.TRANSACTION_INITIALIZED.

Making the payment

In case your initialization was successful, you have to use the redirectionUrl received to perform a POST request with both the redirectionData and seal as parameters. Since this should redirect the customer the SIPS payment page, the cleanest example is a simple HTML form:

<form method="post" action="redirectionUrl">
    <input name="redirectionData" type="hidden" value="..." />
    <input name="seal" type="hidden" value="..." />
    <input type="submit" value="Proceed to checkout"/>
</form>

Verifying the payment

When your customer is done, he will be able to return to your application. This is done via a form, making a POST request to the normalReturnUrl provided during the initialization of your payment. This POST request contains details on the payment. You can simply decode these responses, providing a Map<String, String> of the parameters included in the received request to your PaypageClient:

PaypageResponse paypageResponse = paypageClient.decodeResponse(mappedRequestParameters);

:warning: Since the customer is not always redirecting back (e.g. he closes the confirmation page), it's a good practice to include an automaticResponseUrl. SIPS will always POST details on the transaction on this URL, even if a customer doesn't redirect back to your application.

FAQs

Package last updated on 19 Jan 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc