worldline Direct
Sign up

Target most up-to-date API base URL

We encourage you to always target the most up-to-date API base URL when sending requests to our platform. Have a look at our dedicated guide for a full overview.

To allow you a smooth transition, previous API base URLs remain available until further notice.

Our native SDK helps you communicate with the Client API. It offers:

  • Convenient wrappers for API responses.
  • Handling of all the details concerning the encryption of payment details.
  • Caching of payment product logos and caching of images to offer additional information about payment products.
  • Localisation of various labels and messages.
  • User-friendly formatting of payment data such as card numbers and expiry dates.
  • Validation of input.
  • Checks to determine to which issuer a card number is associated.

Our example app simulates the user interface for the whole payment flow based on the interaction between the app and our platform. Find the source code of the SDK and the example app on GitHub, including installation instructions.

To understand how to use this SDK, have a look at the following documentation:

  • Mobile/Client Integration – familiarise yourself with various concepts.
  • Client API Reference – the SDK wraps the Client API and (among other things) exposes the responses of the webservice calls as objects. Understanding the Client API will help you understand these SDK objects as well.
  • The SDK on GitHub – the SDK contains a working example application which can help you understand how the SDK is best used.
  • This current document will help you understand the global flow when creating payment pages using the SDK.

Once you are all set, read the next chapters on how to prepare and use the SDK.

For development and testing purposes, you can use our API Explorer. It allows you to easily query our Server API. We do not recommend using it on the live environment.

To create payments, you need to integrate the SDK with your project at first. All versions of the SDK are publicly available in our repository. To simplify their use, we have prepared a package below for quick integration.

Gradle

Add a requirement to the SDK to your build.gradle file, where x.y.z is the version number:

dependencies {
    // other dependencies
    implementation 'com.worldline-solutions:sdk-client-android:x.y.z'
}


After the successful integration of the SDK with your project, you can proceed to the process of integration with the entire payment system. The complete payment process consists of these steps:

  1. Initialisation of Session and PaymentContext objects
  2. Receiving possible payment methods
  3. Receiving and displaying payment method details
  4. Validation of provided data
  5. Encryption and transfer of payment data
  6. Finalising transaction

1. Initialise Session and PaymentContext objects

Firstly, you need to create a Session enabling communication between the Server API and the client. Your app must have its own server, acting as an intermediary between our Client and Server API.

Since the customer initiates the payment in their app, the Client application asks the Server application to create a Session. When a Server application receives a request, it can create a Session via Create Session from the Server SDK.

Try our API Explorer to send a CreateSession request.

After configuring and connecting your application to the Server API, you receive a response containing information about the created Session. A typical response looks like this:


{
    "assetUrl": "https://assets.test.cdn.v-psp.com/s2s/515c2c0bd13d5dd4bd42",
    "clientApiUrl": "https://payment.preprod.direct.worldline-solutions.com/",
    "clientSessionId": "68a4b0b183a34016b4b694b97938f75b",
    "customerId": "cf7d7aafd42e4a1cb9e4b0624a5041b1",
    "invalidTokens": []
}

Now pass assetUrl, clientApiUrl, clientSessionId and customerId to the Client application. Once the application receives a response from the Server application with information about the Session, create a local Session object on the Client application side.

Next, create a PaymentContext object. It contains information about the form of payment, currency, country, amount, etc. You will use the PaymentContext and Session objects throughout the payment process.

Each Session has a fixed 3-hour lifespan. If it expires, you need to create a new Session

There are different payment methods available for different PaymentContext objects. If you change any variable, you will have to start the process again. Only the Session can remain the same if the payment is made with the same consumer.

2. Receive possible payment methods

The next step is to get and display the possible payment options. To do so, use the previously created Session and PaymentContext to invoke the GetBasicPaymentItems method which sends GetPaymentProducts to our Server API.

Have a look at the code sample showing how to initialise an instance of PaymentContext class and use it to get the BasicPaymentItems list with the Session object.


Long amountValue = 10.0;
CurrencyCode currencyCode = CurrencyCode.EUR;
AmountOfMoney amountOfMoney = new AmountOfMoney(amountValue, currencyCode);
CountryCode countryCode  = CountryCode.NL;
Boolean isRecurring  = false;

// Create the PaymentContext
PaymentContext paymentContext = new PaymentContext(amountOfMoney, countryCode, isRecurring);

// Create listener for the BasicPaymentItemsAsyncTask callback
OnBasicPaymentItemsCallCompleteListener listener = new OnBasicPaymentItemsCallCompleteListener() {

    @Override
    public void onBasicPaymentItemsCallComplete(BasicPaymentItems basicPaymentItems) {

        if (basicPaymentItems == null) {
            // Indicate that an error has occurred.
        } else {
            // Allow the customer to select a payment product and an optional
            // account on file from the list of payment products
            // represented by paymentProducts.
        }
    }
};

// Get the Android application context, which is used to send device information
// in the request, which in turn is used to determine the validity of certain payment products
Context androidContext = getApplicationContext();

// Do the paymentproducts lookup
session.getBasicPaymentItems(androidContext, paymentContext, listener, false);

3. Receive and display payment method details

Payment items are instances of BasicPaymentProduct. Your app can use these items to create a screen that lists them all. Use our convenient example app as a basis for your own implementation.

If you are fine with the look-and-feel of the example app, you do not need to make any changes. If you only have one payment item, you can skip this screen. However, you might also want to display the AccountOnFile selection.

For some payment products, customers can indicate that they want our platform to store their credentials for recurring payments. We refer to the stored data as an account on file or token. You can reuse this account on file / token for subsequent payments if your customers chose the same payment method.

The list of available payment products that the SDK receives from the Client API also contains the accounts on file for each payment product. Your application can present this list to the user.

Depending on the method chosen by the customer, consider cases of different data flows:



If the user has chosen a native form of payment, you need to use the SDK of the payment provider and handle the response only in the last step to inform the user about the payment status. Read more about native payments in the dedicated chapter.

For payments with a third-party payment provider, you receive data with the redirection address in the payment properties. Redirect your customers in their browser to the third-party payment portal to continue the payment process. After the successful payment, your app needs to handle the redirection to the Client app.

The standard payment process is a card payment. Once your customers have selected a payment item or a stored account on file, the Client SDK can request the necessary information your customers needs to provide for the payment.

An object representing the BasicPaymentItem payment method provides a list of the fields your app needs to render, including displaying hints and validation rules. If your customers select an account on file, information already available can be prefilled in the input fields instead of requesting it from your customers. The prefilled data on behalf of the customer is in line with applicable regulations. Depending on the individual use case, your customers still might have to provide some data (i.e. the CVC).

Use our example app for inspiration to create your screen.

4. Validate provided data

Now your application needs to validate the data your customers enter in your application’s interface. To do so, use the data validation component. The data entry interface must be fully transparent and understandable for your customers. We recommend ToolTips, which have individual fields or display appropriate validation errors. The SDK’s localisation component translates the content into the desired customer’s language.

5. Encrypt and transfer payment data

Based on the collected data, you need to create a PaymentRequest instance. This class has a tokenize property used to indicate whether the app should store the customer’s credentials for recurring payments.
Use the following code sample for payment requests without accounts on file:

PaymentRequest paymentRequest = new PaymentRequest();
paymentRequest.setPaymentProduct(selectedPaymentProduct);
paymentRequest.setTokenize(false);


Alternatively, adapt the code sample by supplying both the account on file and the corresponding payment product:

paymentRequest.setAccountOnFile(selectedAccountOnFile);


Once you configure a payment request, supply the values for the payment product fields. Use the identifiers of the fields, such as "cardNumber” and "cvv" to set the field values for the payment request:

paymentRequest.setValue("cardNumber", "1234567890");
paymentRequest.setValue("cvv", "123");


Now you can validate the payment request. As a result, a list of errors is available. For any validation error, you need to provide feedback to the customer. For more information, read the dedicated chapter.

List validationResult = paymentRequest.validate();
if (validationResult.size() > 0) {
    // Notify the customer that some fields contain invalid data.
} else {
    // The payment request is valid, and can be encrypted and sent to
    // the platform via your server.
}


After the PaymentRequest validation, encrypt the request and send it to your Server application. Have a look at the code sample showing how to use an instance of Session to encrypt a request:


// Get the Android application context
Context androidContext = getApplicationContext();

OnPaymentRequestPreparedListener listener = new OnPaymentRequestPreparedListener() {

    @Override
    public void onPaymentRequestPrepared(PreparedPaymentRequest preparedPaymentRequest) {
        if (preparedPaymentRequest == null ||
            preparedPaymentRequest.getEncryptedFields() == null) {
            // Indicate that an error has occurred.
        } else {
            // Submit the information contained in the encrypted
            // payment request represented by preparedPaymentRequest
            // to our platform via your server.
        }
    }
};

// Encrypts paymentRequest
session.preparePaymentRequest(paymentRequest, androidContext, listener);

See a more detailed description of the encryption process in the dedicated chapter.

6. Finalise transaction

After receiving the encrypted data, pass it to your server application to finalise the payment by sending a CreatePayment request.

The response may require additional actions from the Client specified in the MerchantAction object. In most cases, this involves redirecting the customer to an external party (i.e. for a 3-D Secure check). Once your customers complete this check, our platform processes the actual transaction. Read the Server SDK documentation for more information.

Finally, you have to pass the information to the Client application to display the transaction result to your customers.

Find a full overview of the payment flow in the Mobile/Client Integration guide.

Understand SDK objects

The SDK includes several objects. Choose the object of your interest from the list below to read more about it:

C2sCommunicator

This is the main communication service. You do not use it directly, but only through the Session object. It creates a secure connection with our Client API.

Session

Session is the main component of the SDK. The object:

  • Wraps C2sCommunicator implementing all communication logic with our Client API.
  • Creates proper API requests.
  • Is responsible for converting the responses of the API into plain native objects.
  • Has built-in encryption of native objects describing the payment request in a way our Server API can process it.

Make sure to initialise Session properly to start communication with our Client API. The mandatory properties are:

  • client session identifier
  • customer identifier
  • client-api-url
  • asset-base-url

You will get these parameters using the CreateSession from the Server API endpoint. Refer to the Server SDKs and the Server API to learn more.

The Session class can be initialised using its constructor:


String clientSessionId = "1234";
String customerId = "5678";
String clientApiUrl = "https://clientapi.com";
String assetBaseUrl = "https://asset.com";
boolean environmentIsProduction = false;
String applicationIdentifier = "Example Application/v1";

Session session = new Session(
                                                                    clientSessionId,
                                                                    customerId,
                                                                    clientApiUrl,
                                                                    assetBaseUrl,
                                                                    environmentIsProduction,
                                                                    applicationIdentifier);


Make sure to determine whether the application is running in production and specify the application identifier during the initialisation. An additional parameter specifies the IP address. The IP address and application identifier are used in the Device Metadata when communicating with the Client API.

Properties
  • string clientSessionId: The identifier of the created session.
  • string customerId: The session is based on the customer in the form of the customerId. All Client APIs use this customerId in the URI to identify the customer.
  • string clientApiUrl: The datacentre-specific base URL for Client requests. Pass this value to the Client SDK to make sure that the Client software connects to the right data centre.
  • string assetBaseUrl: The datacentre-specific base URL for assets.
  • string applicationIdentifier: The application identifier.

Device Metadata

The Device Metadata includes the following data:

Properties
  • platformIdentifier: Contains the version and type of the system.
  • appIdentifier: The application identifier provided by the user, otherwise set to "unknown".
  • sdkIdentifier: The Client SDK version.
  • sdkCreator: The name of the Client SDK publisher.
  • screensize: The device screen size.
  • deviceBrand: The device manufacturer.
  • deviceType: The device model.
  • ipAddress: The optional pmeter with public IP address of the device.

PaymentContext

Instances of the PaymentContext class contain the most relevant payment information such as:

  • amountOfMoney
  • currency
  • countryCode
  • isRecurring – an indication of whether the payment is a single payment or a recurring payment.

This object:

  • Takes part the next steps of the transaction.
  • Should remain in the same form after initialisation – you should use the same object through the entire transaction process.

AmountOfMoney

This model contains information about the payment amount. It consists of the amount expressed in the long type and the currency given as currencyCode.

Note that amount includes currency fractions. The object below is equal to 1 EUR.

"amountOfMoney": {
            "amount": 100,
    "currencyCode": "EUR"
        },

PaymentItemCacheKey

An additional model used in the cache mechanism. During a single session, it saves information about an attempt to make a payment with a given payment. In the case of a repeated attempt, the mechanism does not perform another request, but uses the cache instead.

BasicPaymentItem interface

The main interface of BasicPaymentItem is primarily responsible for the identification and easy visual presentation of the payment item. It has:

  • An Id identifier.
  • A DisplayHints list which contains the visual text ad (e.g., a logo or the picture of the card with CVC marked).
  • A distinguishing feature of the payment method (e.g., a logo).
  • Information about related AccountOnFile instances.

BasicPaymentProduct

The main model of a payment product. It contains a list of available payment methods. The customer can select one method from this list. Each instance contains:

  • An identifier.
  • A field indicating the payment method of this product.
  • Two fields that indicate the minimal and maximal amount required to pay with this payment product.
  • A field indicating whether our platform can store the payment data as an account on file for subsequent payments.
  • A field indicating whether the method allows recurring payments.
  • A field indicating whether the payment method uses redirection to a third party.
  • A list of previously saved accounts on file for this payment product.
  • Displays hints to render the BasicPaymentProduct appropriately, containing:
    • An index indicating at which position the payment product belongs in a list of payment products
    • A label
    • A logo

PaymentProduct

It extends the BasicPaymentProduct class and implements the PaymentItem interface that supplements the model with the PaymentProductField list. However, once the customer selects a payment item or an account on file, they must provide additional information (i.e. an address, a bank account number, a credit card number, or an expiry date) to process the actual payment.

Each payment item can have several fields that the customer needs to complete for processing payments. Instances of PaymentProductField represent information about the fields of payment items. Use it to retrieve instances of PaymentProduct:


String paymentProductId = "xyz";

// Get the Android application context
Context androidContext = getApplicationContext();

// Create the PaymentContext
PaymentContext paymentContext = new PaymentContext(amountOfMoney, countryCode, isRecurring);

PaymentProductCallListener paymentProductCallListener  = new PaymentProductCallListener() {

	@Override public void onPaymentProductCallComplete(PaymentProduct paymentProduct) {
		// Create a payment request using the payment product represented by paymentProduct.
    }
	
	@Override public void onPaymentProductCallError(ErrorResponse error) {
		// Indicate that an error has occurred.
    }
};

// Get selected PaymentProduct
session.getPaymentProduct(androidContext, paymentProductId, paymentContext, paymentProductCallListener);


BasicPaymentItemsCallListener basicPaymentItemsCallListener = new BasicPaymentItemsCallListener() {

    @Override public void onBasicPaymentItemsCallComplete(BasicPaymentItems basicPaymentItems) {
    }
	
	@Override public void onBasicPaymentItemsCallError(ErrorResponse error) {
    }
};

// Get all available BasicPaymentItems for paymentContext
session.getBasicPaymentProducts(androidContext, paymentContext, basicPaymentItemsCallListener);

PaymentProductField

It represents fields of payment items. Each field has:

  • An identifier
  • Type
  • A definition of restrictions that apply to the value of the field.
  • Information about how to present the field to the customer in the user interface.

The model has a built-in data validation method used to determine whether a given value is valid for the field. The method is based on DataRestrictions. It returns ValidationErrorMessages and methods for masking and uncasting the value by means of the built-in StringFormatter.

The code snippet below shows how to retrieve the field with the "cvv" identifier from a payment product. In this process, we

  • Inspect the data restrictions of the field to see whether this field is required or optional.
  • Inspect the display hints of the field to see whether the values a customer provides should be obfuscated in a user interface.
  • Validate the value "123".
  • Inspect the number of validation errors to see whether the provided value is valid.
PaymentProductField field = paymentProduct.getPaymentProductFieldById("cvv");
Boolean isRequired = field.getDataRestrictions().isRequired();
Boolean obfuscate  = field.displayHints.isObfuscate();

List errorMessageIds = field.validateValue("123");
Boolean validValue = errorMessageIds.isEmpty();

AccountOnFile

AccountOnFile represents information about an account on file for a certain payment product. It contains:

  • An identifier for the account on file.
  • An identifier for the corresponding payment product.
  • A collection of key-value pairs stored as a part of the account on file.
  • Display hints that contain information about how to render the account on file.
  • A method that produces a label describing the account on file.

Retrieve instances of AccountOnFile as instances of BasicPaymentProduct as follows:

private AccountOnFile GetSelectedAccountOnFile(IBasicPaymentItem paymentItem, string selectedAccountOnFileId)
{
	AccountOnFile accountOnFile = paymentItem.getAccountOnFileById(selectedAccountOnFileId);
	return accountOnFile;
}

DisplayHints

DisplayHints are objects containing hints. There are three types of DisplayHints:

  • DisplayHintsPaymentItem: The most important information about PaymentItem, i.e., a name and a logo. An additional property is displayOrder which indicates the appropriate display order according to the order index in relation to other PaymentItems used by BasicPaymentItems and BasicPaymentProducts. Use them to display the PaymentItem selection list.
  • DisplayHintsAccountOnFile: The list containing the ProductFields key-value pairs and the corresponding mask to apply the mask (e.g. asterisks) to the corresponding value from AccountOnFile.
  • DisplayHintsProductFields: Defines the way of displaying ProductFields. In addition to the name and placeholder, it contains PreferredInputType, based on which you can choose:
    • The appropriate type of keyboard you should use.
    • Whether the element must always be displayed as AlwaysShow.
    • Whether the Obfuscate value should be obfuscated, as well as the value of Mask – a reference to the assigned ToolTip and FormElement.

ToolTips

ToolTips facilitate data entry. You can add a ToolTip object in the display hints for ProductFields. It can contain an explanation text or a graphic, i.e. a photo of a card with an obfuscated CVV.

FormElement

A simplified description of the visual element instructing you to use it appropriately as either text, list, currency, date or boolean.

PaymentRequest

This class wraps the relationship between the selected PaymentProduct, AccountOnFile and the entered values. It allows you to easily extract masked or unmasked values. It contains a method of validating the entered data. Check the dedicated encryption chapter for more information.

PreparedPaymentRequest

The instance of PreparePaymentRequest class is the result of encrypting a request using an instance of Session. It has two properties, encryptedFields and encodedClientMetaInfo – the strings that should be sent to our platform. Check the dedicated encryption chapter for more information.

Responses

  • ApiResponse: Each query is wrapped in a response API containing generic data. In case of any error, in the additional ErrorResponse field, you can find ApiErrorCode and Message describing the error.
  • PublicKeyResponse: Client API you use to retrieve a transaction-specific public key from our server. Use it to encrypt sensitive data, i.e. card details. This object automatically returns an already decrypted public key from our API.

Use additional features

The SDK has a lot more to offer. Have a look at the following features, as they will help you build the perfect solution.

Encrypt sensitive data

One of the biggest assets of the SDK is its encryption tool. It offers great security when transferring sensitive data (i.e. card numbers, expiry date, CVC code). An entire encryption/transfer flow looks like this: