Announcements

Important: SOAP Toolkit Update

Available Environments

Java Prerequisites

C# Prerequisites

PHP Prerequisites

C++ Prerequisites

Java Migration Steps

Add these dependencies to the

pom.xml

file:

<dependencies>
  <dependency>
    <groupId>jakarta.xml.ws</groupId>
    <artifactId>jakarta.xml.ws-api</artifactId>
    <version>4.0.2</version>
  </dependency>
  <dependency>
    <groupId>com.sun.xml.ws</groupId>
    <artifactId>jaxws-rt</artifactId>
    <version>4.0.3</version>
    <scope>runtime</scope>
  </dependency>
  <dependency>
    <groupId>com.sun.xml.ws</groupId>
    <artifactId>jaxws-ri</artifactId>
    <version>4.0.3</version>
    <type>pom</type>
  </dependency>
  <dependency>
    <groupId>org.bouncycastle</groupId>
    <artifactId>bcprov-jdk15to18</artifactId>
    <version>1.78</version>
  </dependency>
  <dependency>
    <groupId>org.apache.santuario</groupId>
    <artifactId>xmlsec</artifactId>
    <version>4.0.3</version>
  </dependency>
</dependencies>

Add this plugin to the

pom.xml

file:

<build>
  <plugins>
    <plugin>
      <groupId>com.sun.xml.ws</groupId>
      <artifactId>jaxws-maven-plugin</artifactId>
      <version>4.0.3</version>
      <configuration>
	  <wsdlUrls>
           <wsdlUrl>https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/CyberSourceTransaction_1.219.wsdl</wsdlUrl>
        </wsdlUrls>
        <keep>true</keep>
        <packageName>com.cybersource.stub</packageName>
        <sourceDestDir>src/main/java</sourceDestDir>
      </configuration>
    </plugin>
  </plugins>
</build>

Check the value that is set in the

wsdlUrl

tag, and update the version if necessary. The latest version of the WSDL that can be supported is 1.219.

Run this command in your terminal:

Copy
mvn clean jaxws:wsimport

Find these lines in your existing code:

TransactionProcessorLocator service = new 
    TransactionProcessorLocator();

URL endpoint = new URL(SERVER_URL);

ITransactionProcessorStub stub = 
    (ITransactionProcessorStub) service.getportXML
    (endpoint);

stub._setProperty(WSHandlerConstants.USER, request
    .getMerchantID());

Replace them with these lines:

TransactionProcessor service = new TransactionProcessor();

service.setHandlerResolver(portInfo - >{
  List < Handler > handlerList = new ArrayList < >();
  handlerList.add(new BinarySecurityTokenHandler());
  return handlerList;
});

ITransactionProcessor stub = service.getPortXML();

Copy these files to your project directory:

BinarySecurityTokenHandler.java
PropertiesUtil.java
SecurityUtil.java

Add a

toolkit.properties

file in the

src/main/resources

folder in your project. The

toolkit.properties

file must contain this content:

MERCHANT_ID = <your_merchant_id>
LIB_VERSION = 4.0.3
KEY_ALIAS = <your_certificate_key_alias>
KEY_FILE = <your_certificate_file>
KEY_PASS = <your_certificate_password>
KEY_DIRECTORY = src/main/resources

If you want to use your own properties file, you can make these changes in the

PropertiesUtil.java

file.

Add your P12 certificate to your key directory.

Run these commands in your terminal:

Copy
mvn clean install

Copy
java -jar target\JavaSoapToolkit.jar

(Optional) You can confirm that your configuration is updated successfully by checking that your request was authenticated using a Bearer token. To confirm, add this command after line 54 in the

src\main\java\com\cybersource\BinarySecurityTokenHandler.java

file:

System.out.println( soapMessageContext ); 

C# Migration Steps

Add the following service URL as a service reference to your project:

https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/CyberSourceTransaction_N.NNN.wsdl

where

N.NNN

is the latest server API version.

This will generate a Connected Services section in your project. It will also generate an

app.config

file for your project.

Add the following sections to the top of your

app.config

file:

<configuration>
   <configSections>
      <section name="toolkitProperties" type="System.Configuration.NameValueSectionHandler"/>
   </configSections>

   <toolkitProperties>
      <add key="MERCHANT_ID" value="<your_merchant_id>"/>
      <add key="KEY_ALIAS" value="<your_certificate_key_alias>"/>
      <add key="KEY_FILE" value="<your_certificate_file>"/>
      <add key="KEY_PASS" value="<your_certificate_password>"/>
      <add key="KEY_DIRECTORY" value="<path/to/certificate/file>"/>
   </toolkitProperties>
</configuration>

The

<configSections>

tag must be the first section inside

<configurations>

.

In the generated

app.config

file, leave the

<binding>

section as it is.

The

<binding>

section must look like this:

<bindings>
   <basicHttpBinding>
         <binding name="ITransactionProcessor">
         <security mode="Transport"/>
         </binding>
   </basicHttpBinding>
</bindings>

Add this dependency to the

packages.config

file:

<packages>
   <package id="Portable.BouncyCastle" version="1.9.0" targetFramework="net472" />
</packages>

Install the dependency:

nuget install packages.config -OutputDirectory packages

Add this package reference to your

.csproj

file:

<Reference Include="BouncyCastle.Crypto, Version=1.9.0.0, Culture=neutral, PublicKeyToken=0e99375e54769942, processorArchitecture=MSIL">
   <HintPath>packages\Portable.BouncyCastle.1.9.0\lib\net40\BouncyCastle.Crypto.dll</HintPath>
</Reference>

The steps for adding a new dependency can also be done through Visual Studio Package Manager.

Add your P12 certificate to the

KEY_DIRECTORY

.

This

KEY_DIRECTORY

location must be accessible to your code. Ensure that your code has permission to read this location.

Copy these files to your project directory and import them to your project:

CertificateCacheUtility.cs
InspectorBehavior.cs
PropertiesUtility.cs
SecurityUtility.cs
SoapEnvelopeUtility.cs

Find these lines in your existing code:

TransactionProcessorClient proc = new TransactionProcessorClient();

proc.ChannelFactory.Credentials.UserName.UserName =  request.merchantID;
proc.ChannelFactory.Credentials.UserName.Password =  TRANSACTION_KEY;

ReplyMessage reply = proc.runTransaction(request);

Replace them with these lines:

TransactionProcessorClient proc = new TransactionProcessorClient();

proc.Endpoint.EndpointBehaviors.Add(new InspectorBehavior());

ReplyMessage reply = proc.runTransaction(request);

Find your installation of .NET Framework.

This is often located at one of these locations:

C:\Windows\Microsoft.NET\Framework\v4.0.30319
(32-bit)
C:\Windows\Microsoft.NET\Framework64\v4.0.30319
(64-bit)

Use

msBuild.exe

to compile your project.

Copy
<path_to_framework>\msBuild.exe <name_of_project>.csproj

Run the project executable:

Copy
bin\<configuration>\<project_name>.exe

(Optional) You can confirm that your configuration is updated successfully by checking that your request was authenticated using a Bearer token. To confirm, add this command after line 59 in the

CSharpSoapToolkit\InspectorBehavior.cs

file:

Console.WriteLine(request.ToString()); 

PHP Migration Steps

Update the following service URL (

WSDL_URL

) in your code:

https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/CyberSourceTransaction_N.NNN.wsdl

N.NNN

is the latest server API version.

Copy these files to your project directory:

ExtendedClientWithToken.php
PropertiesUtility.php
SecurityUtility.php

Locate these lines in your existing code:

$soapClient = new ExtendedClient(WSDL_URL, array());

Replace them with these lines:

$soapClient = new ExtendedClientWithToken(
    WSDL_URL,
    array(
        'SSL' => array(
                'KEY_ALIAS' => 'YOUR KEY ALIAS',
                'KEY_FILE' => 'YOUR CERTIFICATE FILE',
                'KEY_PASS' => 'YOUR KEY PASS',
                'KEY_DIRECTORY' => 'PATH TO CERTIFICATES'
            )
        )
);

Update the necessary values for these fields in your code:

MERCHANT_ID
KEY_ALIAS
KEY_FILE
KEY_PASS
KEY_DIRECTORY

Add your P12 certificate to the

KEY_DIRECTORY

.

This

KEY_DIRECTORY

location must be accessible to your code. Ensure that your code has permission to read this location.

Run the code:

Copy
php <sample_PHP_file>

(Optional) You can confirm that your configuration is updated successfully by confirming that your request was authenticated using a Bearer token. To confirm, add this command after line 109 in the

ExtendedClientWithToken.php

file:

print_r($request);

C++ Migration Steps

Update your existing Makefile.

Change the

cybsdemo

target from:

cybsdemo:     sample.cpp $(SOAPH) $(SOAPCPP) ../gsoap/dom.cpp wsseapi.o smdevp.o
		$(CPP) $(CFLAGS) -o cybsdemo sample.cpp soapC.cpp soapClient.cpp ../gsoap/dom.cpp $(SOAPCPP) wsseapi.o smdevp.o $(LIBS)

To:

cybsdemo:	sample.cpp $(SOAPH) $(SOAPCPP) ../gsoap/dom.cpp wsseapi.o smdevp.o
		$(CPP) $(CFLAGS) -o cybsdemo sample.cpp soapC.cpp ../gsoap/dom.cpp stdsoap2.cpp ../gsoap/import/custom/struct_timeval.cpp ../gsoap/plugin/threads.c ../gsoap/plugin/mecevp.c ../gsoap/plugin/wsaapi.c wsseapi.o smdevp.o soapITransactionProcessorProxy.cpp ../gsoap/import/gsoapWinInet.cpp PropertiesUtil.cpp BinarySecurityTokenHandler.cpp $(LIBS)

If you do not have an existing Makefile, you can use one of the following Makefiles:

UnixBuildAllCommented.Makefile
UnixQuickBuild.Makefile
WindowsBuildAllCommented.Makefile
WindowsQuickBuild.Makefile

Cybersource

recommends that you use UnixBuildAllCommented.Makefile or WindowsBuildAllCommented.Makefile. If you need to make changes to individual targets,

Cybersource

recommends that you use UnixQuickBuild.Makefile or WindowsQuickBuild.Makefile, as each target can be built individually.

CyberSourceTransaction WSDL and XSD version 1.224 are available here:

CyberSourceTransaction_1.224.wsdl
CyberSourceTransaction_1.224.xsd

If you want to use a different version, download your preferred version to the project directory and update the versions in the

header

target of your makefile. For example, change:

header:	CyberSourceTransaction_1.224.wsdl
		$(GWSDL) -t ../gsoap/WS/WS-typemap.dat -s -o cybersource.h CyberSourceTransaction_1.224.wsdl

to:

header:	CyberSourceTransaction_1.219.wsdl
		$(GWSDL) -t ../gsoap/WS/WS-typemap.dat -s -o cybersource.h CyberSourceTransaction_1.219.wsdl

Add gsoap to the compile path. You can do this by using one of these methods:

Copy the gsoap directory, including the header files, to one level above the project directory.
Update all paths in the Makefile that reference 'gsoap' to point to where gsoap is located.

Update your sample.cpp file to match your test credentials:

const char *MERCHANT_ID = "your_merchant_id";
const char *TRANSACTION_KEY = "your_transaction_key";

If you do not have an existing sample.cpp file, you can use the version that is provided here: sample.cpp.

If you are using an existing sample.cpp file from a previous C++ SOAP Toolkit, you must refer to all "upgrading from previous versions" comments throughout sample.cpp to see what has changed.

Include these new source files in your project:

BinarySecurityTokenHandler.cpp
BinarySecurityTokenHandler.h
PropertiesUtil.cpp
PropertiesUtil.h
stdsoap2.cpp
stdsoap2.h

Edit the toolkit.properties configuration file to match your test credentials:

Copy
MERCHANT_ID=
KEY_ALIAS=
KEY_FILE=
KEY_PASS=
KEY_DIRECTORY=

The toolkit.properties configuration file is read from the same location as the executable at run time.

You must make sure that there are no spaces at the start and end of the lines, or either side of

=

.

Run this command in your terminal:

Copy
make header

This generates the cybersource.h file.

Insert this text in the Import section of cybersource.h:

#import "WS-Header.h"

Run this command in your terminal:

Copy
make source

This generates these files:

soapITransactionProcessorProxy.cpp
soapITransactionProcessorProxy.h
ITransactionProcessor.runTransaction.req.xml
ITransactionProcessor.runTransaction.res.xml
ITransactionProcessor.nsmap
soapStub.h
soapH.h
soapC.cpp

Run these commands in your terminal:

Copy
make wsseapi.o
make smdevp.o
make cybsdemo 

This generates the cybsdemo.exe executable.

Add your P12 certificate to the

KEY_DIRECTORY

.

Run the cybsdemo.exe executable in your terminal.

A successful console output consists of the

keyFile

full path, followed by the response from the web service and no errors. For example:

keyFile full path: C:/keys/test_p12_file.p12
decision = APPROVED
reasonCode = 0
requestID = 6017349752184504643266
requestToken = Axxd6DCgJoj77wSTjm5pe7DwFPfjpNDMyadDIZ/u1Pfje7D9IGU1ogwAGkmXoDc3JoZmTToZDIAAvxSz
ccAuthReply.reasonCode = 0