General information
This is version 2 of the WebService made available. All methods from version 1 are available in version 2 along with three additional methods used for MasterPass.
For security reasons, the web service can only be reached over https.
Web service location details:
Endpoint:
Target namespace:
WSDL:
Methods
The following are the most commonly used web service methods:
If you are creating payments through the API you need to assure that you have the right PCI-certificate to do so.
- authorize
- settle
- authorizeAndSettle
- refund
- authReversal
- subscribe
- subscribeAndSettle
- askIf3DSEnrolled
- authorize3DS
- authorizeAndSettle3DS
- mpInitForm
- mpValidate
- mpAuthorize
Some methods and their parameters are explicitly described (see links above), while others should be explored using the web service wsdl.
Request parameters
The various methods have their own specific input parameters. All methods provided by the web service require logon credentials. The specific web service logon parameters are:
Parameter | Description |
|---|---|
shopName | Merchant shopname, provided by DIBS |
userName | API-Username, generated by merchant in DIBS Manager |
password | API-User password, generated by merchant in DIBS Manager |
The userName and password is generated in DIBS Manager under Security > User Accounts > Add API-User Account.
Important notes about the extra parameter in webservice calls:
The parameter named "extra" can be used to send multiple parameters. This is done by formatting the "extra" parameters values to a query string.
Example:
Values can be URL encoded to escape special characters in the value position.
Return parameters
All payment methods provided by the web service returns a ReturnData structure. The checkSwedishPersNo method returns a boolean (true/false). The ReturnData structure can hold the following data:
Parameter | Description |
|---|---|
verifyID | DIBS reference number |
resultCode | DIBS result code |
resultText | DIBS result text |
amount | Transaction amount |
acquirerAuthCode | Authorization code from acquirer |
acquirerAuthResponseCode | Authorization response code from acquirer |
errorMsg | DIBS error message |
ACSUrl | 3D-Secure payments |
PAReqMsg | Used for 3D-Secure payments |
acquirerAddress | Customer check return data from aquirer |
acquirerCity | Customer check return data from aquirer |
aquirerConsumerLimit | Customer check return data from aquirer |
acquirerErrorDescription | Customer check return data from aquirer |
acquirerFirstName | Customer check return data from aquirer |
acquirerLastName | Customer check return data from aquirer |
acquirerMerchantLimit | Customer check return data from aquirer |
acquirerZipCode | Customer check return data from aquirer |
infoCode | Customer check return data from aquirer |
infoDescription | Customer check return data from aquirer |
Not all return data are applicable for all web service methods and all acquirers. Information on return codes can be found on the Return codes page