paymentTokenInitialize

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

Initialize a payment token generation kinematic with “Sherlock’s In-App”.

Recommended interfaceVersion: IR_MB_2.55

Endpoints

PROD

https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/tokenInApp/paymentTokenInitialize

method

POST
TEST

https://office-server-sherlocks.test.sips-services.com/rs-services/v2/tokenInApp/paymentTokenInitialize

method

POST

Request

Required

interfaceVersion
presence

Required

Interface version

2.37
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

AR_WS_2.

Obsolete

AUT_WS_2.

Sherlock’s Office (SOAP/JSON) interface for the Sherlock’s authentication services.

AU_WS_2.

AU_WS: Sherlock’s Office (SOAP/JSON) interface for the Sherlock’s account update services.

CR_WS_2.

Sherlock’s Office (SOAP/JSON) interface for Cash Management functions.

DR_WS_2.

Sherlock’s Office (SOAP/JSON) interface for Diagnostic functions.

FR_WS_2.

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

HP_x.x

Sherlock’s Paypage and Sherlock’s Walletpage (POST) interface.

IR_MB_

Sherlock’s In-App (JSON) interface for Sherlock’s In-App functions.

IR_WS_

Sherlock’s Paypage and Sherlock’s Office (SOAP/JSON) interface.

MR_WS_2.

Sherlock’s Office (SOAP/JSON) interface for mandate management.

PMR_WS_2.

Sherlock’s Office (SOAP/JSON) interface for payment method repository information request functions.

TR_WS_2.

Sherlock’s Office (SOAP) interface for Token functions.

WMR_WS_2.

Sherlock’s Walletpage interface (SOAP/JSON).

WR_WS_2.

WR_WS: Sherlock’s Office (SOAP/JSON) interface for Wallet functions.
keyVersion

presence

Required

Interface version

2.37

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.37

Format

N15

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

presence

Required

Interface version

2.37

Format

ANS30(restricted values)

In the context of Sherlock’s In-App (example: mobile application), indicates at the time of the phase initialization, the name of the operation that was chosens (example: card payment).

List of values

ADDCARD

Adding a card to the Wallet Sherlock’s for the initialization phase of an Sherlock’s In-App transaction

CARDORDER

Card payment for the initialization phase of an Sherlock’s In-App transaction

GETWALLETDATA

Consulting the information of a Wallet Sherlock’s for the initialization phase of a transaction Sherlock’s In-App

PAYMENTPROVIDERORDER

Via an external partner for the initialization phase of an Sherlock’s In-App transaction

PAYMENTTOKENGENERATE

Generation of token for a payment Sherlock’s In-App

THREEDSECUREANDORDER

Card payment for the initialization phase of an Sherlock’s In-App transaction with 3-D Secure authentication

THREEDSECUREANDWALLETORDER

Payment means registered in the Wallet Sherlock’s for the initialization phase of a transaction Sherlock’s In-App with 3-D Secure authentication

WALLETORDER

Payment with the Wallet Sherlock’s for the initialization phase of an Sherlock’s In-App transaction
sdkVersion

presence

Required

Interface version

2.37

Format

ANS20

Version of the SDK used for a payment or operation Sherlock’s In-App (Eg. 2.0.4)
seal

presence

Required

Interface version

2.37

Format

ANS128

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

Optional

customerIpAddress

presence

Optional

Interface version

2.37

Format

ipAddress

Buyer’s IP address.
intermediateServiceProviderId

presence

Optional

Interface version

2.37

Format

AN30

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

presence

Optional

Interface version

2.37

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

Request sample

json

            {
    "interfaceVersion" : "IR_MB_2.37",
    "keyVersion" : "1",
    "merchantId" : "011223344550000",
    "sdkOperationName" : "PAYMENTTOKENGENERATE",
    "sdkVersion" : "SDK100",
    "seal" : "a5fc2c68e7051671c7b81c70ba971310b8d6188360199922cb3bd57778f3ffa4"
}

Response

Required

seal

presence

Required

Interface version

1.0

Format

ANS128

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

Optional

publicKeyValue

presence

Optional

Interface version

1.0

Format

ANS16

In the context of a payment via Sherlock’s In-App, value of the public key that Sherlock’s sent to merchant in the response of initialisation in order to encrypt the card data that the merchant will send to Sherlock’s.
redirectionStatusCode

presence

Optional

Interface version

1.0

Format

N2(restricted values)

Response code returned by Sherlock’s when redirecting (e.g. redirecting to the ACS, to Sherlock’s server…). Indicates whether redirecting is possible or not.
List of values
00
In response to paymentWebInit: transaction initialized

In response to walletCheckEnrollment and cardCheckEnrollment: Carte enrolled
01

In response to cardCheckEnrollment and walletCheckEnrollment: card non 3-D Secure enrolled

03

Merchant contract invalid

10

Undefinied card enrollment (in response to cardCheckEnrollment and walletCheckEnrollment only)

12

Invalid transaction, check parameters transferred in the request

14

Invalid payment mean data (ex: PAN)

30

Format error (Webinit ERROR)

34

Suspicion of fraud, signature error (Webinit ERROR)

80

Error during DS interrogation

89

MPI session expired

91

Merchant not configured in the 3-D Secire server
94
In response to paymentWebInit: transaction duplicated. The transactionReference of this transaction has already been used

In response to cardCheckEnrollment or walletCheckEnrollment: error during the enrollment verification call
99

Internal error
redirectionStatusMessage

presence

Optional

Interface version

1.0

Format

ANS50

Additional information that is returned with redirectionStatusCode.
redirectionUrl

presence

Optional

Interface version

1.0

Format

url

In case of an enrollment check, contains the redirection URL to the ACS required for the cardholder authentication. In case of Sherlock’s In-App payment, contains the URL of the next request. In case of 3-D Secure Standalone, contains the redirection URL to the ACS required for the cardholder authentication.
redirectionVersion
presence

Optional

Interface version

1.0
Format
AN20 (restricted String)
Version of the redirection message.

Response sample

json

            {
  "publicKeyValue":"30820122...10001",
  "redirectionStatusCode":"00",
  "redirectionStatusMessage":"Process succeeded",
  "redirectionUrl":"https://office-server.sips-services.com/rs-api/public/v2/tokenInApp/paymentTokenGenerate",
  "redirectionVersion":"IR_MB_2.37",
  "seal":"48670660a9167df5734d8f11546ee1d296557055e5861e8e2d1b85d6de7357fb"
}

Changelog

Filter

Interface version	Data	Attendance
2.37	`customerIpAddress`	Request
2.37	`intermediateServiceProviderId`	Request
2.37	`sealAlgorithm`	Request
2.37	`interfaceVersion`	Request
2.37	`keyVersion`	Request
2.37	`merchantId`	Request
2.37	`sdkOperationName`	Request
2.37	`sdkVersion`	Request
2.37	`seal`	Request/Response
1.0	`publicKeyValue`	Response
1.0	`redirectionStatusCode`	Response
1.0	`redirectionStatusMessage`	Response
1.0	`redirectionUrl`	Response
1.0	`redirectionVersion`	Response

paymentTokenInitialize

Endpoints

Request

Required

`interfaceVersion`

`keyVersion`

`merchantId`

`sdkOperationName`

`sdkVersion`

`seal`

Optional

`customerIpAddress`

`intermediateServiceProviderId`

`sealAlgorithm`

Request sample

Response

Required

`seal`

Optional

`publicKeyValue`

`redirectionStatusCode`

`redirectionStatusMessage`

`redirectionUrl`

`redirectionVersion`

Response sample

Changelog

Need help?