getCardMetaData
To search in the page use Ctrl+F on your keyboard
This function allows a merchant to retrieve informations linked to a scheme token thanks to its reference.
Endpoints
-
- PROD
-
https://office-server.sips-services.com/rs-services/v2/schemeToken/getCardMetaData
- method
- POST
-
- TEST
-
https://office-server.test.sips-services.com/rs-services/v2/schemeToken/getCardMetaData
- method
- POST
-
- PROD
-
https://office-server.sips-services.com/services/v2/schemeToken?wsdl
- method
- POST
-
- TEST
-
https://office-server.test.sips-services.com/services/v2/schemeToken?wsdl
- method
- POST
Request
Required
-
interfaceVersion
- presence
- Required
- Interface version
- 2.0
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
ST_WS_2.
- Sips Office (SOAP/JSON) interface for scheme token functions.
-
keyVersion
- presence
- Required
- Interface version
- 2.0
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
Identifier of the shop, this value is provided to the merchant by Worldline Sips during the shop registration.
-
schemeTokenReference
- presence
- Required
- Interface version
- 2.0
Scheme token reference
-
seal
- presence
- Required
- Interface version
- 2.0
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.0
Identifier of the Service used by the merchant for the exchanges with the Worldline Sips platform.
-
sealAlgorithm
- presence
- Optional
- Interface version
- 2.0
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
Response
Required
-
seal
- presence
- Required
- Interface version
- 2.0
Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
Optional
-
cardExpiryDate
- presence
- Optional
- Interface version
- 2.0
Card expiry date. If the card does not have any expiry date, this field is empty.
-
cardSuffix
- presence
- Optional
- Interface version
- 2.0
Last 4 digits of the card
-
errorFieldName
- presence
- Optional
- Interface version
- 2.0
Error field name of the incoming request. Present when responseCode = 12 or 30.
-
paymentAccountReference
- presence
- Optional
- Interface version
- 2.0
Reference of the bank account associated to the card used for the payment.
-
schemeTokenExpiryDate
- presence
- Optional
- Interface version
- 2.0
Scheme token expiry date
-
schemeTokenResponseCode
- presence
- Optional
- Interface version
- 2.0
Scheme token services specific response code
List of values
00
- Operation success
03
- Invalid scheme token option for the merchant
05
- Operation failure
12
- Invalid request
25
- Unknown scheme token
90
- Scheme token service error
99
- Technical error
-
schemeTokenStatus
- presence
- Optional
- Interface version
- 2.0
Current status of the scheme token
List of values
ACTIVE
- Scheme token is active
DELETED
- Scheme token is deleted
NOT_YET_ACTIVE
- Scheme token is not yet active
SUSPENDED
- Scheme token is suspended
Response sample
Changelog
Interface version | Data | Attendance | Container |
---|---|---|---|
2.0 |
intermediateServiceProviderId
|
Request | |
2.0 |
sealAlgorithm
|
Request | |
2.0 |
interfaceVersion
|
Request | |
2.0 |
keyVersion
|
Request | |
2.0 |
merchantId
|
Request | |
2.0 |
schemeTokenReference
|
Request | |
2.0 |
seal
|
Request/Response | |
2.0 |
cardExpiryDate
|
Response | |
2.0 |
cardSuffix
|
Response | |
2.0 |
errorFieldName
|
Response | |
2.0 |
paymentAccountReference
|
Response | |
2.0 |
schemeTokenExpiryDate
|
Response | |
2.0 |
schemeTokenResponseCode
|
Response | |
2.0 |
schemeTokenStatus
|
Response |