Ekspres Bank

Document Logs
Change log:

Terms and definitions:

1 - Purpose of Document

This document provides the overall technical details and design of implementing and using the functionality as specified in section 2 - Introduction. This document will not cover implementation details – for this the code base should be inspected.

2 - Introduction to Functionality

Ekspres bank is a company that can help finance a purchase by supplying a 'loan' during the purchase phase.

This means that the customer buys a phone during sign up. The customer chooses to buy through Ekspres bank who then pays for the phone.

The customer now has a 'loan' at Ekspres bank that the customer will pay back outside our system.

The process is done through three steps.

1. The customer chooses to use Ekspres bank, and a container for the purchase is created at Ekspres bank thorugh a SOAP call (ApplicationCreate).
2. The customer is the approved or rejected. To get that information Ekspres Bank is polled for a status of the purchase through SOAP (ApplicationStatus).
3. If the customer is approved, Rator acknowledges the purchase and sends a capture message to Ekspres bank through SOAP (Capture). It is also possible to cancel the purchase through SOAP (cancel).

The SOAP interaction is implemented and can be found at

https://svn.cdrator.com/svn/dev/integration/Financial/DK/EkspresBank/trunk

Maven dependency:

<groupId>com.cdrator.integration.financial</groupId>
<artifactId>rator-financial-dk-ekspresbank</artifactId>

3 - API

There are two ways to use the implementation, either through actions or if you are running on an older version of core components.

Action

ApplicationCreateServiceAction

Package: com.CDRator.billing.financial.ekspresbank.action.ApplicationCreateServiceAction

This action takes in three arguments

public String execute(String orderNr, Map<String, String> fieldValues, String brandId) throws Exception

orderNr: An order number to be used in the future to identify this transaction.

fieldValues: This is used to specify additional key value pairs to be used in the call to Ekspres bank. Those additional values could be channelId, duration, PrimaryAmount etc. The map contains key/values pairs channelid=1, ...These values are optional.

brandId: The URL of the webservice at Ekspres bank and some additional required arguments that are needed are specified in the parameter tree. This brand Id is used on a branded environment.

The action returns a string, see section 4 for return values.

If anything unexpected happens an exception is thrown.

ApplicationStatusServiceAction

Package: com.CDRator.billing.financial.ekspresbank.action.ApplicationStatusServiceAction

The action takes two arguments:

public String execute(String orderNr, String brandId) throws Exception

orderNr: An order number used to identify the transaction.

brandId: The URL of the webservice at Ekspres bank and some additional required arguments that are needed are specified in the parameter tree. This brand Id is used on a branded environment.

The action returns a string which is the 'decision' on the response from Ekspres bank. This decision is mapped from a single character to a readable response.

ACCEPT, DECLINE, REFER, CANCEL, GOAHEAD, CAPTURED, ERROR

If anything unexpected happens, an exception is thrown.

CancelAction

Package: com.CDRator.billing.financial.ekspresbank.action.CancelAction

This action takes in three arguments:

public String execute(String orderNr, String brandId) throws Exception

orderNr: An order number used to identify the transaction.

brandId: The URL of the webservice at Ekspres bank and some additional required arguments that are needed are specified in the parameter tree. This brand Id is used on a branded environment.

The action returns a string, see section 4 for return values.

If anything unexpected happens, an exception is thrown.

CaptureAction

Package: com.CDRator.billing.financial.ekspresbank.action.CaptureAction

This action takes in three arguments:

public String execute(String orderNr, String brandId) throws Exception

orderNr: An order number used to identify the transaction.

brandId: The URL of the webservice at Ekspres bank and some additional required arguments that are needed are specified in the parameter tree. This brand Id is used on a branded environment.

The action returns a string, see section 4 for return values.

If anything unexpected happens, an exception is thrown.

Component

ApplicationStatusServiceComponent

Package: com.CDRator.billing.financial.ekspresbank.component.ApplicationStatusServiceComponent

This component will poll for the status of the order number at Ekspres bank.

A shop order(SHOP_ORDER) is required on the context with a CDR parameter called EKSPRES_BANK_ORDER_ID.

It will return one of the following statuses: ACCEPT, DECLINE, REFER, CANCEL, GOAHEAD, CAPTURED, ERROR.

In case of error the component will attach a string to the context with a description of the error (ERROR).

Note that the component will look for a brand (BRAND) on the context, if one is found it will use the brandId to look for parameters in the parameter tree.

CancelComponent

Package: com.CDRator.billing.financial.ekspresbank.component.CancelComponent

This component will cancel the order at Ekspres bank with that orderNr.

A shop order(SHOP_ORDER) is required on the context with a CDR parameter called EKSPRES_BANK_ORDER_ID.

It will return one of the following statuses: OK, CANCEL_ERROR.

In case of error the component will attach a string to the context with a description of the error (ERROR).

Note that the component will look for a brand (BRAND) on the context, if one is found it will use the brandId to look for parameters in the parameter tree.

CaptureComponent

Package: com.CDRator.billing.financial.ekspresbank.component.CaptureComponent

This component will capture the order at ekspres bank with that orderNr.

A shop order(SHOP_ORDER) is required on the context with a CDR parameter called EKSPRES_BANK_ORDER_ID.

If will return one of the following statuses: OK, CAPTURE_ERROR.

In case of error the component will attach a string to the context with a description of the error (ERROR).

Note that the component will look for a brand (BRAND) on the context, if one is found it will use the brandId to look for parameters in the parameter tree.

4 - Return Codes

5 - Logging

The project uses the rator-soap-monitoring to log request and response to the soap_client_log table. In order for this tool to work, two parameters must be added to the parameter tree. See section 6 - Configuration.

6 - Configuration

The following parameters are required. All except the logging parameters are brand-enabled.

Required for communicating with Ekspres bank

• FINANCIAL.EKSPRESBANK.SITE = site name
• FINANCIAL.EKSPRESBANK.RETAILER_ID = retailer id
• FINANCIAL.EKSPRESBANK.PASSWORD = password

The webservice URLs, only the webservice what are used are needed. So if you do not need to call applicationCreate, you do not need to specify the parameter

• FINANCIAL.EKSPRESBANK.APPLICATION_CREATE_WSDL = webservice at ekspres bank for application create
• FINANCIAL.EKSPRESBANK.APPLICATION_STATUS_WSDL = webservice at ekspres bank for application status
• FINANCIAL.EKSPRESBANK.CANCEL_SIGNAL_WSDL = webservice at ekspres bank for cancel signal
• FINANCIAL.EKSPRESBANK.CAPTURE_SIGNAL_WSDL = webservice at ekspres bank for capture signal

Required for Logging

• SOAP.MONITORING.ENABLE_RATOR_MONITORING_HANDLER = 'T'
• SOAP.MONITORING.ENABLE_XML_PERSISTENCY = 'T'

7 - Version