S-money API

Supprimer une carte bancaire enregistrée

Hadassa — 2016-11-21T16:14:15Z

Pour supprimer une carte bancaire enregistrée, veuillez vous référer à l'exemple en marge de droite de cette page.

Requête
DELETE api/domainePartenaire/cards/appcardid
HTTP/1.1
Authorization : Bearer ACCESS_TOKEN

Réponse
HTTP/1.1 204 NO CONTENT

Récupérer une carte bancaire enregistrée

Hadassa — 2016-11-21T15:14:20Z

Pour récupérer les informations d'une carte bancaire, veuillez vous référer à l'exemple en marge de droite de cette page.

Requête
GET api/domainePartenaire/cards/appcardid HTTP/1.1
Accept : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

Réponse
HTTP/1.1 200 OK
Location : /api/domainePartenaire/cards/appcarid

[
 {
 "Id": 11743,
 "AppCardId": "card123",
 "Network": 1,
 "Hint": "497010XXXXXX0000",
 "Name": "ma carte bancaire",
 "Country": "FR",
 "ExpiryDate": "2017-06-30T23:59:59"
 }

]

Récupérer la liste des cartes enregistrées sur le domaine

Hadassa — 2016-11-21T15:03:52Z

Pour récupérer la liste des cartes bancaires enregistrées sur le domaine, veuillez vous référer à l'exemple en marge de droite de cette page.

Requête
GET api/domainePartenaire/cards/ HTTP/1.1
Accept : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

Réponse
HTTP/1.1 200 OK
Location : /api/domainePartenaire/cards/

[
 {
 "Id": 11743,
 "AppCardId": "card123",
 "Network": 1,
 "Hint": "497010XXXXXX0000",
 "Name": "ma carte bancaire",
 "Country": "FR",
 "ExpiryDate": "2017-06-30T23:59:59"
 },
 {
 "Id": 11758,
 "AppCardId": "card456",
 "Network": 1,
 "Hint": "497010XXXXXX0000",
 "Name": "ma deuxieme carte bancaire",
 "Country": "FR",
 "ExpiryDate": "2017-07-30T23:59:59"
 },
 {
 "Id": 11769,
 "AppCardId": "card789",
 "Network": 1,
 "Hint": "497010XXXXXX0000",
 "Name": "une carte bancaire enregistrée",
 "Country": "FR",
 "ExpiryDate": "2017-08-30T23:59:59"
 },
 {
 "Id": 11759,
 "AppCardId": "card741852",
 "Network": 1,
 "Hint": "486010XXXXXX0000",
 "Name": "carte bancaire de mon compte",
 "Country": "FR",
 "ExpiryDate": "2017-07-30T23:59:59"
 },

{ ... }

]

Récupérer la liste des cartes bancaires enregistrées de l'utilisateur

Hadassa — 2016-11-21T14:41:11Z

Pour récupérer les cartes bancaires enregistrées de l'utilisateur, veuillez vous référer à l'exemple présent en marge de droite de cette page.

Précision :
Les cartes bancaires dont l'enregistrement ont échoué (statut 2 ) ne sont pas présentes dans la liste des cartes enregistrées de l'utilisateur.
Pour vérifier le statut d'une carte bancaire, veuillez vous référer au chapitre précédent.

Requête
GET api/domainePartenaire/users/appuserid/cards/ HTTP/1.1
Accept : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

Réponse
HTTP/1.1 200 OK
Location : api/domainePartenaire/users/appuserid/cards/

[
 {
 "Id": 11743,
 "AppCardId": "card123",
 "Network": 1,
 "Hint": "497010XXXXXX0000",
 "Name": "ma carte bancaire",
 "Country": "FR",
 "ExpiryDate": "2017-06-30T23:59:59"
 },
 {
 "Id": 11758,
 "AppCardId": "card456",
 "Network": 1,
 "Hint": "497010XXXXXX0000",
 "Name": "ma deuxieme carte bancaire",
 "Country": "FR",
 "ExpiryDate": "2017-07-30T23:59:59"
 },
 {
 "Id": 11769,
 "AppCardId": "card789",
 "Network": 1,
 "Hint": "497010XXXXXX0000",
 "Name": "une carte bancaire enregistrée",
 "Country": "FR",
 "ExpiryDate": "2017-08-30T23:59:59"
 },

{...}

]

Récupérer les informations de l'enregistrement carte

Hadassa — 2016-11-21T14:30:56Z

Pour récupérer les informations relatives à l'enregistrement de la carte de l'utilisateur, veuillez vous référer à l'exemple en marge de droite de cette page.

Les informations sur les différents paramètres de la réponse sont disponible dans le chapitre Ressources.

Requête
GET api/domainePartenaire/cards/registrations/appcardid HTTP/1.1
Accept : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

Réponse
HTTP/1.1 200 OK
Location : /api/domainePartenaire/cards/registrations/card123

{
 "Card": {
 "Id": 11743,
 "AppCardId": "card123",
 "Network": 1,
 "Hint": "497010XXXXXX0000",
 "Name": "ma carte bancaire",
 "Country": "FR",
 "ExpiryDate": "2017-06-30T23:59:59"
 },
 "Status": 1,
 "UrlReturn": null,
 "UrlCallback": null,
 "AvailableCards": null,
 "ErrorCode": 0,
 "ExtraResults": {
 "RiskControlResult": null,
 "BankAuthResult": 0,
 "ThreedsResult": 10,
 "WarrantyResult": false
 },
 "Href": null,
 "ExtraParameters": null

}

Enregistrer une carte bancaire

Hadassa — 2016-11-21T14:30:34Z

2.1 Envoi des données de la requête d'enregistrement carte au serveur S-money

Pour ajouter une carte bancaire, les paramètres obligatoires sont les suivants :
card
appcardid
urlReturn

Les autres paramètres sont optionnels.

Veuillez vous référer à l'exemple présent en marge de droite de cette page, pour l'enregistrement d'une carte bancaire d'un utilisateur.

Le paramètre "href" contient l'url vers laquelle l'application tierce doit rediriger le navigateur client pour effectuer l'enregistrement de la carte.

2.2 Envoie des données de l'enregistrement carte au serveur tiers

Le serveur tiers doit mettre à disposition une url serveur permettant au serveur S-money de le notifier du résultat de l'exécution du paiement.

L'appel du serveur S-money est effectué en méthode HTTP POST.

Les paramètres de la requête HTTP sont :

Paramètre	Type	Description
id	Long	Id de la carte
error	Int	Code d'erreur pour les renseignements carte échoués, 0 si aucune erreur. 1 = Le commerçant doit contacter la banque du porteur 2 = Paiement refusé 3 = Paiement annulé par le client 4 = Porteur non enrôlé 3D-Secure 5 = Erreur authentification 3D-Secure 6 = Erreur technique SystemPay
type	Int	Type de l'opération 5 =enregistrement carte
userid	String	Identifiant de l'utilisateur chez l'application tierce

2.3 Redirection en fin d'enregistrement carte

Le serveur tiers doit mettre à disposition une url permettant au serveur S-money de rediriger le client vers l'environnement tiers.

L'url peut-être soit associée au scheme web (http/https) ou à un scheme privatif dans le cas où l'appel serait effectué à partir d'une application mobile tierce.

L'appel du serveur S-money est effectué en méthode HTTP POST.
Les paramètres de la requête HTTP sont :

Paramètre	Type	Description
Id	Long	Id de la carte bancaire
Type	Int	Type de l'opération 5 = enregistrement carte
Result	Int	Statut de la transaction 0 = Erreur 1 = OK

Requête
POST api/domainePartenaire/users/appuserid/cards/registrations
HTTP/1.1
Accept : application/vnd.s-money.v1+json
Content-Type : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

{
 "card": 
 {
 "appcardid":"card123", 
 "name":"ma carte bancaire"
 },
 "urlReturn":"http://url-de-retour-client",
 "urlCallback":"https://url-de-callback-client",
 "availableCards":"CB",
 "extraparameters":
 {
 "profilename" : "testprofile",
 "systempaylanguage" : "en"
 }

}

Réponse
HTTP/1.1 201 CREATED
Location : /api/domainePartenaire/cards/registrations/card123

{
 "Card": {
 "Id": null,
 "AppCardId": "card123",
 "Network": null,
 "Hint": null,
 "Name": "ma carte bancaire",
 "Country": null,
 "ExpiryDate": null
 },
 "Status": 0,
 "UrlReturn": null,
 "UrlCallback": null,
 "AvailableCards": "CB",
 "ErrorCode": 0,
 "ExtraResults": {
 "RiskControlResult": null,
 "BankAuthResult": null,
 "ThreedsResult": null,
 "WarrantyResult": null
 },
 "Href": "{url à appeler}",
 "ExtraParameters": {
 "ProfileName": "testprofile",
 "SystemPayLanguage": "en"
 }

}

Delete a bank card

Hadassa — 2016-07-07T10:30:05Z

To delete a bank card, please have a look at the example in the right margin of this page.

Error cases

HTTP code	Error code	Explication
404	195	Bank card cannot be found

Request
DELETE /api/cards/appcardid HTTP/1.1
Authorization: Bearer ACCESS_TOKEN

Response
HTTP/1.1 204 NO CONTENT

Retrieve a bank card

Hadassa — 2016-07-07T10:28:05Z

To retrieve a bank card, please have a look at the example in the right margin of this page.

Request
GET /api/cards/appcardid HTTP/1.1
Accept: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

Response
HTTP/1.1 200 OK
Content-Type: application/vnd.s-money.v1+json

{
 "id":21,
 "appcardid":"card123",
 "name":"carte bancaire",
 "hint":"597010XXXXXX0009",
 "country":"FR"

}

Retrieve the list of bank cards

Hadassa — 2016-07-07T10:23:57Z

3. Retrieve the list of bank cards

To retrieve the list of bank cards, please have a look at the example in the right margin of this page.

Request
GET /api/cards/ HTTP/1.1
Accept: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

Response
HTTP/1.1 200 OK
Content-Type: application/vnd.s-money.v1+json

[{
 "id":21,
 "appcardid":"card123",
 "name":"carte bancaire",
 "hint":"597010XXXXXX0009" ,
 "country":"FR"

}, 

{…}]

Add a bank card

Hadassa — 2016-07-07T10:21:41Z

2.1 Send the details of the card registration request to the S-money server

To add a bank card, these are the mandatory parameters: "card", "appcardid" and also "urlReturn".

These are the optional parameters "name", "availableCards", "extraparameters", "profilename", and "systempaylanguage".

Please have a look at the example in the right margin of this page.

The "href" parameter includes the url, to which the third-party application should redirect the client's browser to complete a card registration.

2.2 Send the details of the card registration to the third-party server

The third-party server should provide the S-money server with an url server allowing the S-money server to communicate the result of the payment execution.

The HTTP POST method is used to invoke the S-money server

These are the HTTP request parameters:

Parameter	Type	Description
id	Long	Card ID
error	Int	Error code for failed card details, 0, if no errors. 1 = The merchant should contact the bank of the holder 2 = Payment refused 3 = Payment cancelled by the client 4 = Holder not 3D-Secure enrolled 5 = 3D-Secure authentication error 6 = SystemPay technical error
type	Int	Operation type 5 =card registration
userid	String	User identification in the third-party application

2.3 Redirection at the end of a card registration

The third-party server should provide the S-money server with an url allowing the S-money to redirect the client to the third-party environment.

The url can be either associated to a web scheme (http/https) or a private scheme when a request is made by a third-party mobile application.

The HTTP POST method is used to invoke the S-money server.
These are the parameters of the HTTP request:

Parameter	Type	Description
Id	Long	Bank card ID
Type	Int	Operation type 5 = card registration
Result	Int	Transaction status 0 = Error 1 = O

Request
POST /api/cards/registrations HTTP/1.1
Accept : application/vnd.s-money.v1+json
Content-Type: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "card": 
 {
 "appcardid":"card123", 
 "name":"carte bancaire"
 },
 "urlReturn":"http://url-de-retour-client",
 "urlCallback":"https://url-de-callback-client",
 "availableCards":"CB",
 "extraparameters":
 {
 "profilename" : "testprofile",
 "systempaylanguage" : "en"
 }

}

Response
HTTP/1.1 201 CREATED
Location: /api/cards/registrations/card123

{
 "card":
 {
 "appcardid":"card123",
 "name":"carte bancaire"
 },
 "status":0,
 "errorCode":0,
 "extraResults":null,
 "href":"{url à appeler}",
 "extraparameters":
 {
 "profilename":"testprofile",
 "systempaylanguage":"fr"
 }

}