Automatic and manual response Walletpage

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

Manual and automatic response for Sogenactif Walletpage containing the wallet information

Response

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

Optional

businessName
presence

Optional

Interface version

2.0
Format
ANU255(restricted String)
Business name.
company
presence

Optional

Interface version

2.0
Format
ANU50(restricted String)
Company for the address.
customerId
presence

Optional

Interface version

2.0
Format
AN19(restricted String)
Customer identifier

Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data

As a subcontractor, SG processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.

Thus:
- The personal data specified in the DPA must only be transmitted to SG via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to SG.
customerIpAddress

presence

Optional

Interface version

2.0

Format

ipAddress

Buyer’s IP address.
legalId

presence

Optional

Interface version

2.0

Format

AN14

Legal business identifier (SIRET in France). This field is applicable for merchant or customer (please see fields Contact).
merchantId

presence

Optional

Interface version

2.0

Format

N15

Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
merchantSessionId
presence

Optional

Interface version

2.0
Format
AN256(restricted String)
Merchant’s session number. Allows consolidation between requests and responses.
merchantWalletId
presence

Optional

Interface version

2.0
Format
AN21(restricted String)
Customer’s Wallet identifier.
positionOccupied

presence

Optional

Interface version

2.0

Format

ANS150

Position occupied.
returnContext

presence

Optional

Interface version

2.0

Format

ANS255

Context of a buyer’’s order.All information transmitted in this field by the merchant during the payment request is sent back in the response without amendment.Attention : the following characters “|”, “«”, “»”, and «”» are not recommended in this field. If they are used, they will be returned as provided but they will be replaced by blanks in the Sogenactif database.

Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data

As a subcontractor, SG processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.

Thus:
- The personal data specified in the DPA must only be transmitted to SG via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to SG.
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
walletCreationDateTime

presence

Optional

Interface version

2.0

Format

ANS25 (ISO8601)

Date and time of the payment mean enrollment, in Sogenactif system at the merchant’s local time (in the merchant’s time zone)
walletLastActionDateTime

presence

Optional

Interface version

2.0

Format

ANS25 (ISO8601)

Date and time of the last action on the wallet, in Sogenactif system at the merchant’s local time (in the merchant’s time zone)
walletPaymentMeanDataList

presence

Optional

Interface version

2.0

Format

Composite list

List, contains specific information regarding the payment mean registered in the wallet.
Contains
- paymentMeanAlias
  presence
  
  Optional
  
  Interface version
  
  2.0
  Format
  
  ANU20(restricted String)
  Payment mean alias defined by the Buyer and used in the Buyer’s wallet.
  
  Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data
  
  As a subcontractor, SG processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
  
  Thus:
  - The personal data specified in the DPA must only be transmitted to SG via the fields provided for this purpose (see data dictionary).
  - All other personal data not listed in the DPA must not be transmitted to SG.
- transactionActors
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  A4(restricted values)
  
  Indicates the players in the transaction.
  
  List of values
  
  BTOB
  
  Business to Business
  
  BTOC
  
  Business to Consumer
  
  BTOF
  
  Business to organization / association
- panExpiryDate
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  N6(YYYYMM)
  
  Expiry date of an instrument associated with a Primary Account Number.For example, for a card, it contains the expiry date for an authorisation request operation. If the payment method does not have a validity date, this field should be empty.
- paymentMeanId
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  N6
  
  Payment mean rank in Sogenactif wallet.
- 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
- 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 Sogenactif 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
- mandateId
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  AN35
  
  Mandate number.
- maskedPan
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  NS19
  
  Masked Primary Account Number. In the case of wallets, masked PAN of the payment mean registered in the wallet.

            {
"keyVersion":1,
"customerIpAddress":"10.X.X.X",
"merchantId":"029000254447216",
"merchantWalletId":"2",
"walletCreationDateTime":"2022-10-19.12:58:01+0200",
"walletLastActionDateTime":"2023-11-27.18:00:54+0100",
"sealAlgorithm":"sha256",
"walletPaymentMeanDataList":[
{
"paymentMeanId":"28",
"paymentMeanAlias":"carte cb",
"paymentMeanBrand":"CB",
"maskedPan":"############0400",
"panExpiryDate":"202401",
"paymentMeanBrandSelectionStatus":"NOT_APPLICABLE"
}
]
}

            merchantId=029000254447216|keyVersion=1|merchantWalletId=2|merchantSessionId=null|customerId=null|customerIpAddress=10.X.X.X|returnContext=null|walletCreationDateTime=2022-10-19T12:58:01+02:00|walletLastActionDateTime=2023-11-27T18:00:14+01:00|walletPaymentMeanDataList={paymentMeanId=27, paymentMeanAlias=carte cb, paymentMeanBrand=CB, maskedPan=############0400, panExpiryDate=202401, mandateId=null, transactionActors=null, paymentMeanBrandSelectionStatus=NOT_APPLICABLE}|customerCompanyName=null|customerBusinessName=null|customerLegalId=null|customerPositionOccupied=null

Changelog

Filter

Interface version	Data	Attendance	Container
2.0	`businessName`	Response
2.0	`company`	Response
2.0	`customerId`	Response
2.0	`customerIpAddress`	Response
2.0	`legalId`	Response
2.0	`merchantId`	Response
2.0	`merchantSessionId`	Response
2.0	`merchantWalletId`	Response
2.0	`positionOccupied`	Response
2.0	`returnContext`	Response
2.0	`sealAlgorithm`	Response
2.0	`walletCreationDateTime`	Response
2.0	`walletLastActionDateTime`	Response
2.0	`walletPaymentMeanDataList`	Response
2.0	`paymentMeanAlias`	Container	`walletPaymentMeanDataList`
2.0	`transactionActors`	Container	`walletPaymentMeanDataList`
2.0	`panExpiryDate`	Container	`walletPaymentMeanDataList`
2.0	`paymentMeanId`	Container	`walletPaymentMeanDataList`
2.0	`paymentMeanBrandSelectionStatus`	Container	`walletPaymentMeanDataList`
2.0	`paymentMeanBrand`	Container	`walletPaymentMeanDataList`
2.0	`mandateId`	Container	`walletPaymentMeanDataList`
2.0	`maskedPan`	Container	`walletPaymentMeanDataList`
2.0	`keyVersion`	Response

Automatic and manual response Walletpage

Response

Required

`keyVersion`

Optional

`businessName`

`company`

`customerId`

`customerIpAddress`

`legalId`

`merchantId`

`merchantSessionId`

`merchantWalletId`

`positionOccupied`

`returnContext`

`sealAlgorithm`

`walletCreationDateTime`

`walletLastActionDateTime`

`walletPaymentMeanDataList`

`paymentMeanAlias`

`transactionActors`

`panExpiryDate`

`paymentMeanId`

`paymentMeanBrandSelectionStatus`

`paymentMeanBrand`

`mandateId`

`maskedPan`

Response sample

Changelog

Need help?