paymentMeanInfoInitialize
To search in the page use Ctrl+F on your keyboard
Allows to initialize a kinematic to consult the data related to a customer card. This kinematic is useful to perform the brand selection.
Endpoints
-
- PROD
-
https://office-server.sogenactif.com/rs-services/v2/paymentMeanInfoInApp/paymentMeanInfoInitialize
- method
- POST
-
- TEST
-
https://office-server-sogenactif.test.sips-services.com/rs-services/v2/paymentMeanInfoInApp/paymentMeanInfoInitialize
- method
- POST
Request
Required
-
interfaceVersion
- presence
- Required
- Interface version
- 1.0
Version value and number of the interface used.
List of values
AR_WS_2.
- Obsolete
AUT_WS_2.
- AUT_WS: Sogenactif Office Serveur (SOAP/JSON) interface for the Sogenactif authentication services.2.x: version referenced in the documentation of the function used by the merchant
CPR_WS_2.
- Obsolete
CR_WS_2.
- CR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Cash Management functions. 2.x: connector version used by the merchant
DR_WS_2.
- DR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Diagnostic functions. 2.x: connector version used by the merchant
FR_WS_2.
- FR_WS: Sogenactif Office Serveur (SOAP) interface for Fraud functions. 2.x: connector version used by the merchant
HP_x.x
- HP: Sogenactif Paypage (POST) interface. x.x: connector version used by the merchant
IR_MB_
- IR_MB: Sogenactif In-App (JSON) interface for Sogenactif In-App functions. 1.x: connector version used by the merchant
IR_WS_
- IR_WS: Sogenactif Paypage (SOAP/JSON) interface. x.x: connector version used by the merchant
IR_WS_2.
- IR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for payment request functions. 2.x: connector version used by the merchant
MR_WS_2.
- MR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for mandate management. 2.x: connector version used by the merchant
OR_WS_1.0
- OR_WS: Sogenactif Office Serveur (SOAP) interface for Sogenactif Office Serveur functions. 1.0: connector version used by the merchant
PMR_WS_2.
- PMR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for payment method repository information request functions. 2.x: connector version used by the merchant
POR_WS_2.
- Obsolete
TR_WS_2.
- TR_WS: Sogenactif Office Serveur (SOAP) interface for Token functions. 2.x: connector version used by the merchant
WMR_WS_2.
- WMR_WS: Sogenactif Walletpage interface 2.x: connector version used by the merchant
WR_WS_2.
- WR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Wallet functions. 2.x: connector version used by the merchant
-
keyVersion
- presence
- Required
- Interface version
- 1.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
- 1.0
Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
-
sdkOperationName
- presence
- Required
- Interface version
- 1.0
In the context of Sogenactif 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 Sogenactif for the initialization phase of an Sogenactif In-App transaction
CARDORDER
- Card payment for the initialization phase of an Sogenactif In-App transaction
GETWALLETDATA
- Consulting the information of a Wallet Sogenactif for the initialization phase of a transaction Sogenactif In-App
PAYMENTPROVIDERORDER
- Via an external partner for the initialization phase of an Sogenactif In-App transaction
PAYMENTTOKENGENERATE
- Generation of token for a payment Sogenactif In-App
THREEDSECUREANDORDER
- Card payment for the initialization phase of an Sogenactif In-App transaction with 3-D Secure authentication
THREEDSECUREANDWALLETORDER
- Payment means registered in the Wallet Sogenactif for the initialization phase of a transaction Sogenactif In-App with 3-D Secure authentication
WALLETORDER
- Payment with the Wallet Sogenactif for the initialization phase of an Sogenactif In-App transaction
-
seal
- presence
- Required
- Interface version
- 1.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
- 1.0
Identifier of the Service used by the merchant for the exchanges with the Sogenactif platform.
-
responseKeyVersion
- presence
- Optional
- Interface version
- 1.0
Identifier of the merchant’s secret key used to calculate the imprint of the response.
-
sdkVersion
- presence
- Optional
- Interface version
- 1.0
Version of the SDK used for a payment or operation Sogenactif In-App (Eg. 2.0.4)
-
sealAlgorithm
- presence
- Optional
- Interface version
- 1.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
{
"interfaceVersion" : "IR_MB_2.37",
"keyVersion" : "1",
"merchantId" : "011223344550000",
"sdkOperationName" : "GETCARDDATA",
"sdkVersion" : "SDK100",
"seal" : "b16c1749dcf97d8f341b3b6a4c5f025311b5b1488b1ed2276d11b5882aec49a3"
}
Response
Required
-
seal
- presence
- Required
- Interface version
- 1.0
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
In the context of a payment via Sogenactif In-App, value of the public key that Sogenactif sent to merchant in the response of initialisation in order to encrypt the card data that the merchant will send to Sogenactif.
-
redirectionData
- presence
- Optional
- Interface version
- 1.0
In case of 3-D Secure payment, contains the context of the transaction retrieved from the cardCheckEnrollment method. In case of 3-D Secure server Standalone, it contains the Payer Authentication Request (PAReq) that the merchant must transmit to ACS for 3-D Secure authentication (format: base 64 encoded).In case of external payment provider, contains the context of the transaction sent by the merchant during the transaction initialisation.
-
redirectionStatusCode
- presence
- Optional
- Interface version
- 1.0
Response code returned by Sogenactif when redirecting (e.g. redirecting to the ACS, to Sogenactif 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
Additional information that is returned with redirectionStatusCode.
-
redirectionUrl
- presence
- Optional
- Interface version
- 1.0
In case of an enrollment check, contains the redirection URL to the ACS required for the cardholder authentication. In case of Sogenactif 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
Version of the redirection message.
Response sample
{
"publicKeyValue":"30820122...10001",
"redirectionData":"4AgbsrffvP...HX8fZgp7PWdx",
"redirectionStatusCode":"00",
"redirectionStatusMessage":"Process succeeded",
"redirectionUrl":"https://office-server.sips-services.com/rs-api/public/v2/paymentMeanInfoInApp/getCardData",
"redirectionVersion":"IR_MB_2.37",
"seal":"45f82e1b2d330afafeb8ddd4c01fddac896b479b7fa66f5c5abceb1fd114a5a5"
}