S-money API

Retrieve a sub-payment of a bank card payment to multiple recipients.

Hadassa — 2016-07-05T15:13:24Z

Please have a look at the example in the right margin.

Request
GET /api/[domaine_partenaire]/payins/cardpayments/orderid/payments/orderid HTTP/1.1
Accept: application/vnd.s-money.v2+json
Authorization: Bearer ACCESS_TOKEN

Response
HTTP/1.1 200 OK

{
 "id":7, 
 "orderId":"123-1",
 "beneficiary":
 {
 "id":87,
 "appaccountid":"shop_01",
 "displayname":"Jean Dupont1",
 "href":"/api/[domaine_partenaire]/accounts/shop_01"
 },
 "amount":1000, 
 "fee":100,
 "status":1,
 "message": "panier 444556465",
 "payerInfo": 
 {
 "Name": "Pierre Dupont",
 "Mail": "pierre@dupont.fr"
 },
 "ismine":false, 
 "card":
 {
 "id":21,
 "appcardid":"card123",
 "name":"carte bancaire",
 "hint":"597010XXXXXX0009",
 "country":"FR"
 },
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "errorCode":0, 
 "extraResults":null,
 "type":0,

}

Refund a sub-payment of an incoming payment to multiple recipients

Hadassa — 2016-07-05T14:52:26Z

The amount indicated in the request is the one paid by the user during the payment creation.

Please have a look at the example in the right margin.

Request
POST /api/[domaine_partenaire]/payins/cardpayments/orderidglobal/payments/orderid/refunds HTTP/1.1
Accept: application/vnd.s-money.v2+json
Content-Type: application/vnd.s-money.v2+json
Authorization: Bearer ACCESS_TOKEN

{
 "amount": 1000, 
 "orderId": "refund123", 
 "fee": 10 

}

Response
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v2+json
Location: /api/[domaine_partenaire]/payins/cardpayments/refund123

{
 "id":6,
 "orderId": "refund123",
 "amount":-1000,
 "fee":10,
 "status":1,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "originalPayment":
 {
 "id":5,
 "orderId":"123",
 "href":"/api/[domaine_partenaire]/payins/cardpayments/123" 
 },
 "type":1

}

Create a bank card payment to multiple recipients

Hadassa — 2016-07-05T14:49:02Z

Send the data of a card payment request to the S-money server

To send the data of the card payment request to the S-money server, please have a look at the example in the right margin of this page.

Send the data of the completed payment to the third-party server.

The third party server should provide the S-money server with an url server, so that the latter can communicate the results of the payment execution.

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

The parameters of the HTTP request are:

Parameter	Type	Description
id	string	Operation OrderId
error	Int	Error code for failed payments, 0, if no error. 1 = The merchant needs to 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 1 = card payment
status	Int	Operation status -1 = unknow 0 = waiting 1 = completed 2 = refunded 3 = refused 4 = Waiting for validation 5 = Cancelled 6 = Waiting to be sent
sequencenumber	Int	Sequence number of the multiple payment (if multiple payment
userid	String	User identifier in the third-party application
userstatus	Int	User status 0 = Not confirmed 1 = OK 2 = Frozen 3 = On the fly 4 = Being closed 5 = Closed 6 = Waiting for KYC (transfers blocked)

Redirection at the end of a card payment
The third-party server needs to provide the S-money server with the url server, so that the S-money server can redirect the client to the third-party environment. l'environnement tiers.
The url can be either associated to a web scheme (http/https) or a private web scheme, when the request will made from the third-party application.
The information sent can be used only for informative purposes and should not be, under any circumstances, used for the payment validation by the third-party server.

The HTTP parameters are as follows:

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

Parameter	Type	Description
Id	String	Payment OrderId
Result	Int	Transaction status 0 : Payment successfully completed. 2: The merchant needs to contact the bank of the holder. 5: Payment refused. 17:Client cancellation. 30: Request format error. To compare with the value of vads_extra_result. 96 : Payment technical error.

Request :
POST /api/[domaine_partenaire]/payins/cardpayments HTTP/1.1
Accept: application/vnd.s-money.v2+json
Content-Type: application/vnd.s-money.v2+json
Authorization: Bearer ACCESS_TOKEN

{
 "orderId": "123",
 "availableCards":"CB",
 "payments":[{
 "orderId": "123-1",
 "beneficiary":{"appaccountid":"shop_01"},
 "amount": 1000,
 "fee": 100,
 },
 {
 "orderId": "123-2",
 "beneficiary":{"appaccountid": "shop_02"},
 "amount": 2000,
 "fee": 200,
 },
 {...}],
 "message": "panier 444556465",
 "ismine": false,
 "payerInfo": 
 {
 "Name": "Pierre Dupont",
 "Mail": "pierre@dupont.fr"
 },
 "urlReturn": "http://test.com/returnurl/",
 "urlCallback":"https://test.com/callbackurl/",

}

Response :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v1+json
Location: /api/[domaine_partenaire]/payins/cardpayments/orderId

{
 "id":5, 
 "orderId":"123",
 "payments":[{
 "orderId": "123-1",
 "id":7,
 "beneficiary" :{
 "id":87,
 "appaccountid":"shop_01",
 "displayname":"Jean Dupont1",
 "href":"/api/[domaine_partenaire]/accounts/shop_01"
 },
 "amount": 1000,
 "fee": 100,
 "status": 0
 },
 {
 "orderId": "123-2",
 "id" : 8,
 "beneficiary" :{
 "id":88,
 "appaccountid":"shop_02",
 "displayname":"Jean Dupont2",
 "href":"/api/[domaine_partenaire]/accounts/shop_02"
 },
 "amount": 2000,
 "fee": 200,
 "status": 0
 },
 {...}],
 "amount":3000, 
 "fee":300,
 "status":0,
 "message": "panier 444556465",
 "ismine":false,
 "paymentDate":null,
 "href":"{url à appeler}",
 "type":0

}

The href parameter contains the url to which the third-party application should redirect the client's browser in order to make a payment.

Récupérer un sous-paiement d'un paiement par carte bancaire vers plusieurs destinataires

Hadassa — 2016-04-29T17:32:37Z

Veuillez vous référer à l'exemple en marge de droite.

Requête
GET /api/[domaine_partenaire]/payins/cardpayments/orderid/
payments/orderid-sous-paiement HTTP/1.1
Accept : application/vnd.s-money.v2+json
Authorization : Bearer ACCESS_TOKEN

Réponse
HTTP/1.1 200 OK

{
 "id":7, 
 "orderId":"123-1",
 "beneficiary":
 {
 "id":87,
 "appaccountid":"shop_01",
 "displayname":"Jean Dupont1",
 "href":"/api/[domaine_partenaire]/accounts/shop_01"
 },
 "amount":1000, 
 "fee":100,
 "status":1,
 "message": "panier 444556465",
 "payerInfo": 
 {
 "Name": "Pierre Dupont",
 "Mail": "pierre@dupont.fr"
 },
 "ismine":false, 
 "card":
 {
 "id":21,
 "appcardid":"card123",
 "name":"carte bancaire",
 "hint":"597010XXXXXX0009",
 "country":"FR"
 },
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "errorCode":0, 
 "extraResults":null,
 "type":0,

}

Rembourser un sous-paiement d'un paiement multidestinataire

Hadassa — 2016-04-29T17:27:54Z

Le montant indiqué dans la requête est celui payé par l'utilisateur lors de la création du paiement.

Merci de vous référer dans l'exemple dans la marge à droite.

Requête
POST /api/[domaine_partenaire]/payins/cardpayments/orderidglobal/
payments/orderid-sous-paiement/refunds HTTP/1.1
Accept : application/vnd.s-money.v2+json
Content-Type : application/vnd.s-money.v2+json
Authorization : Bearer ACCESS_TOKEN

{
 "amount": 1000, 
 "orderId": "refund123", 
 "fee": 10 

}

Réponse
HTTP/1.1 201 CREATED
Content-Type : application/vnd.s-money.v2+json
Location : /api/[domaine_partenaire]/payins/cardpayments/refund123

{
 "id":6,
 "orderId": "refund123",
 "amount":-1000,
 "fee":10,
 "status":1,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "originalPayment":
 {
 "id":5,
 "orderId":"123",
 "href":"/api/[domaine_partenaire]/payins/cardpayments/123" 
 },
 "type":1

}

Créer un paiement par carte bancaire vers plusieurs destinataires

Axel — 2015-07-28T16:19:01Z

Envoi des données de la requête de paiement carte au serveur S-money

Pour l'envoi des données de la requête de paiement carte au serveur S-money veuillez vous référer à l'exemple présent en marge de droite de cette page.

Envoi des données du paiement réalisé 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	string	OrderId de l'opération
error	Int	Code d'erreur pour les paiements é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 1 = paiement carte
status	Int	Statut de l'opération -1 = inconnu 0 = en attente 1 = complété 2 = remboursé 3 = refusé 4 = En attente de validation 5 = Annulé 6 = En attente de remise
sequencenumber	Int	Numéro de séquence du paiement multiple (si paiement multiple)
userid	String	Identifiant de l'utilisateur chez l'application tierce
userstatus	Int	Statut de l'utilisateur 0 = Non confirmé 1 = OK 2 = Gelé 3 = A la volée 4 = En cours de fermeture 5 = Fermé 6 = En attente de KYC (virements bloqués)

Redirection en fin de paiement 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.
Les informations renvoyées le sont à titre purement informatif et ne doivent en aucun cas être utilisées pour la validation du paiement par le serveur tiers.

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

Paramètre	Type	Description
Id	String	OrderId du paiement
Result	Int	Statut de la transaction 0 : Paiement réalisé avec succès. 2 : Le commerçant doit contacter la banque du porteur. 5 : Paiement refusé. 17 : Annulation client. 30 : Erreur de format de la requête. A mettre en rapport avec la valorisation du champ vads_extra_result. 96 : Erreur technique lors du paiement.

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

{
 "orderId": "123",
 "availableCards":"CB",
 "payments":[{
 "orderId": "123-1",
 "beneficiary":{"appaccountid":"shop_01"},
 "amount": 1000,
 "fee": 100,
 },
 {
 "orderId": "123-2",
 "beneficiary":{"appaccountid": "shop_02"},
 "amount": 2000,
 "fee": 200,
 },
 {...}],
 "message": "panier 444556465",
 "ismine": false,
 "payerInfo": 
 {
 "Name": "Pierre Dupont",
 "Mail": "pierre@dupont.fr"
 },
 "urlReturn": "http://test.com/returnurl/",
 "urlCallback":"https://test.com/callbackurl/",

}

Réponse :
HTTP/1.1 201 CREATED
Content-Type : application/vnd.s-money.v1+json
Location : /api/[domaine_partenaire]/payins/cardpayments/orderId

{
 "id":5, 
 "orderId":"123",
 "payments":[{
 "orderId": "123-1",
 "id":7,
 "beneficiary" :{
 "id":87,
 "appaccountid":"shop_01",
 "displayname":"Jean Dupont1",
 "href":"/api/[domaine_partenaire]/accounts/shop_01"
 },
 "amount": 1000,
 "fee": 100,
 "status": 0
 },
 {
 "orderId": "123-2",
 "id" : 8,
 "beneficiary" :{
 "id":88,
 "appaccountid":"shop_02",
 "displayname":"Jean Dupont2",
 "href":"/api/[domaine_partenaire]/accounts/shop_02"
 },
 "amount": 2000,
 "fee": 200,
 "status": 0
 },
 {...}],
 "amount":3000, 
 "fee":300,
 "status":0,
 "message": "panier 444556465",
 "ismine":false,
 "paymentDate":null,
 "href":"{url à appeler}",
 "type":0

}

Le paramètre href contient l'url vers laquelle l'application tierce doit rediriger le navigateur client pour effectuer le paiement.