panToToken

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

This operation allows to tokenize a card number.

Recommended interfaceVersion: TR_WS_2.53

Endpoints

json
soap

PROD

https://office-server.sips-services.com/rs-services/v2/token/panToToken

method

POST
TEST

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

method

POST

PROD

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

method

POST
TEST

https://office-server.test.sips-services.com/services/v2/token?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

TR_WS_2.

Sips Office (SOAP) interface for Token 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 Worldline Sips 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.

Optional

intermediateServiceProviderId

presence

Optional

Interface version

2.12

Format

AN30

Identifier of the Service used by the merchant for the exchanges with the Worldline Sips platform.
panDataList

presence

Optional

Interface version

2.0

Format

Composite list

List of PAN to be converted into token PAN.
Contains
- panData
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  Container
  
  It contains the PAN data to be converted into token PAN.
  Contains
  - 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.
  - pan
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    N19 or ANS35
    
    PAN (Primary Account Number).May contain a converted Token PAN (from PAN) in the container responsePanData (in which case, its format will ANS35)
  - panId
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    N5
    
    Sequence number of PAN in the list. This number is the same between the request and the response
paymentToken

presence

Optional

Interface version

2.39

Format

ANS1024

Hosted Fields payment token to be sent when making calls to Sips Office and allowing you to find card payment information for classic or 3-D Secure payment, by wallet or not.
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

            {
  "interfaceVersion": "TR_WS_2.0",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "panDataList": [
    {
      "pan": "4907000000000600",
      "panId": "1"
    }
  ],
  "userId": "uid",
  "seal": "8f95bd9cc96c7723b530f0492c9fed50399b94f9b0c91c113b4f56a97fe2cb8f"
}

                  <urn:panToToken>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:interfaceVersion>TR_WS_2.0</urn:interfaceVersion>
            <urn:userId>uid</urn:userId>
            <urn:panDataList>
               <urn:panData>
                  <urn:panId>2</urn:panId>
                  <urn:pan>4907000000000600</urn:pan>
               </urn:panData>
            </urn:panDataList>
         </urn:input>
      </urn:panToToken>

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

Worldline Sips 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 Worldline Sips

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 Sips 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
responseTokenPanDataList

presence

Optional

Interface version

2.0

Format

Composite list

List of responses returned during the PAN conversion.
Contains
- responseTokenPanData
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  Container
  
  Responses returned during the PAN conversion.
  Contains
  - panId
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    N5
    
    Sequence number of PAN in the list. This number is the same between the request and the response
  - tokenPan
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    AN35(restricted String)
    
    Unique identifier for a PAN returned by the Worldline Sips server via the AWL token server in a merchant-oriented format (the format is a parameter in the merchant’s configuration).
  - tokenResponseCode
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    N2(restricted values)
    
    Response code of each PAN to token conversion.
    
    List of values
    
    00
    
    Successful operations
    
    01
    
    At least one operation is not successful
    
    03
    
    Invalid merchant contract
    
    40
    
    merchantId not allowed to access this token service
    
    90
    
    Technical error with tokenizer
    
    99
    
    Technical error with the request

Response sample

json
soap

            {
  "responseCode": "00",
  "responseTokenPanDataList": [
    {
      "tokenResponseCode": "00",
      "panId": "1",
      "tokenPan": "490700h719850600"
    }
  ],
  "seal": "a16689b166fa9a508341fad15563633bb83367d009d3f2507c95bc71cd9f1ad5"
}

                  <panToTokenResponse xmlns="urn:sips:cn:contract:office:token:v2">
         <output>
            <responseCode>00</responseCode>
            <responseTokenPanDataList>
               <responseTokenPanData>
                  <tokenResponseCode>00</tokenResponseCode>
                  <panId>2</panId>
                  <tokenPan>490700h719850600</tokenPan>
               </responseTokenPanData>
            </responseTokenPanDataList>
         </output>
      </panToTokenResponse>

Changelog

Filter

Interface version	Data	Attendance	Container
2.12	`intermediateServiceProviderId`	Request
2.0	`panDataList`	Request
2.0	`panData`	Container	`panDataList`
2.0	`cardExpiryDate`	Container	`panData`
2.0	`pan`	Container	`panData`
2.0	`panId`	Container	`panData` `responseTokenPanData`
2.39	`paymentToken`	Request
2.12	`sealAlgorithm`	Request
2.0	`interfaceVersion`	Request
2.0	`keyVersion`	Request
2.0	`merchantId`	Request
2.0	`seal`	Request/Response
2.21	`errorFieldName`	Response
2.0	`responseCode`	Response
2.0	`responseTokenPanDataList`	Response
2.0	`responseTokenPanData`	Container	`responseTokenPanDataList`
2.0	`tokenPan`	Container	`responseTokenPanData`
2.0	`tokenResponseCode`	Container	`responseTokenPanData`

Need help?

Consulting the faq

WL SIPS DOCS

panToToken

Endpoints

Request

Required

`interfaceVersion`

`keyVersion`

`merchantId`

`seal`

Optional

`intermediateServiceProviderId`

`panDataList`

`panData`

`cardExpiryDate`

`pan`

`panId`

`paymentToken`

`sealAlgorithm`

Request sample

Response

Required

`seal`

Optional

`errorFieldName`

`responseCode`

`responseTokenPanDataList`

`responseTokenPanData`

`panId`

`tokenPan`

`tokenResponseCode`

Response sample

Changelog

Need help?