S-money API

Create a stored card paiement with 3DS V2

Michel Ruckebusch — 2020-03-11T18:02:10Z

Request
POST /api/[domaine_partenaire]/payins/storedcardpayments
Accept : application/vnd.s-money.v3+json
Content-Type : application/vnd.s-money.v3+json
Authorization : Bearer ACCESS_TOKEN

{ 
 "amount":9600,
 "fee":{ 
 "amountWithVAT":400,
 "VAT":20
 },
 "ThreeDsecurePreference":0,
 "orderId":"orderabc",
 "accountId":{ 
 "appaccountid":" user-abc "
 },
 "card":{ 
 "appCardId":"card123"
 },
 "ismine":true,
 "message":"orderID: orderabc",
 "extraparameters":{ 
 "profilename":"3DSV2"
 },
 "urlReturn":"https://www.domaine.fr/paiement-termine-iframe",
 "urlCallback":"https://www.domaine.fr/smoneycallbak",
 "Billing":{ 
 "City":"Paris",
 "Country":"FR",
 "Address":"1 rue de paris",
 "PostalCode":"75001",
 "Billingaddressstate":"california "
 },
 "ShipTo":{ 
 "City":"Paris",
 "Country":"FR",
 "Address":"1 rue de paris",
 "PostalCode":"75001",
 "AddressType":0,
 "AddressState":"california ",
 "AddressDate":"2018-01-10"
 },
 "Delivery":{ 
 "email":"pierre@dupont.fr",
 "timeframe":"sameday"
 },
 "ClientScreen":{ 
 "ColorDepth":32,
 "ScreenHeight":1280,
 "ScreenWidth":1024
 },
 "ThreeDsOptData":{ 
 "AccountChangeDate":"2018-01-10",
 "AccountCreationDate":"2018-01-10",
 "ClientAuthMethod":"guest",
 "Passwordchangedate":"2018-01-10",
 "Last6MonthsPurchaseCount":4,
 "Last24hoursaddcardattempts":2,
 "Last24hourstransactioncount":4,
 "Last12Monthstransactioncount":4,
 "Cardenrolldate":"2018-01-01",
 "Suspiciousaccountactivity":false,
 "Homephone":"+33133333333",
 "Mobilephone":"+33633333333",
 "Workphone":"+33633333333",
 "Giftcard":{ 
 "Amount ":"100",
 "Count":"2",
 "Currency":"EUR"
 },
 "Preorderdate":"2020-01-04",
 "Itemavailability":true,
 "Reorderingitem":false,
 "Recurringexpiry":"2020-01-04",
 "recurringfrequency":10
 }

}

Response
HTTP/1.1 201 CREATED

{ 
 "OperationId":517,
 "PayinTokenId":"1-2bsKDL",
 "ExtraData":" %7B%22IsSchedule%22%3Afalse%2C%22Profile%22%3Aprofilename%2C%22Cards%22%3Anull%2C%22UrlReturn%22%3A%22http%25253A%25252F%25252Fwww.domaine.fr%25252Fpaiement-termine-iframe%22%7D ",
 "Id":517,
 "OrderId":"orderabc",
 "Amount":9600,
 "fee":{ 
 "amountWithVAT":400,
 "VAT":20
 },
 "Status":0,
 "ThreeDsecurePreference":0,
 "accountId":{ 
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{ 
 "appcardid":"card123",
 "href":"/api/cards/card123"
 },
 "IsMine":false,
 "PaymentDate":"2018-11-12T15:14:54.943324+01:00",
 "Message":"commande orderID:orderabc",
 "extraparameters":{ 
 "profilename":"3DSV2"
 },
 "Refunds":null,
 "ErrorCode":0,
 "ExtraResults":{ 
 "threedsecure":null,
 "threedsecureauthstatus":null,
 "threedsecuresignaturestatus":null,
 "threedsecureglobalstatus":null,
 "ThreeDsCardEnrolled":null,
 "ExecCode":"0000",
 "ExecMessage":"Successful operation",
 "warrantyresult":true,
 "3dsecureversion":null,
 "3dsecuremode":null,
 "bankauthresult":null
 },
 "urlReturn":"https://www.domaine.fr/paiement-termine-iframe",
 "urlCallback":"https://www.domaine.fr/smoneycallbak",
 "Billing":{ 
 "City":"Paris",
 "Country":"FR",
 "Address":"1 rue de paris",
 "PostalCode":"75001",
 "Billingaddressstate":"california "
 },
 "ShipTo":{ 
 "City":"Paris",
 "Country":"FR",
 "Address":"1 rue de paris",
 "PostalCode":"75001",
 "AddressType":0,
 "AddressState":"california ",
 "AddressDate":"2018-01-10"
 },
 "Delivery":{ 
 "email":"pierre@dupont.fr",
 "timeframe":"sameday"
 },
 "ClientScreen":{ 
 "ColorDepth":32, 
 "ScreenHeight":1280,
 "ScreenWidth":1024
 },
 "ThreeDsOptData":{ 
 "AccountChangeDate":"2018-01-10",
 "AccountCreationDate":"2018-01-10",
 "ClientAuthMethod":"guest",
 "Passwordchangedate":"2018-01-10",
 "Last6MonthsPurchaseCount":4,
 "Last24hoursaddcardattempts":2,
 "Last24hourstransactioncount":4,
 "Last12Monthstransactioncount":4,
 "Cardenrolldate":"2018-01-01",
 "Suspiciousaccountactivity":false,
 "Homephone":"+33133333333",
 "Mobilephone":"+33633333333",
 "Workphone":"+33633333333",
 "Giftcard":{ 
 "Amount ":"100",
 "Count":"2",
 "Currency":"EUR"
 },
 "Preorderdate":"2020-01-04",
 "Itemavailability":true,
 "Reorderingitem":false,
 "Recurringexpiry":"2020-01-04",
 "recurringfrequency":10
 }

}

Retrieve a stored card paiment

Michel Ruckebusch — 2020-03-11T18:01:05Z

Request
GET /api/[domaine_partenaire]/payins/storedcardpayments/orderid
Accept : application/vnd.s-money.v3+json
Content-Type : application/vnd.s-money.v3+json
Authorization : Bearer ACCESS_TOKEN

Response
HTTP/1.1 200 OK

{ 
 "Id":517,
 "OrderId":"orderabc",
 "Amount":9600,
 "fee":{ 
 "amountWithVAT":400,
 "VAT":20
 },
 "Status":0,
 "ThreeDsecurePreference":0,
 "accountId":{ 
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{ 
 "appcardid":"card123",
 "href":"/api/cards/card123"
 },
 "IsMine":false,
 "PaymentDate":"2018-11-12T15:14:54.943324+01:00",
 "Message":"commande orderID:orderabc",
 "extraparameters":{ 
 "profilename":"3DSV2"
 },
 "Refunds":null,
 "ErrorCode":0,
 "ExtraResults":{ 
 "threedsecure":"true",
 "threedsecureauthstatus":"y",
 "threedsecuresignaturestatus":"y",
 "threedsecureglobalstatus":"ok",
 "ThreeDsCardEnrolled":"y",
 "ExecCode":"0000",
 "ExecMessage":"Successful operation",
 "warrantyResult":true,
 "3dsecureVersion":2,
 "3dsecureMode":0,
 "bankauthResult":0
 }

}

Récupérer un paiement par carte bancaire enregistrée

Michel Ruckebusch — 2020-03-11T18:00:37Z

Requête
GET /api/[domaine_partenaire]/payins/storedcardpayments/orderid
Accept : application/vnd.s-money.v3+json
Content-Type : application/vnd.s-money.v3+json
Authorization : Bearer ACCESS_TOKEN

Réponse
HTTP/1.1 200 OK

{ 
 "Id":517,
 "OrderId":"orderabc",
 "Amount":9600,
 "fee":{ 
 "amountWithVAT":400,
 "VAT":20
 },
 "Status":0,
 "ThreeDsecurePreference":0,
 "accountId":{ 
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{ 
 "appcardid":"card123",
 "href":"/api/cards/card123"
 },
 "IsMine":false,
 "PaymentDate":"2018-11-12T15:14:54.943324+01:00",
 "Message":"commande orderID:orderabc",
 "extraparameters":{ 
 "profilename":"3DSV2"
 },
 "Refunds":null,
 "ErrorCode":0,
 "ExtraResults":{ 
 "threedsecure":"true",
 "threedsecureauthstatus":"y",
 "threedsecuresignaturestatus":"y",
 "threedsecureglobalstatus":"ok",
 "ThreeDsCardEnrolled":"y",
 "ExecCode":"0000",
 "ExecMessage":"Successful operation",
 "warrantyResult":true,
 "3dsecureVersion":2,
 "3dsecureMode":0,
 "bankauthResult":0
 }

}

Créer un paiement par carte bancaire enregistrée avec 3DS V2

Michel Ruckebusch — 2020-03-11T17:57:26Z

Requête
POST /api/[domaine_partenaire]/payins/storedcardpayments
Accept : application/vnd.s-money.v3+json
Content-Type : application/vnd.s-money.v3+json
Authorization : Bearer ACCESS_TOKEN

{ 
 "amount":9600,
 "fee":{ 
 "amountWithVAT":400,
 "VAT":20
 },
 "ThreeDsecurePreference":0,
 "orderId":"orderabc",
 "accountId":{ 
 "appaccountid":" user-abc "
 },
 "card":{ 
 "appCardId":"card123"
 },
 "ismine":true,
 "message":"orderID: orderabc",
 "extraparameters":{ 
 "profilename":"3DSV2"
 },
 "urlReturn":"https://www.domaine.fr/paiement-termine-iframe",
 "urlCallback":"https://www.domaine.fr/smoneycallbak",
 "Billing":{ 
 "City":"Paris",
 "Country":"FR",
 "Address":"1 rue de paris",
 "PostalCode":"75001",
 "Billingaddressstate":"california "
 },
 "ShipTo":{ 
 "City":"Paris",
 "Country":"FR",
 "Address":"1 rue de paris",
 "PostalCode":"75001",
 "AddressType":0,
 "AddressState":"california ",
 "AddressDate":"2018-01-10"
 },
 "Delivery":{ 
 "email":"pierre@dupont.fr",
 "timeframe":"sameday"
 },
 "ClientScreen":{ 
 "ColorDepth":32,
 "ScreenHeight":1280,
 "ScreenWidth":1024
 },
 "ThreeDsOptData":{ 
 "AccountChangeDate":"2018-01-10",
 "AccountCreationDate":"2018-01-10",
 "ClientAuthMethod":"guest",
 "Passwordchangedate":"2018-01-10",
 "Last6MonthsPurchaseCount":4,
 "Last24hoursaddcardattempts":2,
 "Last24hourstransactioncount":4,
 "Last12Monthstransactioncount":4,
 "Cardenrolldate":"2018-01-01",
 "Suspiciousaccountactivity":false,
 "Homephone":"+33133333333",
 "Mobilephone":"+33633333333",
 "Workphone":"+33633333333",
 "Giftcard":{ 
 "Amount ":"100",
 "Count":"2",
 "Currency":"EUR"
 },
 "Preorderdate":"2020-01-04",
 "Itemavailability":true,
 "Reorderingitem":false,
 "Recurringexpiry":"2020-01-04",
 "recurringfrequency":10
 }

}

Réponse
HTTP/1.1 201 CREATED

{ 
 "OperationId":517,
 "PayinTokenId":"1-2bsKDL",
 "ExtraData":" %7B%22IsSchedule%22%3Afalse%2C%22Profile%22%3Aprofilename%2C%22Cards%22%3Anull%2C%22UrlReturn%22%3A%22http%25253A%25252F%25252Fwww.domaine.fr%25252Fpaiement-termine-iframe%22%7D ",
 "Id":517,
 "OrderId":"orderabc",
 "Amount":9600,
 "fee":{ 
 "amountWithVAT":400,
 "VAT":20
 },
 "Status":0,
 "ThreeDsecurePreference":0,
 "accountId":{ 
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{ 
 "appcardid":"card123",
 "href":"/api/cards/card123"
 },
 "IsMine":false,
 "PaymentDate":"2018-11-12T15:14:54.943324+01:00",
 "Message":"commande orderID:orderabc",
 "extraparameters":{ 
 "profilename":"3DSV2"
 },
 "Refunds":null,
 "ErrorCode":0,
 "ExtraResults":{ 
 "threedsecure":null,
 "threedsecureauthstatus":null,
 "threedsecuresignaturestatus":null,
 "threedsecureglobalstatus":null,
 "ThreeDsCardEnrolled":null,
 "ExecCode":"0000",
 "ExecMessage":"Successful operation",
 "warrantyresult":true,
 "3dsecureversion":null,
 "3dsecuremode":null,
 "bankauthresult":null
 },
 "urlReturn":"https://www.domaine.fr/paiement-termine-iframe",
 "urlCallback":"https://www.domaine.fr/smoneycallbak",
 "Billing":{ 
 "City":"Paris",
 "Country":"FR",
 "Address":"1 rue de paris",
 "PostalCode":"75001",
 "Billingaddressstate":"california "
 },
 "ShipTo":{ 
 "City":"Paris",
 "Country":"FR",
 "Address":"1 rue de paris",
 "PostalCode":"75001",
 "AddressType":0,
 "AddressState":"california ",
 "AddressDate":"2018-01-10"
 },
 "Delivery":{ 
 "email":"pierre@dupont.fr",
 "timeframe":"sameday"
 },
 "ClientScreen":{ 
 "ColorDepth":32, 
 "ScreenHeight":1280,
 "ScreenWidth":1024
 },
 "ThreeDsOptData":{ 
 "AccountChangeDate":"2018-01-10",
 "AccountCreationDate":"2018-01-10",
 "ClientAuthMethod":"guest",
 "Passwordchangedate":"2018-01-10",
 "Last6MonthsPurchaseCount":4,
 "Last24hoursaddcardattempts":2,
 "Last24hourstransactioncount":4,
 "Last12Monthstransactioncount":4,
 "Cardenrolldate":"2018-01-01",
 "Suspiciousaccountactivity":false,
 "Homephone":"+33133333333",
 "Mobilephone":"+33633333333",
 "Workphone":"+33633333333",
 "Giftcard":{ 
 "Amount ":"100",
 "Count":"2",
 "Currency":"EUR"
 },
 "Preorderdate":"2020-01-04",
 "Itemavailability":true,
 "Reorderingitem":false,
 "Recurringexpiry":"2020-01-04",
 "recurringfrequency":10
 }

}

Create a stored card paiement with 3DS V1

Michel Ruckebusch — 2020-03-10T18:41:42Z

Differences with Systempay
This query is the same as the one documented here : Systempay - Stored card payment (one-click)
Except new fields UrlReturn and Require3Ds that enable 3DS payment authentication. These fields are optional.

Request
POST /api/[domaine_partenaire]/payins/storedcardpayments
Accept:application/vnd.s-money.v3+json
Content-Type:application/vnd.s-money.v3+json
Authorization:Bearer ACCESS_TOKEN

{ 
 "orderId":"123",
 "accountId":{ 
 "appaccountid":"123"
 },
 "card":{ 
 "appCardId":"card123"
 },
 "ismine":true,
 "amount":1020,
 "urlReturn":"https://http.cat",
 "require3ds":true,

}

Response

{ 
 "ExtraData":"{\"IsSchedule\":false,\"IsCardRegistration\":false,\"Profile\":\"hostedfields\",\"AppIdentifier\":\"test\",\"UrlReturn\":\"https://http.cat\"}",
 "Require3Ds":true,
 "UrlReturn":"https://http.cat",
 "ExtraResults":null,
 "Message":null,
 "Id":2643,
 "OrderId":"123",
 "AccountId":{ 
 "Id":1048,
 "AppAccountId":"EA2",
 "DisplayName":"user-abc user-abc",
 "Email":null,
 "PhoneNumber":null,
 "Alias":null,
 "Href":"http://rest.s-money.net/api/b2b/users/EA2"
 },
 "Card":{ 
 "Id":1134,
 "AppCardId":"fzefz",
 "Href":"http://rest.s-money.net/api/b2b/cards/fzefz"
 },
 "Amount":1020,
 "Fee":null,
 "OperationDate":"2019-06-05T11:34:42.1942292+02:00",
 "IsMine":true,
 "Status":0,
 "Payments":null,
 "Refunds":null,
 "AuthorizationAmount":null,

}

Créer un paiement par carte bancaire enregistrée avec 3DS V1

Michel Ruckebusch — 2020-03-10T18:38:01Z

Différences avec Systempay
La création de la requête de paiement avec carte enregistrée est modifiée avec l'ajout des paramètres UrlReturn et Require3Ds qui permet d'activer l'authentification 3Ds sur le paiement.
Ces paramètres sont facultatifs. S'ils ne sont pas renseignés, alors on reste dans le cadre d'un paiement avec carte enregistrée comme présenté dans Systempay - Paiement avec carte enregistrée (one-click)

Requête
POST /api/[domaine_partenaire]/payins/storedcardpayments
Accept:application/vnd.s-money.v3+json
Content-Type:application/vnd.s-money.v3+json
Authorization:Bearer ACCESS_TOKEN

{ 
 "orderId":"123",
 "accountId":{ 
 "appaccountid":"123"
 },
 "card":{ 
 "appCardId":"card123"
 },
 "ismine":true,
 "amount":1020,
 "urlReturn":"https://http.cat",
 "require3ds":true,

}

Réponse

{ 
 "ExtraData":"{\"IsSchedule\":false,\"IsCardRegistration\":false,\"Profile\":\"hostedfields\",\"AppIdentifier\":\"test\",\"UrlReturn\":\"https://http.cat\"}",
 "Require3Ds":true,
 "UrlReturn":"https://http.cat",
 "ExtraResults":null,
 "Message":null,
 "Id":2643,
 "OrderId":"123",
 "AccountId":{ 
 "Id":1048,
 "AppAccountId":"EA2",
 "DisplayName":"user-abc user-abc",
 "Email":null,
 "PhoneNumber":null,
 "Alias":null,
 "Href":"http://rest.s-money.net/api/b2b/users/EA2"
 },
 "Card":{ 
 "Id":1134,
 "AppCardId":"fzefz",
 "Href":"http://rest.s-money.net/api/b2b/cards/fzefz"
 },
 "Amount":1020,
 "Fee":null,
 "OperationDate":"2019-06-05T11:34:42.1942292+02:00",
 "IsMine":true,
 "Status":0,
 "Payments":null,
 "Refunds":null,
 "AuthorizationAmount":null,

}

Implémentation du formulaire de saisie du CVV

Michel Ruckebusch — 2020-03-10T18:06:27Z

Principe :
Vous affichez une page de saisie du CVV comprenant un champ de saisie du CVV au sein de conteneurs de champs hébergés. Ces conteneurs peuvent être n'importe quelle balise HTML : DIV, P, SPAN… la bibliothèque JavaScript des champs hébergés injecte des iframes hébergés par Dalenys dans ces conteneurs, chacun contenant les champs de saisie de données de la carte.
Lors du processus de soumission, vous devrez appeler la méthode Javascript createToken de la bibliothèque de champs hébergés qui déclenchera la création de jetons des données du titulaire de la carte (numéro de carte, date d'expiration et cryptogramme). Si la création de jetons aboutit, vous devez ajouter le jeton reçu à votre demande de soumission de formulaire dans un champ

Création du formulaire :
Vous devez posséder un certificat TLS (voir en fin de documentation) pour héberger une page de paiement HTTPS valide, sinon le navigateur de l'utilisateur affichera des alertes de sécurité et le bloquera probablement.
La bibliothèque de champs hébergés doit toujours être appelée en ligne.
L'utilisation d'une version téléchargée hébergée sur votre propre serveur peut entraîner de graves dysfonctionnements, notamment dans le cas d'une mise à jour de l'API Dalenys.

1-Inclure la librairie javascript suivante entre les balises

Les identifiants utilisés dans le script pour désigner les champs sont ceux utilisés pour les identifiants des conteneurs créés dans le formulaire. Ceci permettant au script d'injecter les champs hébergés par Dalenys dans ces conteneurs.

5-Charger la bibliothèque des champs hébergés

À ce stade, votre navigateur Web peut afficher les champs de saisie du CVV dans leurs conteneurs.

6-Générer le jeton
A la soumission du formulaire, vous devez appeler la méthode createToken() sur l'événement onsubmit() pour déclencher le processus de création de jetons.
Cette méthode attend un paramètre de rappel qui sera déclenché une fois la demande de tokénisation terminée.
Votre rappel recevra un objet de résultat contenant ces propriétés :

execCode : code de résultat technique de l'appel tokenization. En cas de succès, 0000 sera envoyé
message : la description liée à l'execCode
cardType : le type de carte
cardCode : Les 6 premiers et les 4 derniers chiffres du numéro de la carte du titulaire
cardValidityDate : Date d'expiration de la carte
hfToken : le jeton généré
En cas de succès, vous devez ajouter le jeton reçu à la demande d'envoi de formulaire dans une balise

7-Inclure la propriété Smoney EXTRADATA en champs hidden en plus de celui du jeton.

Les attributs name des balises input hidden ne doivent pas être changés.

Resources

Michel Ruckebusch — 2020-03-10T17:44:46Z

StoredCardPayment

Property	Type	Mandatory?	Description
Amount	Long	Yes	Payment amount (in cents)
Fee	Long	No	Fee amount (the amount value does not include the fee amount)
ThreeDSecurePreference	Int	Yes	0 = ask for a strong authentication 1 = ask for a frictionless authentication 2 = ask for no preference, the decision will be made by issuer; 3 = ask for no authentication
OrderId	String	Yes	Payment identifier in the third-party application
Id	Long	/	Payment ID
availableCards	String	Yes	List of cards to be displayed on the payment page. Possible values (to separate with ';' ): CB MASTERCARD MAESTRO VISA VISA_ELECTRON
IsMine	Bool	Yes	True, if the account holder is also the bank card holder (it refers to an account top-up and not a payment), False if the bank card holder is not the owner of the account holder
Message	String	Yes	Payment message
urlReturn	String	Yes	Url of callback client requested at the end of a card payment
urlCallback	String	Yes	Specify url of callback server requested at the end of adding card (the domain must be the same as the one of the callback URL provided initially)
Status	Int	Yes	Sub operation status -1 = unknow 0 = waiting 1 = completed 2 = refunded 3 = refused 4 = Waiting for validation 5 = Cancelled 6 = Waiting to be sent
ErrorCode	Int	Yes	0 = 0XXX operation succeeded or still processing 10 = 1XXX operation rejected because of bad request configuration 11 = 2XXX operation rejected because of bad reference usage 12 = 3XXX operation rejected because of bad account configuration 13 = 4XXX operation rejected because of the bank or the supplier 14 = 5XXX operation rejected because of a system error 15 = 6XXX operation rejected because of anti-fraud engine
Extradata	String	/	Data to be included in card payment form into :
OperationId	String		Data to be included in card payment form into :
TokenId	String		Data to be included in card payment form into :
PaymentDate	DateTime		Payment date Ex: 2013-09-10 T15:49:58.791121+02:00
Type	Int	/	Payment types: 0 = Payment 1 = Refund

Card

Property	Type	Mandatory?	Description
AppCardId	String	Yes	Card identifier in the third-party application
Href	Uri	/	Uri for the details of the bank card

Beneficiary

Property	Type	Mandatory?	Description
Id	Long	/	Account identifier.
AppAccountId	String	Yes	Account identifier provided by the third-party application.
DisplayName	Long	/	Account display name
Email	String	/	Account email
Phonenumber	String	/	Account phone number
Href	Uri	/	Uri for the account details

PayerInfo

Property	Type	Mandatory?	Description
Name	String	Yes	The holder's full name (as described on the payment method).
mail	String	Yes	The user's email.

Extraparameters

Property	Type	Mandatory?	Description
ProfilName	String	Yes	Value “3DSV2” to call 3D-Secure 2.0 By default, without profil, 3DS V1 will be called

Billing

Property	Type	Mandatory?	Description
City	String	Yes	The billing city.
Country	String	Yes	The country code (ISO_3166-1_alpha-2).
Address	String	Yes	The billing address. Be careful not to integrate any line breaks.
PostalCode	String	Yes	The billing postal code.
Billingaddressstate	String	No	The billing address state.

ShipTo

Property	Type	Mandatory?	Description
City	String	Yes*	The shipping city. Mandatory if AdresseType is not EDELIVERY
Country	String	Yes*	The country code (ISO_3166-1_alpha-2 format) Mandatory if AdresseType is not EDELIVERY
Address	String	Yes*	The shipping address. Mandatory if AdresseType is not EDELIVERY
PostalCode	String	Yes*	The shipping postal code. Mandatory if AdresseType is not EDELIVERY
AddressType	Int	Yes	Shipping indicator. 0 = eDelivery 1 = Verified 2 = New 3 = Billing 4 = Store Pickup 5 = Travel Pickup 6 = Other The parameter DELIVERYEMAIL is mandatory when EDELIVERY mode is set. The other ship to address fields are optional when ‘storepickup', travelpickup or other is set.
AddressState	String	No	The shipping address state.
AddressDate	String	No	Date when the shipping address used for this transaction was first used with the 3DS Requestor.

Delivery

Property	Type	Mandatory?	Description
email	String	Yes*	Mandatory if ShipToAddressType value is eDelivery For Electronic delivery, the email address to which the merchandise was delivered.
timeframe	String	No	Possible values : electronic, sameday, overnight, longer

ClientScreen

Property	Type	Mandatory?	Description
ColorDepth	Int	Yes	Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property. Ex : 32
ScreenHeight	Int	Yes	Total height of the Cardholder's screen in pixels. Value is returned from the screen.height property. Ex : 1280
ScreenWidth	Int	Yes	Total width of the cardholder's screen in pixels. Value is returned from the screen.width property. Ex : 1024

ThreeDsOptData

Property	Type	Mandatory?	Description
ClientAuthMethod	String	No	guest: No merchant authentication occurred (i.e. cardholder “logged in” as guest); credentials: Login to the cardholder account at the merchant system using merchant's own credentials; federated: Login to the cardholder account at the merchant system using federated ID; issuer: Login to the cardholder account at the merchant system using issuer credentials; thirdparty: Login to the cardholder account at the merchant system using third-party authentication; fido: Login to the cardholder account at the merchant system using FIDO Authenticator;
AccountChangeDate	Date	No	Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.
AccountCreationDate	Date	No	Date that the cardholder opened the account with the 3DS Requestor.
Passwordchangedate	Date	No	Date that cardholder's account with the 3DS Requestor had a password change or account reset.
Last6MonthsPurchaseCount	Int	No	Number of purchases with this cardholder account during the previous six months.
Last24hoursaddcardattempts	Int	No	Number of “Add Card” attempts in the last 24 hours.
Last24hourstransactioncount	Int	No	Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.
Last12Monthstransactioncount	Int	No	Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.
Cardenrolldate	date	No	Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor.
Suspiciousaccountactivity	Boolean	No	Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.
Homephone	string(max 32)	No	The home phone number provided by the Cardholder in international (E.164) format.
Mobilephone	string(max 32)	No	The mobile phone number provided by the Cardholder in international (E.164) format.
Workphone	string(max 32)	No	The work phone number provided by the Cardholder in international (E.164) format.
Preorderdate	date	No	For a pre-ordered purchase, the expected date that the merchandise will be available.
Itemavailability	Boolean	No	Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
Reorderingitem	Boolean	No	Indicates whether the cardholder is reordering previously purchased merchandise.
Recurringexpiry	date	No	Date after which no further authorisations shall be performed in a recurring payment workwlow.
recurringfrequency	Int	No	Indicates the minimum number of days between authorisations. Ex : 10

GiftCard

Property	Type	Mandatory?	Description
Amount	Int	No	For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in minor units (cents).
Count	Int	No	For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
Currency	String	No	For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

ExtraResults

Property	Type	Mandatory?	Description
threedsecure	Boolean	/	True / False
threedsecureauthstatus	Int	/	0 = Yes 1 = No 2 = unavaible 3 = Attempted
threedsecuresignaturestatus	Int	/	0 = Yes 1 = No
threedsecureglobalstatus	Int	/	0 = Yes 1 = Not_enrolled 2 = unavaible 3 = Not_required
ThreeDsCardEnrolled	Int	/	0 = Yes 1 = No 2 = unavaible
ExecCode	String (4)	/	The operation result code
ExecMessage	String	/	The operation result description linked to EXECCODE
warrantyresult	String	/	Yes / no
3dsecureversion	Int	/	The kind of 3-D Secure protocol version. Ex : 1
3dsecuremode	String	/	Applied authentification mode: 0 = ask for a strong authentication 1 = ask for a frictionless authentication
bankauthresult	Int	/	Return code of the authorisation request returned by the issuing bank

Ressources

Michel Ruckebusch — 2020-03-10T17:44:44Z