signOff

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

This function allows to remove a wallet as well as its related payment means. If the account does not exist, a 01 response code is returned. If the deletion works, 00 response code is returned and the date of removal.

Recommended interfaceVersion: WR_WS_2.55

PROD

https://office-server.sips-services.com/rs-services/v2/wallet/signOff

method

POST
TEST

https://office-server.test.sips-services.com/rs-services/v2/wallet/signOff

method

POST

PROD

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

method

POST
TEST

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

WR_WS_2.

WR_WS: Sips Office (SOAP/JSON) interface for Wallet 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.
merchantWalletId
presence

Required

Interface version

2.0
Format
AN21(restricted String)
Customer’s Wallet identifier.
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.
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

Request sample

json
soap

            {
  "interfaceVersion": "WR_WS_2.3",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "merchantWalletId": "SIM01",
  "seal": "8217a6163368bee3b5baebc47a822d40327344ce578411055f95d6e5752d00f4"
}

                  <urn:signOff>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:interfaceVersion>WR_WS_2.2</urn:interfaceVersion>
            <urn:merchantWalletId>walId011</urn:merchantWalletId>
         </urn:input>
      </urn:signOff>

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

presence

Optional

Interface version

2.0

Format

ANS25 (ISO8601)

Date and time of the action on the wallet, in Worldline Sips system at the merchant’s local time (in the merchant’s time zone)
walletResponseCode

presence

Optional

Interface version

2.0

Format

N2(restricted values)

Worldline Sips server response code for wallet Management.

List of values

00

Successful operation

03

Invalid Merchant contract

12

Invalid data, verify the request

25

Wallet / payment mean unknown by Worldline Sips

30

Format error

40

merchantId not allowed to access this wallet service

94

Duplicated wallet / payment mean

99

Temporary problem at the Worldline Sips server level

Response sample

json
soap

            {
  "walletActionDateTime": "2014-05-19T23:20:25-12:00",
  "walletResponseCode": "00",
  "seal": "8ff8b4302b5eeda23bad2d556dd539c2b3991f8dcd4deb66e338df3a1f59ebe6"
}

                  <signOffResponse xmlns="urn:sips:cn:contract:office: wallet:v2">
         <output>
            <walletActionDateTime>2012-10-17T23:50:44-12:00</walletActionDateTime>
            <walletResponseCode>00</walletResponseCode>
            <errorFieldName />
         </output>
      </signOffResponse>

Changelog

Filter

Interface version	Data	Attendance
2.12	`intermediateServiceProviderId`	Request
2.12	`sealAlgorithm`	Request
2.0	`interfaceVersion`	Request
2.0	`keyVersion`	Request
2.0	`merchantId`	Request
2.0	`merchantWalletId`	Request
2.0	`seal`	Request/Response
2.0	`errorFieldName`	Response
2.0	`walletActionDateTime`	Response
2.0	`walletResponseCode`	Response

Need help?

Consulting the faq

WL SIPS DOCS

signOff

Endpoints

Request

Required

`interfaceVersion`

`keyVersion`

`merchantId`

`merchantWalletId`

`seal`

Optional

`intermediateServiceProviderId`

`sealAlgorithm`

Request sample

Response

Required

`seal`

Optional

`errorFieldName`

`walletActionDateTime`

`walletResponseCode`

Response sample

Changelog

Need help?