getVelocityData

To search in the page use Ctrl+F on your keyboard

This function makes it possible to check the activity of a given data field over a given period.

Recommended interfaceVersion: FR_WS_2.55

Endpoints

json
soap

PROD

https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/fraud/getVelocityData

method

POST
TEST

https://office-server-sherlocks.test.sips-services.com/rs-services/v2/fraud/getVelocityData

method

POST

PROD

https://sherlocks-office-server.secure.lcl.fr/services/v2/fraud?wsdl

method

POST
TEST

https://office-server-sherlocks.test.sips-services.com/services/v2/fraud?wsdl

method

POST

Request

Required

interfaceVersion
presence

Required

Interface version

2.0
Format
AN20(restricted String)
Version of the interface used. It is composed of a prefix that varies according to the function used and a version number (e.g. IR_WS_2.47).

Please refer to the function page for the value to use. Use the latest interface version number.

List of values

FR_WS_2.

Sherlock’s Office (SOAP) interface for Fraud functions.
keyVersion

presence

Required

Interface version

2.0

Format

N10

Version of the merchant’s secret key used to calculate the imprint of the message (key stored by the merchant to verify the imprint of the automatic and manual notifications).
merchantId

presence

Required

Interface version

2.0

Format

N15

Identifier of the shop, this value is provided to the merchant by Sherlock’s during the shop registration.
seal

presence

Required

Interface version

2.0

Format

ANS128

Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
velocityElementType

presence

Required

Interface version

2.0

Format

AN50(restricted values)

Velocity element type.(example: card velocity, customerId, IP…)

List of values

IP

Internet user IP

card

Customer Id

customerId

Card of the cardHolder
velocityElementValue

presence

Required

Interface version

2.0

Format

AN256

Value of the velocity control element (example: IP address for IP velocity control). Value corresponding to the element on which the merchant wishes to perform a velocity check.

Optional

intermediateServiceProviderId

presence

Optional

Interface version

2.12

Format

AN30

Identifier of the Service used by the merchant for the exchanges with the Sherlock’s platform.
sealAlgorithm

presence

Optional

Interface version

2.12

Format

ANS20(restricted values)

Algorithm applied to calculate the seal encryption.

List of values

HMAC-SHA-256

The encryption algorithm applied is HMAC-SHA-256

HMAC-SHA-512

The encryption algorithm applied is HMAC-SHA-512

SHA-256

The encryption algorithm applied is SHA-256
velocityPeriod

presence

Optional

Interface version

2.0

Format

N4

Period during which the velocity is requested.(example: velocity check during a 2 days duration)

            {
  "interfaceVersion": "FR_WS_2.9",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "velocityElementType": "customerId",
  "velocityElementValue": "cust010",
  "velocityPeriod": "50",
  "seal": "fc24b9e6bd7a433d258a1df1a8af2698b917d1632aaa1bc12c5c8f45adbeba11"
}

                  <urn:getVelocityData>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:interfaceVersion>FR_WS_2.2</urn:interfaceVersion>
            <urn:velocityElementType>customerId</urn:velocityElementType>
            <urn:velocityElementValue>cust010</urn:velocityElementValue>
            <urn:velocityPeriod>50</urn:velocityPeriod>
         </urn:input>
      </urn:getVelocityData>

Response

Required

seal

presence

Required

Interface version

2.0

Format

ANS128

Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.

Optional

currencyCode

presence

Optional

Interface version

2.0

Format

N3(restricted values / ISO4217)

Currency code for the transaction. This code is ISO 4217 compatible.

List of values

032

Argentinean Peso

036

Australian Dollar

048

Bahrain Dinar

116

Cambodian Riel

124

Canadian Dollar

144

Sri Lanka Rupee

156

China Yuan Renminbi

191

Croatia Kuna

203

Czech Republic Koruna

208

Danes crown

344

Hong Kong dollar

348

Hungary Forint

352

Iceland Rupee

356

Indian rupee

376

Israel Shekel

392

Japanese Yen

410

South Korean Won

414

Kuwait Dinar

458

Malaysia Ringgit

480

Mauritius Rupee

484

Mexican Peso

524

Nepal Rupee

554

New Zealand Dollar

578

Norwegian crown

634

Qatar Riyal

643

Russia Ruble

682

Saudi Arabia Riyal

702

Singapore Dollar

710

South Africa Rand

752

Swedish crown

756

Swiss Franc

764

Thailand Baht

784

United Arab Emirates Dirham

788

Tunisia Dinar

826

Pound

840

American Dollar

901

Taiwan Dollar

941

Serbian Dinar

946

Roumania New Leu

949

New Turkish Lira

952

CFA Franc

953

CFP Franc

975

Bulgaria Lev

978

Euro

980

Ukraine Hryvnia

985

Poland Zloty

986

Brazilian Real
errorFieldName

presence

Optional

Interface version

2.21

Format

ANS50

Error field name of the incoming request. Present when responseCode = 12 or 30.
responseCode

presence

Optional

Interface version

2.0

Format

N2(restricted values)

Sherlock’s server response code.

List of values

00

Operation accepted

03

Invalid merchant contract

99

Temporarily problem with the payment server
velocityNbTransaction

presence

Optional

Interface version

2.0

Format

N10

Transaction number processed during the period.
velocityProfileDateTime

presence

Optional

Interface version

2.0

Format

ANS25 (ISO8601)

Last modification date for the velocity active profile.
velocityProfileMaxNbTrans

presence

Optional

Interface version

2.0

Format

N10

Maximum transaction number authorized for the velocity rule requested.(example: alert beyond 3 transactions)
velocityProfileMaxTotalAmount

presence

Optional

Interface version

2.0

Format

N12

Maximum transactions cumulated amount authorized for the velocity rule requested.(example: alert if cumulated amount beyond 500,00 euros)
velocityProfileMaxTransAmount

presence

Optional

Interface version

2.0

Format

N12

Maximum transaction amount of the transaction authorized for the velocity rule requested.(example: alert if cumulated amount beyond 500,00 euros)
velocityProfileName

presence

Optional

Interface version

2.0

Format

ANS50

Period, number of days, during which velocity information are requested.(example: velocity check during a 2 days duration)
velocityProfilePeriod

presence

Optional

Interface version

2.0

Format

N10

Period, number of days, during which velocity rule is applied.(example: velocity check during a 2 days duration)
velocityTotalAmount

presence

Optional

Interface version

2.0

Format

N12

Cumulated transaction amount realized during the requested period for the velocity rule.(example: cumulated amount for the period requested of 400 euros)

Response sample

json
soap

            {
  "responseCode": "00",
  "velocityTotalAmount": 0,
  "velocityNbTransaction": 0,
  "velocityProfilMaxTotalAmount": 1000,
  "velocityProfilMaxNbTrans": 10,
  "velocityProfilMaxTransAmount": 100,
  "currencyCode": "978",
  "velocityProfileName": "all_controls",
  "velocityProfilPeriod": 10,
  "velocityProfileDateTime": "2014-11-19T14:21:32+01:00",
  "seal": "5a65b70f786047ef13f80a55a6642211daa52df74039c605e70ac7d752f52731"
}

                  <getVelocityDataResponse xmlns="urn:sips:cn:contract:office:diagnostic:v2">
         <output>
            <responseCode>00</responseCode>
            <currencyCode>978</currencyCode>
            <velocityTotalAmount>0</velocityTotalAmount>
            <velocityNbTransaction>0</velocityNbTransaction>
            <velocityProfilMaxTotalAmount>1000</velocityProfilMaxTotalAmount>
            <velocityProfilMaxNbTrans>10</velocityProfilMaxNbTrans>
            <velocityProfilMaxTransAmount>100</velocityProfilMaxTransAmount>
            <velocityProfilName>all_controls</velocityProfilName>
            <velocityProfilPeriod>10</velocityProfilPeriod>
            <velocityProfilDateTime> 2012-04-03T21:21:33-12:00</velocityProfilDateTime>
         </output>
      </getVelocityDataResponse>

Changelog

Filter

Interface version	Data	Attendance
2.12	`intermediateServiceProviderId`	Request
2.12	`sealAlgorithm`	Request
2.0	`velocityPeriod`	Request
2.0	`interfaceVersion`	Request
2.0	`keyVersion`	Request
2.0	`merchantId`	Request
2.0	`seal`	Request/Response
2.0	`velocityElementType`	Request
2.0	`velocityElementValue`	Request
2.0	`currencyCode`	Response
2.21	`errorFieldName`	Response
2.0	`responseCode`	Response
2.0	`velocityNbTransaction`	Response
2.0	`velocityProfileDateTime`	Response
2.0	`velocityProfileMaxNbTrans`	Response
2.0	`velocityProfileMaxTotalAmount`	Response
2.0	`velocityProfileMaxTransAmount`	Response
2.0	`velocityProfileName`	Response
2.0	`velocityProfilePeriod`	Response
2.0	`velocityTotalAmount`	Response

getVelocityData

Endpoints

Request

Required

`interfaceVersion`

`keyVersion`

`merchantId`

`seal`

`velocityElementType`

`velocityElementValue`

Optional

`intermediateServiceProviderId`

`sealAlgorithm`

`velocityPeriod`

Request sample

Response

Required

`seal`

Optional

`currencyCode`

`errorFieldName`

`responseCode`

`velocityNbTransaction`

`velocityProfileDateTime`

`velocityProfileMaxNbTrans`

`velocityProfileMaxTotalAmount`

`velocityProfileMaxTransAmount`

`velocityProfileName`

`velocityProfilePeriod`

`velocityTotalAmount`

Response sample

Changelog

Need help?