addCard

Pour rechercher dans la page utiliser Ctrl+F sur votre clavier

Cette opération permet d’ajouter une carte à un wallet. Ce dernier est créé en même temps que l’ajout de la carte, s’il n’existe pas.

Les informations sensibles (numéro de carte) peuvent être gérées via le champ panType, chiffrement par l’utilisation du mode CSE (voir la documentation concernée).

Si la carte est déjà enregistrée dans le wallet, un code de réponse 94 est retourné.

Si la création a réussi, un code de réponse 00 est retourné ainsi que de nombreuses informations sur le compte et la carte associée

identifiant wallet
date de création
identifiant externe du moyen de paiement créé pour le wallet
numéro de carte partiellement masqué (seuls les 4 premiers chiffres et 2 derniers sont affichés).

interfaceVersion recommandée : WR_WS_2.53

PROD

https://office-server.sogenactif.com/rs-services/v2/wallet/addCard

méthode

POST
TEST

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

méthode

POST

PROD

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

méthode

POST
TEST

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

méthode

POST

Requête

Obligatoire

cardExpiryDate

présence

Obligatoire

Interface version

2.0

Format

N6(YYYYMM)

Date d’expiration de la carte. Si la carte n’a pas de date d’expiration, ce champ doit être vide.
cardNumber

présence

Obligatoire

Interface version

2.0

Format

N19/ANS128

Numéro de la carte (format N19 sauf si le numéro de la carte est un Token, auquel cas, son format est ANS128).
interfaceVersion
présence

Obligatoire

Interface version

2.0
Format
AN20(restricted String)
Version de l’interface utilisée. Elle est composée d’un préfixe qui varie selon la fonction utilisée et d’un numéro de version (ex : IR_WS_2.47).

Veuillez-vous référer à la page de la fonction pour connaître la valeur à utiliser. Utilisez le dernier numéro d’interfaceVersion.

Liste des valeurs

WR_WS_2.

interface Sogenactif Office Serveur (SOAP/JSON) pour les fonctions liées au wallet.
keyVersion

présence

Obligatoire

Interface version

2.0

Format

N10

Version de la clé secrète du commerçant utilisée pour calculer l’empreinte du message (clé stockée par le commerçant pour vérifier l’empreinte des notifications automatiques et manuelles).
merchantId

présence

Obligatoire

Interface version

2.0

Format

N15

Identifiant de la boutique, sa valeur est fournie par Sogenactif au commerçant lors de l’inscription de sa boutique.
merchantWalletId
présence

Obligatoire

Interface version

2.0
Format
AN21(restricted String)
Identifiant du portefeuille virtuel du client.
seal

présence

Obligatoire

Interface version

2.0

Format

ANS128

Sceau du message utilisé pour assurer l’intégrité de la requête et l’authentification de l’émetteur/destinataire du message (partage de la clé secrète).

Optionnel

intermediateServiceProviderId

présence

Optionnel

Interface version

2.12

Format

AN30

Identifiant du service utilisé par le commerçant pour les échanges de flux avec la plateforme Sogenactif.
panType

présence

Optionnel

Interface version

2.31

Format

ANS20(restricted values)

Format du PAN fourni dans la donnée cardNumber.

Liste des valeurs

CSE

Le PAN fourni est chiffré par la bibliothèque Javascript CSE (Client Side Encryption)

PAN

Le PAN est fourni en clair

STKPAN

Le PAN fourni est sous forme de SchemeToken

TOKEN_PAN

Le PAN fourni est sous forme de token

VCO_PAN

Obsolète
paymentMeanAlias
présence

Optionnel

Interface version

2.0
Format
ANU20(restricted String)
Alias du moyen de paiement défini par l’acheteur et utilisé dans son portefeuille virtuel.

Attention : utiliser ce champ libre uniquement pour l’usage prévu, et par conséquent ne pas y insérer des données à caractère personnel, et plus particulièrement des données de porteur de carte. En cas de non-respect de cette consigne SG ne serait être tenu responsable d’un point de vu légal, de tout incident qui pourrait survenir.

En tant que sous-traitant, SG traite les données à caractère personnel conformément aux Conditions de Traitement des Données à Caractère Personnel (CTDCP), annexées à tous les contrats.

Ainsi :
- Les données personnelles prévues par le CTDCP doivent uniquement être transmises à SG au travers des champs prévus à cet effet (cf. dictionnaire des données).
- Toutes autres données à caractère personnel non listées dans le CTDCP ne doivent pas être transmises à SG
paymentMeanBrand

présence

Optionnel

Interface version

2.20

Format

ANS20(restricted values)

Nom du moyen de paiement utilisé. Il est lié à un paymentMeanType.

Liste des valeurs

1EUROCOM

Cofidis Pay 5x10x20x Contrat d’acquisition : ONLINE_CREDIT

3XCBCOFINOGA

Valeur Obsolète. Cofinoga 3xCB paymentMeanBrandType : CARD

ACCEPTGIRO

AcceptGiro paymentMeanBrandType : CREDIT_TRANSFER

AIRPLUS

Carte Airplus paymentMeanBrandType : CARD

AIRPLUS_LOGEE

Carte Airplus logée paymentMeanBrandType : CARD

AMEX

Carte American Express paymentMeanBrandType : CARD

AMEX_LOGEE

Carte American Express logée paymentMeanBrandType : CARD

AURORE

Carte CPAY paymentMeanBrandType : CARD

BCACB_3X

Floa Bank CB paiement en 3 fois paymentMeanBrandType : ONLINE_CREDIT

BCACB_4X

Floa Bank CB paiement en 4 fois paymentMeanBrandType : ONLINE_CREDIT

BCACUP

Carte CUP de Floa Bank paymentMeanBrandType : CARD

BCMC

Bancontact paymentMeanBrandType : CARD

CACF_3X

CACF paiement en 3 fois paymentMeanBrandType : ONLINE_CREDIT

CACF_3XSANSFRAIS

CACF paiement en 3 fois sans frais paymentMeanBrandType : ONLINE_CREDIT

CACF_4X

CACF paiement en 4 fois paymentMeanBrandType : ONLINE_CREDIT

CACF_4XSANSFRAIS

CACF paiement en 4 fois sans frais 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

Carte China UnionPay paymentMeanBrandType : CARD

CVA

Carte Visa Aurore paymentMeanBrandType : CARD

CVCO

Chèque-Vacances Connect paymentMeanBrandType : VOUCHER

DINERS

Carte Diners club international paymentMeanBrandType : CARD

ELV

Elektronisches LastschriftVerfahren paymentMeanBrandType : DIRECT_DEBIT

FIVORY

Lyf Pay paymentMeanBrandType : WALLET

FRANFINANCE_3X

Franfinance 3xCB paymentMeanBrandType : ONLINE_CREDIT

FRANFINANCE_4X

Franfinance 4xCB paymentMeanBrandType : ONLINE_CREDIT

GIROPAY

Giropay paymentMeanBrandType : CREDIT_TRANSFER

IDEAL

iDeal 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

Carte Maestro (Mastercard) paymentMeanBrandType : CARD

MASTERCARD

Carte Mastercard paymentMeanBrandType : CARD

MASTERPASS

Obsolète - Portefeuille virtuel MasterPass paymentMeanBrandType :

ONEY34X

Oney Paiement 3 fois ou 4 fois paymentMeanBrandType : ONLINE_CREDIT

PAYLIB

Portefeuille virtuel Paylib paymentMeanBrandType :

PAYPAL

Paypal paymentMeanBrandType : WALLET

PAYTRAIL

Paytrail paymentMeanBrandType : CREDIT_TRANSFER

PAY_BY_BANK

Virement bancaire SEPA paymentMeanBrandType : CREDIT_TRANSFER

PRESTO

Presto Plus paymentMeanBrandType : ONLINE_CREDIT

SEPA_DIRECT_DEBIT

SDD (SEPA Direct Debit) paymentMeanBrandType : DIRECT_DEBIT

SOFINCO

Carte Sofinco paymentMeanBrandType : CARD

SOFORTUBERWEISUNG

Sofortüberweisung (Sofort Banking) paymentMeanBrandType : CREDIT_TRANSFER

UNKNOWN

Moyen de paiement inconnu (cette valeur peut être retournée par Sogenactif mais ne doit pas être utilisée dans une requête)

VISA

Carte Visa paymentMeanBrandType : CARD

VISACHECKOUT

Obsolète - Portefeuille virtuel Visa Checkout paymentMeanBrandType : WALLET

VISA_ELECTRON

Carte Visa Electron paymentMeanBrandType : CARD

VPAY

Carte VPAY (Visa) paymentMeanBrandType : CARD
paymentMeanBrandSelectionStatus

présence

Optionnel

Interface version

2.36

Format

ANS20(restricted values)

Statut du traitement de la sélection de la marque sur la page de paiement.

Liste des valeurs

APPLIED_DEFAULT

Le porteur a accepté la marque par défaut proposée par le commerçant

APPLIED_HOLDER

Le porteur a choisi une marque différente de celle proposée par défaut par le commerçant

Empty

La transaction n’est pas traitée selon les modalités de la sélection de la marque

NOT_APPLICABLE

La carte utilisée n’est pas co-badgée
paymentToken

présence

Optionnel

Interface version

2.38

Format

ANS1024

Jeton de paiement Hosted Fields à transmettre lors des appels à Sogenactif Office Serveur et permettant de trouver les informations de paiement carte lors de paiement classique ou 3-D Secure, par wallet ou non.
sealAlgorithm

présence

Optionnel

Interface version

2.12

Format

ANS20(restricted values)

Algorithme de cryptage utilisé pour le calcul du sceau.

Liste des valeurs

HMAC-SHA-256

L’algorithme de cryptage utilisé est HMAC-SHA-256

HMAC-SHA-512

L’algorithme de cryptage utilisé est HMAC-SHA-512

SHA-256

L’algorithme de cryptage utilisé est SHA-256

Exemple de requête

json
soap

            {
  "cardExpiryDate": "201405",
  "cardNumber": "5219000000000000",
  "interfaceVersion": " WR_WS_2.3",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "merchantWalletId": "iDWal1",
  "paymentMeanAlias": "myvisacard",
  "paymentMeanbrand": "VISA",
  "seal": "4b7beed20ff443b3c05cc904bcd793ba6cace54b9ff669cf26d8576e267dc03c"
}

                  <urn:addCard>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:interfaceVersion>WR_WS_2.2</urn:interfaceVersion>
            <urn:cardNumber>5219000000000000</urn:cardNumber>
            <urn:cardExpiryDate>201405</urn:cardExpiryDate>
            <urn:merchantWalletId>walId011</urn:merchantWalletId>
            <urn:paymentMeanAlias>ma carte visa</urn:paymentMeanAlias>
            <urn:paymentMeanBrand>VISA</urn:paymentMeanBrand>
         </urn:input>
      </urn:addCard>

Réponse

Obligatoire

seal

présence

Obligatoire

Interface version

2.0

Format

ANS128

Sceau du message utilisé pour assurer l’intégrité de la requête et l’authentification de l’émetteur/destinataire du message (partage de la clé secrète).

Optionnel

errorFieldName

présence

Optionnel

Interface version

2.0

Format

ANS50

Nom du champ en erreur dans la requête. Présent lorsque responseCode = 12 ou 30.
maskedPan

présence

Optionnel

Interface version

2.0

Format

NS19

Numéro de PAN masqué. Dans le cas des portefeuilles virtuels, correspond au numéro de PAN masqué du moyen de paiement enregistré dans le portefeuille virtuel.
paymentMeanId

présence

Optionnel

Interface version

2.0

Format

N6

Rang du moyen de paiement au sein du wallet Sogenactif.
walletActionDateTime

présence

Optionnel

Interface version

2.0

Format

ANS25 (ISO8601)

Date / Heure de l’action sur le portefeuille virtuel, enregistrées dans le système Sogenactif à l’heure locale du commerçant (dans le fuseau horaire du commerçant).
walletResponseCode

présence

Optionnel

Interface version

2.0

Format

N2(restricted values)

Code réponse du serveur Sogenactif pour la gestion du portefeuille virtuel.

Liste des valeurs

00

Opération réalisée avec succès

03

Marchand inconnu / le marchand n’a pas de groupId configuré

12

Données invalides, vérifiez la requête

25

Wallet/Moyen de paiement inconnu

30

Erreur de format

40

Le marchandId n’a pas l’option wallet

94

Wallet/Moyen de paiement dupliqué

99

Problème temporaire au niveau du serveur Sogenactif

Exemple de réponse

json
soap

            {
  "walletActionDateTime": "2014-03-19T23:15:03-12:00",
  "paymentMeanId": "13",
  "maskedPan": "4977##########55",
  "walletResponseCode": "00",
  "seal": "a6671feade95c57085939fe973e8455a5c7a81d465f78f1b94c22f8b29a2b751"
}

                  <addCardResponse xmlns="urn:sips:cn:contract:office:wallet:v2">
         <output>
            <walletActionDateTime>2012-10-17T23:50:44-12:00</walletActionDateTime>
            <paymentMeanId>2</paymentMeanId>
            <maskedPan>5219##########00</maskedPan>
            <walletResponseCode>00</walletResponseCode>
            <errorFieldName />
         </output>
      </addCardResponse>

Changelog

Filtre

Interface version	Donnée	Présence
2.12	`intermediateServiceProviderId`	Requête
2.31	`panType`	Requête
2.0	`paymentMeanAlias`	Requête
2.20	`paymentMeanBrand`	Requête
2.36	`paymentMeanBrandSelectionStatus`	Requête
2.38	`paymentToken`	Requête
2.12	`sealAlgorithm`	Requête
2.0	`cardExpiryDate`	Requête
2.0	`cardNumber`	Requête
2.0	`interfaceVersion`	Requête
2.0	`keyVersion`	Requête
2.0	`merchantId`	Requête
2.0	`merchantWalletId`	Requête
2.0	`seal`	Requête/Réponse
2.0	`errorFieldName`	Réponse
2.0	`maskedPan`	Réponse
2.0	`paymentMeanId`	Réponse
2.0	`walletActionDateTime`	Réponse
2.0	`walletResponseCode`	Réponse

addCard

Urls des environnements

Requête

Obligatoire

`cardExpiryDate`

`cardNumber`

`interfaceVersion`

`keyVersion`

`merchantId`

`merchantWalletId`

`seal`

Optionnel

`intermediateServiceProviderId`

`panType`

`paymentMeanAlias`

`paymentMeanBrand`

`paymentMeanBrandSelectionStatus`

`paymentToken`

`sealAlgorithm`

Exemple de requête

Réponse

Obligatoire

`seal`

Optionnel

`errorFieldName`

`maskedPan`

`paymentMeanId`

`walletActionDateTime`

`walletResponseCode`

Exemple de réponse

Changelog

Besoin d'aide ?