paymentTokenGenerate

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

Generate a payment token fro a hosted fields payment.

Recommended interfaceVersion: TR_WS_2.55

Endpoints

json
soap

PROD

https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/token/paymentTokenGenerate

method

POST
TEST

https://office-server-sherlocks.test.sips-services.com/rs-services/v2/token/paymentTokenGenerate

method

POST

PROD

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

method

POST
TEST

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

method

POST

Request

Required

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

cardCSCValue

presence

Optional

Interface version

2.0

Format

N4

Visual card security code on the bank card transmitted in the authorisation request (CSC, Card Security Code, referred to as CVV for Visa, CVC for Mastercard and 4DBC for American Express).
cardExpiryDate

presence

Optional

Interface version

2.0

Format

N6(YYYYMM)

Card expiry date. If the card does not have any expiry date, this field is empty.
cardNumber

presence

Optional

Interface version

2.0

Format

N19/ANS128

Card number (format N19 unless the card number is a Token, and in this case, the format is ANS128).
interfaceVersion
presence

Optional

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

TR_WS_2.

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

presence

Optional

Interface version

2.0

Format

AN30

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

presence

Optional

Interface version

2.0

Format

N15

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

presence

Optional

Interface version

2.0

Format

ANS20(restricted values)

Name of the payment method that is used. It is related to one paymentMeanType.

List of values

1EUROCOM

Cofidis Pay 5x10x20x Acquisition contract: ONLINE_CREDIT

3XCBCOFINOGA

Depreciated. Cofinoga 3xCB paymentMeanBrandType: CARD

ACCEPTGIRO

AcceptGiro paymentMeanBrandType: CREDIT_TRANSFER

AIRPLUS

Airplus card paymentMeanBrandType: CARD

AIRPLUS_LOGEE

Airplus card paymentMeanBrandType: CARD

AMEX

American Express card paymentMeanBrandType: CARD

AMEX_LOGEE

American Express card paymentMeanBrandType: CARD

AURORE

CPAY card paymentMeanBrandType: CARD

BCACB_3X

Payment in 3 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT

BCACB_4X

Payment in 4 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT

BCACUP

CUP card of Floa Bank paymentMeanBrandType: CARD

BCMC

Bancontact card paymentMeanBrandType: CARD

CACF_3X

CACF payment in 3 installments paymentMeanBrandType: ONLINE_CREDIT

CACF_3XSANSFRAIS

CACF payment in 3 installments free of charge paymentMeanBrandType: ONLINE_CREDIT

CACF_4X

CACF payment in 4 installments paymentMeanBrandType: ONLINE_CREDIT

CACF_4XSANSFRAIS

CACF payment in 4 installments free of charge paymentMeanBrandType: ONLINE_CREDIT

CADHOC

Cadhoc paymentMeanBrandType: CARD

CADOCARTE

Cado Carte paymentMeanBrandType: CARD

CB

Carte Bancaire paymentMeanBrandType: CARD

CETELEM_3X

Cetelem 3xCB paymentMeanBrandType: ONLINE_CREDIT

CETELEM_4X

Cetelem 4xCB paymentMeanBrandType: ONLINE_CREDIT

COFIDIS_3X

Cofidis 3xCB paymentMeanBrandType: ONLINE_CREDIT

COFIDIS_4X

Cofidis 4xCB paymentMeanBrandType: ONLINE_CREDIT

CONECS

Titres Restaurants Dématérialisés Conecs paymentMeanBrandType: VOUCHER

CUP

China UnionPay card paymentMeanBrandType: CARD

CVA

Visa Aurore card paymentMeanBrandType: CARD

CVCO

Chèque-Vacances Connect paymentMeanBrandType: VOUCHER

DINERS

Carte Diners club international paymentMeanBrandType: CARD

FRANFINANCE_3X

Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT

FRANFINANCE_4X

Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT

GIROPAY

Giropay paymentMeanBrandType: CREDIT_TRANSFER

ILLICADO

Illicado paymentMeanBrandType: CARD

INCASSO

Incasso paymentMeanBrandType: DIRECT_DEBIT

INGHOMEPAY

PayButton ING Home’Pay paymentMeanBrandType: CREDIT_TRANSFER

JCB

Carte Japan Credit Bureau paymentMeanBrandType: CARD

LEPOTCOMMUN

Le Pot Commun paymentMeanBrandType: CARD

LYDIA

Lydia paymentMeanBrandType: PROVIDER

MAESTRO

Maestro card (Mastercard) paymentMeanBrandType: CARD

MASTERCARD

Mastercard card paymentMeanBrandType: CARD

MASTERPASS

Deprecated - MasterPass paymentMeanBrandType:

ONEY34X

Payment in 3 or 4 times with Oney paymentMeanBrandType: ONLINE_CREDIT

PAYLIB

Paylib paymentMeanBrandType:

PAYPAL

Paypal paymentMeanBrandType: WALLET

PAYTRAIL

Paytrail paymentMeanBrandType: CREDIT_TRANSFER

PAY_BY_BANK

SEPA credit transfer paymentMeanBrandType: CREDIT_TRANSFER

SEPA_DIRECT_DEBIT

SDD (SEPA Direct Debit) paymentMeanBrandType: DIRECT_DEBIT

SOFINCO

Sofinco card paymentMeanBrandType: CARD

UNKNOWN

Unknown payment mean (this value can be returned by Sherlock’s but must not be used in a request)

VISA

Visa card paymentMeanBrandType: CARD

VISACHECKOUT

Deprecated - Visa Checkout wallet paymentMeanBrandType: WALLET

VISA_ELECTRON

Carte Visa Electron paymentMeanBrandType: CARD

VPAY

VPAY card (Visa) paymentMeanBrandType: CARD
paymentMeanBrandSelectionStatus

presence

Optional

Interface version

2.0

Format

ANS20(restricted values)

Status of the processing of the brand application selection on paypage.

List of values

APPLIED_DEFAULT

The cardholder accepted the default merchant choice

APPLIED_HOLDER

The cardholder selected a card brand different from the default merchant choice

Empty

Transaction not processed according to the payment mean brand selection rules

NOT_APPLICABLE

Card number filled is not a cobadged card
paymentTokenConsumerMerchantId

presence

Optional

Interface version

2.0

Format

N15

Identifier of the merchant who is authorized to consume the payment token on the services supporting it.
sealAlgorithm

presence

Optional

Interface version

2.0

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

            {
  "cardCSCValue": "123",
  "cardExpiryDate": "202212",
  "cardNumber": "1234123412341234",
  "interfaceVersion": "TR_WS_2.41",
  "keyVersion": "1",
  "merchantId": "001112233440000",
  "paymentMeanBrand": "VISA",
  "seal": "3f1d96361442af3ed0df832bf655d4de7349e9451b973a335514ab9f670d26ea"
}

                  <urn:paymentTokenGenerate>
         <urn:input>
            <urn:merchantId>001112233440000</urn:merchantId>
            <urn:interfaceVersion>TR_WS_2.41</urn:interfaceVersion>
            <urn:cardNumber>1234123412341234</urn:cardNumber>
            <urn:cardExpiryDate>202212</urn:cardExpiryDate>
            <urn:cardCSCValue>123</urn:cardCSCValue>
            <urn:paymentMeanBrand>VISA</urn:paymentMeanBrand>
         </urn:input>
      </urn:paymentTokenGenerate>

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

errorFieldName

presence

Optional

Interface version

2.0

Format

ANS50

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

presence

Optional

Interface version

2.0

Format

ANS1024

Hosted Fields payment token to be sent when making calls to Sherlock’s Office and allowing you to find card payment information for classic or 3-D Secure payment, by wallet or not.
responseCode

presence

Optional

Interface version

2.0

Format

N2(restricted values)

Sherlock’s server response code.
List of values
00

Operation accepted

01

For panToToken and tokenToPan methods, partial success

02

Request of authorized on via telephone with the issuer because of exceeding the card authorization threshold

03

Invalid merchant contract

05

Refused authorization

11

Used for differed check. The PAN is blocked

12

Invalid transaction. Please check the request parameters

14

Invalid PAN or payment mean data check is failed (e.g. card number or the visual cryptogram of the card or AVS address)

17

Customer cancellation
24
In response to a cash management operation: operation not authorized. The operation you wish to perform is not compliant with the transaction status or another operation is in progress at the same time

In response to a payment creation: operation rejected, request already carried out with the same data and the same parameters
25

Transaction unknown by Sherlock’s

30

Format error

34

Fraud suspicion (seal erroneous)

40

Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorized

51

Amount too high

54

Payment mean expiry date is past

55

Merchant doesn’t accept prepaid cards

57

Refund operation refused because the original transaction was subject of an unpaid

60

Transaction pending

62

Waiting the confirmation for the transaction (used by PayPal 1.0)

63

Security rules not observed, transaction stopped

75

Number of attempts to enter the data of the payment mean from Sherlock’s Paypage is exceeded

90

Service temporarily not available

94

Duplicated transaction: the transactionReference has been used previously

97

Session expired (no action from the user during 15 minutes), transaction refused

99

Temporarily problem with the payment server

Response sample

json
soap

            {
  "paymentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjoiWXpjNU16RmtNekE0TVRGaE5HTTBOamd6TlRFd016WTRPVFl6TkRVMllqVT0iLCJwcm9jZXNzSWQiOiI3N2Q1NzYyMDFhOTM0YzAyYWVkNzc2MzJkMDMxMTBmNCIsInVzZVR5cGUiOiJQQVlNRU5UIiwicHJvY2Vzc0ludGVyZmFjZSI6IlNJUFNfTUFDSElORV9UT19NQUNISU5FIn0.j4DZnnMupH4SAbgMIpuk-fSOqnKgZs27H1qXXmfIBY48lwdYzhRGN1KspIFhH25c-5Q_osjHyUu_4URQMdcU_w",
  "responseCode": "00",
  "seal": "338ce205c8de01746d1b8a42aeda9460473acf3c11027f3fc22469bd2bcdfd38",
}

                  <paymentTokenGenerateResponse xmlns="urn:sips:cn:contract:office:token:v2">
         <output>
            <responseCode>00</responseCode>
            <paymentToken>eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjoiWXpjNU16RmtNekE0TVRGaE5HTTBOamd6TlRFd016WTRPVFl6TkRVMllqVT0iLCJwcm9jZXNzSWQiOiI3N2Q1NzYyMDFhOTM0YzAyYWVkNzc2MzJkMDMxMTBmNCIsInVzZVR5cGUiOiJQQVlNRU5UIiwicHJvY2Vzc0ludGVyZmFjZSI6IlNJUFNfTUFDSElORV9UT19NQUNISU5FIn0.j4DZnnMupH4SAbgMIpuk-fSOqnKgZs27H1qXXmfIBY48lwdYzhRGN1KspIFhH25c-5Q_osjHyUu_4URQMdcU_w</paymentToken>
         </output>
      </paymentTokenGenerateResponse>

Changelog

Filter

Interface version	Data	Attendance
2.0	`cardCSCValue`	Request
2.0	`cardExpiryDate`	Request
2.0	`cardNumber`	Request
2.0	`interfaceVersion`	Request
2.0	`intermediateServiceProviderId`	Request
2.0	`merchantId`	Request
2.0	`paymentMeanBrand`	Request
2.0	`paymentMeanBrandSelectionStatus`	Request
2.0	`paymentTokenConsumerMerchantId`	Request
2.0	`sealAlgorithm`	Request
2.0	`keyVersion`	Request
2.0	`seal`	Request/Response
2.0	`errorFieldName`	Response
2.0	`paymentToken`	Response
2.0	`responseCode`	Response

paymentTokenGenerate

Endpoints

Request

Required

`keyVersion`

`seal`

Optional

`cardCSCValue`

`cardExpiryDate`

`cardNumber`

`interfaceVersion`

`intermediateServiceProviderId`

`merchantId`

`paymentMeanBrand`

`paymentMeanBrandSelectionStatus`

`paymentTokenConsumerMerchantId`

`sealAlgorithm`

Request sample

Response

Required

`seal`

Optional

`errorFieldName`

`paymentToken`

`responseCode`

Response sample

Changelog

Need help?