S-money API

Retrieve a bank transfer

Hadassa — 2016-07-05T11:52:45Z

In order to retrieve a bank transfer, please have a look at the example in the right margin of this page.

Error case

HTTP Code	Erreur Code	Explication
404	356	Operation cannot be found

Request :
GET /api/DomainePartenaire/payouts/orderid 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

{
 "orderid":"moneyout-1",
 "id":21,
 "accountid":
 {
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/{DomainePartenaire}/accounts/123"
 },
 "bankaccount":
 {
 "alias":"Compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx3520962",
 "ismine":true
 },
 "amount":100,
 "fee":
 {
 "amount":150,
 "VAT":19.6,
 "amountWithVAT":179,
 "status":1
 },
 "operationdate":"2013-09-10T15:49:58.791121+02:00",
 "message": "virement S-money du 21/01/2014"

}

Retrieve the list of bank transfers

Hadassa — 2016-07-05T11:50:41Z

In order to retrieve the list of bank transfers, please have a look at the example in the right margin of this page.

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

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

[{
 "id":21,
 "accountid":
 {
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "Email": null,
 "PhoneNumber": null,
 "Alias": null,
 "href":"/api/{DomainePartenaire}/accounts/123"
 },
 "bankaccount":
 {
 "Id": 28852,
 "displayname":"Compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx3520962",
 "ismine":true, 
 "Status": 1
 },


 "amount":100,
 "fee":
 {
 "amount":150,
 "VAT":19.6,
 "amountWithVAT":179,
 "status":1
 },
 "operationdate":"2013-09-10T15:49:58.791121+02:00" ,
 "message": "virement S-money du 21/01/2014",
 "orderid":"moneyout-1",
 "Reference": "refXlzX3",
 "Motif": "virement smoney",
 "ExecutedDate": null

}, {…}]

Create a bank transfer

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

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

The mandatory parameters are as follows:
orderid
amout
bankaccount
amoutWithVAT
VAT

Error case :

HTTP code	Error Code	Explication
400	110	Insufficient balance
400	111	Your account is incorrect or incomplete
400	302	Bank account cannot be found
400	362	Operation is not allowed
400	703	Transaction limit has been reached (KYC 1 level)
400	702	Transaction limit has been reached (KYC 2 level)
400	704	Missing request(s) parameter(s)

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

{
 "orderid":"moneyout-1",
 "amount":100,
 "accountid": {
 "appaccountid":"123" 
 },
 "bankaccount":{
 "id":42
 },
 "fee": {
 "amountWithVAT":180,
 "VAT":20
 },
 "message": "virement S-money du 21/01/2016",
 "reference" : "ref123456",
 "motif" : "virement S-money du xxxxx" 

}

Réponse :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v1+json
Location: /api/DomainePartenaire/payouts/id

{
 "id":21,
 "accountid":
 {
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "Email": null,
 "PhoneNumber": null,
 "Alias": null,
 "href":"/api/{DomainePartenaire}/accounts/123"
 },
 "bankaccount":
 {
 "Id": 28852,
 "displayname":"Compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx3520962",
 "ismine":true, 
 "Status": 1
 },


 "amount":100,
 "fee":
 {
 "amount":150,
 "VAT":19.6,
 "amountWithVAT":179,
 "status":1
 },
 "operationdate":"2013-09-10T15:49:58.791121+02:00" ,
 "message": "virement S-money du 21/01/2014",
 "orderid":"moneyout-1",
 "Reference": "refXlzX3",
 "Motif": "virement smoney",
 "ExecutedDate": null

}

Resources

Hadassa — 2016-07-05T11:40:04Z

The creation of a transfer is done via :
/api/DomainePartenaire/users/appuserid/payouts/storedbankaccounts to create a transfer to a registered account for the user belonging to the connected third-party application.

Retrieving transfers can be done via:
/api/DomainePartenaire/users/appuserid/payouts/ to retrieve transfers for a user belonging the connected third-party application.

1.Payouts

Parameter	Type	Example	Description
OrderId	String	Moneyout-1	Transfer reference in the third-party application
Id	Long	412	Transfer ID
AccountId	SubAccountRef		Specifies the sub-account making the payment. (If not specified, the main account is used)
BankAccount	BankAccount		Bank account used
Amount	Long	2350	Transfer ammount (in cents)
Fee	Fee		Fee
OperationDate	DateTime	2013-09-10T 15:49:58.791121 +02:00	Transfer Date
Message	String	S-money transfer of 01/22/2014	Heading associated with the transfer.
Reference	String	REF123456	It is the EndtoEndID, it will be transfered in the SEPA Transfer operation (limited to 35 caracters)
Motif	String	Virement S-money	It is the heading, it will be transfered in the SEPA Transfer operation (limited to 35 caracters)
ExecutedDate	DateTime	2017-08-02T17:37:55	Date of the execution of the transfer

2.BankAccount

Parameter	Type	Example	Description
Id	Long		Bank account ID
DisplayName	String	"Bank account"	Display name for the bank account
Bic	String		Bank Identifier Code (BIC)
Iban	String		International Bank Account Number (IBAN)
IsMine	Bool		The bank account belongs to the user

3.SubAccountRef

This object enables the identification of the accounts between which the oprations are made.

Parameters	Type	Example	Description
Id	Long	98	Account ID
AppAccountId	String	"123 "	ID of the account provided by the third-party application
DisplayName	String	"John Smith"	Account display name
href	url	/api/DomainePartenaire/accounts/123	URL to the account details

4.Fee

The object Fee defines the fees applied.

Parameters	Type	Example	Description
Amount	long	150	Fee amount without taxes (in cents)
VAT	double	19.6	fee percentage (in percentage)
AmountWithVAT	long	179	Fee amount all taxes included (in cents)
Status	Int	1	fee status 0 = Pending 1 = Succeeded 2 = Cancelled 3 = Failed 4 = Expired 5 = Refunded

Récupérer un virement

Axel — 2015-07-28T16:00:42Z

Pour récupérer un virement veuillez vous référer à l'exemple présent en marge de droite de cette page.

Cas d'erreurs :

Code HTTP	Code erreur	Explication
404	356	Opération introuvable

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

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

{
 "id":21,
 "accountid":
 {
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "Email": null,
 "PhoneNumber": null,
 "Alias": null,
 "href":"/api/{DomainePartenaire}/accounts/123"
 },
 "bankaccount":
 {
 "Id": 28852,
 "displayname":"Compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx3520962",
 "ismine":true, 
 "Status": 1
 },


 "amount":100,
 "fee":
 {
 "amount":150,
 "VAT":19.6,
 "amountWithVAT":179,
 "status":1
 },
 "operationdate":"2013-09-10T15:49:58.791121+02:00" ,
 "message": "virement S-money du 21/01/2014",
 "orderid":"moneyout-1",
 "Reference": "refXlzX3",
 "Motif": "virement smoney",
 "ExecutedDate": null

}

Récupérer la liste des virements

Axel — 2015-07-28T16:00:17Z

Pour récupérer la liste des virements veuillez vous référer à l'exemple présent en marge de droite de cette page.

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

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

[{
 "id":21,
 "accountid":
 {
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "Email": null,
 "PhoneNumber": null,
 "Alias": null,
 "href":"/api/{DomainePartenaire}/accounts/123"
 },
 "bankaccount":
 {
 "Id": 28852,
 "displayname":"Compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx3520962",
 "ismine":true, 
 "Status": 1
 },


 "amount":100,
 "fee":
 {
 "amount":150,
 "VAT":19.6,
 "amountWithVAT":179,
 "status":1
 },
 "operationdate":"2013-09-10T15:49:58.791121+02:00" ,
 "message": "virement S-money du 21/01/2014",
 "orderid":"moneyout-1",
 "Reference": "refXlzX3",
 "Motif": "virement smoney",
 "ExecutedDate": null

}, {…}]

Créer un virement

Axel — 2015-07-28T15:59:18Z

Pour créer un virement vers un compte bancaire veuillez vous référer à l'exemple présent en marge de droite de cette page.

Les paramètres obligatoires sont :
orderid
amout
bankaccount

Cas d'erreurs :

Code HTTP	Code erreur	Explication
400	110	Solde insuffisant
400	111	Votre compte est incorrect ou incomplet
400	302	Compte bancaire introuvable
400	362	Opération non autorisée
400	703	Plafond de transaction atteint (Niveau KYC 1)
400	702	Plafond de transaction atteint (Niveau KYC 2)
400	704	Paramètre(s) d'appel manquant(s)

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

{
 "orderid":"moneyout-1",
 "amount":100,
 "accountid": {
 "appaccountid":"123" 
 },
 "bankaccount":{
 "id":42
 },
 "fee": {
 "amountWithVAT":180,
 "VAT":20
 },
 "message": "virement S-money du 21/01/2016",
 "reference" : "ref123456",
 "motif" : "virement S-money du xxxxx" 

}

Réponse :
HTTP/1.1 201 CREATED
Content-Type : application/vnd.s-money.v1+json
Location : /api/DomainePartenaire/payouts/id

{
 "id":21,
 "accountid":
 {
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "Email": null,
 "PhoneNumber": null,
 "Alias": null,
 "href":"/api/{DomainePartenaire}/accounts/123"
 },
 "bankaccount":
 {
 "Id": 28852,
 "displayname":"Compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx3520962",
 "ismine":true, 
 "Status": 1
 },


 "amount":100,
 "fee":
 {
 "amount":150,
 "VAT":19.6,
 "amountWithVAT":179,
 "status":1
 },
 "operationdate":"2013-09-10T15:49:58.791121+02:00" ,
 "message": "virement S-money du 21/01/2014",
 "orderid":"moneyout-1",
 "Reference": "refXlzX3",
 "Motif": "virement smoney",
 "ExecutedDate": null

}

Ressources

Axel — 2015-07-28T15:58:48Z

La création d'un virement se fait via :
/api/DomainePartenaire/users/appuserid/payouts/storedbankaccounts pour créer un virement vers un compte enregistré pour l'utilisateur appartenant à l'application tierce connectée

La récupération des virements peut se faire via :
/api/DomainePartenaire/users/appuserid/payouts/ pour récupérer les virements pour un utilisateur appartenant à l'application tierce connectée.

1.Payouts

Propriété	Type	Exemple	Description
OrderId	String	Moneyout-1	Référence du virement chez l'application tierce
Id	Long	412	Id du virement
AccountId	SubAccountRef		Précise le sous-compte qui effectue le paiement. (si non précisé, c'est le compte principal qui est utilisé)
BankAccount	BankAccount		Compte bancaire utilisé
Amount	Long	2350	Montant du virement (en centimes)
Fee	Fee		Commission
OperationDate	DateTime	2013-09-10T 15:49:58.791121 +02:00	Date du virement
Message	String	Virement S-money du 22/01/2014	Libellé associé au virement.
Reference	String	REF123456	Correspond au EndtoEndID, il sera transmis dans l'opération de virement SEPA (limité à 35 caractères)
Motif	String	Virement S-money	Correspond au libellé, il sera transmis dans l'opération de virement SEPA (limité à 35 caractères)
ExecutedDate	DateTime	2017-08-02T17:37:55	Date d'éxécution du virement

2.BankAccount

Propriété	Type	Exemple	Description
Id	Long		Identifiant du compte bancaire
DisplayName	String	"Compte bancaire"	Nom d'affichage du compte bancaire
Bic	String		Bank Identifier Code (BIC)
Iban	String		International Bank Account Number (IBAN)
IsMine	Bool		Appartenance du compte bancaire à l'utilisateur

3.SubAccountRef

Cet objet permet d'identifier les comptes entre lesquels les opérations s'effectuent.

Propriété	Type	Exemple	Description
Id	Long	98	Identifiant du compte
AppAccountId	String	"123 "	Identifiant du compte fournit par l'appli tierce
DisplayName	String	"Jean Dupont"	Nom d'affichage du compte
href	url	/api/DomainePartenaire/accounts/123	Uri vers le détail du compte

4.Fee

L'objet Fee définit les commissions qui seront appliquées.

Propriété	Type	Exemple	Description
Amount	long	150	Montant HT de la commission (en centimes)
VAT	double	19.6	Pourcentage de la commission (en pourcentage)
AmountWithVAT	long	179	Montant TTC de la commission (en centimes)
Status	Int	1	Statut de la commission 0 = Pending 1 = Succeeded 2 = Cancelled 3 = Failed 4 = Expired 5 = Refunded