S-money API

Resources

Thomas Rennesson — 2016-07-04T16:03:42Z

User

Property	Type	Example	Description
Id	Long	114	S-money user ID
AppUserId	String	Client-112	User identifier in the third-party application
Role	int	1	User's role 1 = Client 2 = Extended client (KYC)
Type	int	1	User type 0 = N/A 1 = Individual client 2 = Professional clientl
Profile	UserProfile		User's profile information
Amount	Long		Cumulative amount of all user sub-accounts (in cents)
SubAccounts	List>		List of sub-accounts associated with the user
BankAccounts	List >		List of references to user's bank accounts
CBCards	List>		List of user's CB cards
Status	UserStatus	1	User status 0 = Not confirmed 1 = OK 2 = Frozen 3 = On the fly 4 = Being closed 5 = Closed 6 = Waiting for KYC (bank transfers blocked) 7 = Blocked
Company	Company		If the created user is a company, then it contains information of the company.

UserProfile

Property	Type	Example	Description
Civility	Int	0	Civility 0 = Mr 1 = 1 = Mrs, Miss
Firstname	String	Jean	Name
Lastname	String	Dupont	Surname
Birthdate	Datetime	1985-09-29T00:00:00	Date of birth
Address	Address		Addresse
Phonenumber	String	0600000001	Mobile phone number
Email	String	jeandupont@s-money.fr	E-mail address
Alias	String	Jean-dupont	User nickname Maximum number of characters: 32
Photo	PhotoRef		Reference to the user photo
Birthcity	String	Paris	City of birth
Birthcountry	String	FR	Country of birth (code ISO 3166-1)
ThirdPartyIntroduction	Int	0	0 si le client n'est pas Tiers Introduit
CSPCode	String	31	Profession and socioprofessional category according to classification INSEE PCS 2003 level3: 11=Agriculteurs sur petite exploitation 12=Agriculteurs sur moyenne exploitation 13=Agriculteurs sur grande exploitation 21=Artisans 22=Commerçants et assimilés 23=Chefs d'entreprise de 10 salariés ou plus 31=Professions libérales 33=Cadres de la fonction publique 34=Professeurs, professions scientifiques 35=Professions de l'information, des arts et des spectacles 37=Cadres administratifs et commerciaux d'entreprise 38=Ingénieurs et cadres techniques d'entreprise 42=Professeurs des écoles, instituteurs et assimilés 43=Professions intermédiaires de la santé et du travail social 44=Clergé, religieux 45=Professions intermédiaires administratives de la fonction publique 46=Professions intermédiaires administratives et commerciales des entreprises 47=Techniciens 48=Contremaîtres, agents de maîtrise 52=Employés civils et agents de service de la fonction publique 53=Policiers et militaires 54=Employés administratifs d'entreprise 55=Employés de commerce 56=Personnels des services directs aux particuliers 62=Ouvriers qualifiés de type industriel 63=Ouvriers qualifiés de type artisanal 64=Chauffeurs 65=Ouvriers qualifiés de la manutention, du magasinage et du transport 67=Ouvriers non qualifiés de type industriel 68=Ouvriers non qualifiés de type artisanal 69=Ouvriers agricoles 71=Anciens agriculteurs exploitants 72=Anciens artisans, commerçants, chefs d'entreprise 74=Anciens cadres 75=Anciennes professions intermédiaires 77=Anciens employés 78=Anciens ouvriers 81=Chômeurs n'ayant jamais travaillé 83=Militaires du contingent 84=Elèves, étudiants 85=Personnes diverses sans activité professionnelle de moins de 60 ans (sauf retraités) 86=Personnes diverses sans activité professionnelle de 60 ans et plus (sauf retraités)

SubAccount

Property	Type	Example	Description
Id	Long	225	Account identifier
AppAccountId	String	"123"	Account identifier in the third-party application
DisplayName	String	Jean Dupont	Display name
Amount	Int	5102	Account amount (in cents)
IsDefault	Bool	True	Indicate if it is a main user account
CreationDate	DateTime	2013-09-29T00:00:00	Account creation date

BankAccountRef

Property	Type	Example	Description
Id	Long	2	Bank account ID
Href	String	/api/bankaccounts/2	Link to bank account details

CBCardRef

Property	Type	Example	Description
Id	Long	12	Card Id
href	String	/api/cards/22	Link to CB details

Address

Property	Type	Example	Description
Street	String	2 rue des châtaigniers	Number and street
Zipcode	String	75001	Postcode
City	String	Paris	City
Country	String	"FR"	Nationality (code ISO 3166-1) FR = France DE = Germany AT = Austria BE = Belgium BG = Bulgaria CY = Cyprus DK = Denmark ES = Spain EE = Estonia FI = Finland GR = Greece HR = Croatia HU = Hungary IE = Irleand IS = Iceland IT = Italy LV = Latvia LI = Liechtenstein LT = Lithuanie LU = Luxembourg MT = Malta NO = Norway NL = Netherlands PL = Poland PT = Portugal CZ = The Czech Republic RO = Romania GB = Great Britain SK = Slovakia SI = Slovenia SE = Sweden CH = Switzerland ZA = South Africa AU = Australia CA = Canada KR = South Korea US = United States HK = Hong Kong IN = India JP = Japan MX = Mexico SG = Singapore

Company

Property	Type	Example	Description
Name	String	JP-Company	Company or association name
Siret	String	123456789	Siret or RNA
NAFCode	String	4741Z	Company NAF code

Put a block on a user

Hadassa — 2016-07-04T12:48:37Z

In order to put a block on a user, please have a look at the example in the right margin.

Error case

HTTP code	Error code	Explication
401	362	Operation not authorised
401	569	Token OAuth expired
401	570	Token OAuth invalid
401	704	Request parameter not provided
401	177	Request parameter invalid
401	147	User cannot be found

Request
PUT /api/domaine_partenaire /users/appuserid HTTP/1.1
Accept: application/vnd.s-money.v1+json
Content-Type: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "status":7

}

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

{
 "id":114,
 "appUserId":"client-112",
 "role":1,
 "type":1,
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "address":
 { 
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont",
 "CSPCode":"31"
 },
 "amount":0,
 "subaccounts":
 [{
 "id":"225",
 "appaccountid":"87",
 "amount":0",
 "displayname":"Sous compte",
 "isdefault":true
 }, {…}],
 "bankaccounts":
 [{
 "id":2,
 "href":"/api/users/{appuserid}/bankaccounts/2"
 }, {…}],
 "cbcards":
 [{
 "id":12,
 "network":1,
 "href":"/api/users/{appuserid}/cbcards/12
 }, {…}],
 "status":7

}

Search for a user

Hadassa — 2016-07-04T12:44:30Z

In order to search for a user, please have a look at the example in the right margin.

Property	Type	Description	Default value
page	Int	Page number (starts with 1)	1
per_page	Int	Number of items per page	50
smoneyid	string	List of S-money ID separated by commas
firstname	string	Name
lastname	string	Surname
email	string	email

Error cases

HTTP code	Error code	Explication
401	362	Operation not authorised
401	569	Token OAuth expired
401	570	Token OAuth invalid

Request
GET /api/domaine_partenaire /users/search?firstname=Jean 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":114,
 "appUserId":"client-112",
 "role":1,
 "type":1,
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont",
 "CSPCode":"31"
 },
 "amount":0,
 "subaccounts":
 [{
 "id":"225",
 "amount":0",
 "displayname":"Sous compte",
 "isdefault":true 
 }, {…}],
 "bankaccounts":
 [{
 "id":2,
 "href":"/api/users/{appuserid}/bankaccounts/2"
 }, {…}],
 "cbcards":
 [{
 "id":12,
 "network":1,
 "href":"/api/users/{appuserid}/cbcards/12
 }, {…}],
 "status":1
 }, {…}]

Change the type of a user account (especially to pro)

Hadassa — 2016-07-04T12:40:32Z

In order to change the type of a user account (especially to pro), please have a look at the example in the right margin.

Error cases

HTTP code	Error code	Explication
400	704	Request parameter not provided

Request :
PUT /api/[domaine_partenaire]/users/appuserid HTTP/1.1
Accept : application/vnd.s-money.v1+json
Content-Type : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

{
 "type" : 2,
 "company" : 
 { 
 "name":"JD-Company",
 "siret" : "12345",
 "NAFCode":"4741Z" 
 } 

}

Response :
HTTP/1.1 200 OK
Cahe-Control: no-cache
Pragma: no-cache
Content-Type: application/vnd.s-money.v2+json; charset=utf-8

{
 "id":114,
 "appUserId":"client-112",
 "role":1,
 "type":2,
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont"
 },
 "amount":0,
 "subaccounts":
 [{
 "id":"225",
 "appaccountid":"87",
 "amount":0",
 "displayname":"Sous compte",
 "isdefault":true
 }, {…}],
 "bankaccounts": 
 [{
 "id":2,
 "href":"/api/users/{appuserid}/bankaccounts/2"
 }, {…}],
 "cbcards":
 [{
 "id":12,
 "network":1,
 "href":"/api/users/{appuserid}/cbcards/12"
 }, {…}],
 "status":1,
 "company": {
 "name": "JD-Company",
 "siret": “12345”,
 "NAFCode":"4741Z" 

}

Close the user account

Hadassa — 2016-07-04T12:38:18Z

In order to close the user account, please have a look at the example in the right margin.

Error cases

HTTP code	Error code	Explication
401	362	Operation not authorised
401	569	Token OAuth expired
401	570	Token OAuth invalid
400	704	Request parameter not provided
400	177	Request parameter invalid
404	147	User cannot be found
400	302	BIC/IBAN not provided, impossible to transfer remaining funds to the user account.
400	703	Unitary transaction limit has been reached, impossible to transfer the remaining funds to the user account
400	344	Annual transaction limit has been reached, impossible to transfer the remaining funds to the user account.
400	1050	Account status does not allow this operation
400	1036	The wallet is not empty. Please empty the account before closing

Request :
PUT /api/[domaine_partenaire]/users/appuserid HTTP/1.1
Accept: application/vnd.s-money.v1+json
Content-Type: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "status":5 

}

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

{
 "id":114, 
 "appUserId":"client-112",
 "role":1,
 "type":1,
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont",
 "CSPCode":"31"
 },
 "amount":0,
 "subaccounts":

[{
 "id":"225",
 "appaccountid":"87",
 "amount":0,
 "displayname":"Sous compte",
 "isdefault":true

}, {…}],
 "bankaccounts":

[{
 "id":2,
 "href":"/api/users/{appuserid}/bankaccounts/2"

}, {…}],

"cbcards":

[{
 "id":12,
 "network":1,
 "href":"/api/users/{appuserid}/cbcards/12"

}, {…}],
 "status":5

}

Modify a user

Hadassa — 2016-07-04T12:32:47Z

To modify a user, please have a look at the example in the right margin.

Error Cases :

HTTP code	Error code	Explication
401	362	Operation not authorised
401	569	Token OAuth expired
401	570	Token OAuth invalid
400	704	Request parameter not provided
400	177	Request parameter invalid
404	147	User cannot be found
400	567	Date of birth invalid
400	377	The user must be over 18 years old
400	550	Incorrect or already taken e-mail
400	514	Incorrect or already taken account alias
400	515	Incorrect or already taken telephone number

Request :
PUT /api/[domaine_partenaire]/users/appuserid HTTP/1.1
Accept: application/vnd.s-money.v1+json
Content-Type: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "profile":
 { 
 "civility":0, 
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "address": 
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "CSPCode":"31"
 } 

}

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

{
 "id":114, 
 "appUserId":"client-112",
 "role":1,
 "type":1,
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont"
 },
 "amount":0,
 "subaccounts":

[{
 "id":"225",
 "appaccountid":"87",
 "amount":0,
 "displayname":"Sous compte",
 "isdefault":true

}, {…}],
 "bankaccounts":

[{
 "id":2,
 "href":"/api/users/{appuserid}/bankaccounts/2"

}, {…}],

"cbcards":

[{
 "id":12,
 "network":1,
 "href":"/api/users/{appuserid}/cbcards/12"

}, {…}],
 "status":1

}

Retrieve a user

Hadassa — 2016-07-04T12:24:19Z

To retrieve a user, please have a look at the example in the right margin.

Error Cases :

HTTP code	Error code	Explication
401	362	Operation not authorised
401	569	Token OAuth expired
401	570	Token OAuth invalid
404	147	User cannot be found

Request :
GET /api/[domaine_partenaire]/users/appuserid 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":114,
 "appUserId":"client-112",
 "role":1,
 "type":1,
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont",
 "CSPCode":"31"
 },
 "amount":0,
 "subaccounts":

[{
 "id":"225",
 "appaccountid":"87",
 "amount":0,
 "displayname":"Sous compte",
 "isdefault":true

}, {…}],
 "bankaccounts":

[{
 "id":2,
 "href":"/api/users/{appuserid}/bankaccounts/2"

}, {…}],

"cbcards":

[{
 "id":12,
 "network":1,
 "href":"/api/users/{appuserid}/cbcards/12"

}, {…}],
 "status":1

}

Retrieve the list of users

Hadassa — 2016-07-04T12:13:07Z

To retrieve the list of users, please have a look at the example in the right margin.

Request:

Property	Type	Description	Default value
page	Int	Page number (starts with 1)	1
per_page	Int	Number of items per page	50

Error cases

HTTP Code	Error code	Explication
401	362	Operation not authorised
401	569	Token OAuth expired
401	570	Token OAuth invalid

Request:
GET /api/[domaine_partenaire]/users?page=1&perPage=50 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

Link: "; rel="next", 

; rel="last""

Total-count: 253



[{
 "id":114, 
 "appUserId":"client-112",
 "role":1,
 "type":1,
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont",
 "CSPCode":"31"
 },
 "amount":0,
 "subaccounts":

[{
 "id":"225",
 "amount":0,
 "displayname":"Sous compte",
 "isdefault":true

}, {…}],
 "bankaccounts":

[{
 "id":2,
 "href":"/api/users/{appuserid}/bankaccounts/2"

}, {…}],

"cbcards":

[{
 "id":12,
 "network":1,
 "href":"/api/users/{appuserid}/cbcards/12"

}, {…}],
 "status":1

}, {…}]

Create a professional user

Hadassa — 2016-07-04T12:07:52Z

To create a user, provide the following informations:

type 2
company name
NAF code

In order to avoid any confusion, we recommend:

to use a "companyName-id" type as an appUserId
to provide an e-mail address
to provide the SIRET

To create a professional user, please have a look at the example in the right margin.

Error cases :

HTTP Code	Error code	Explication
401	362	Operation not authorised
401	569	Token OAuth expired
401	570	Token OAuth invalid
400	704	Request parameter not provided
400	177	Request parameter invalid
400	567	Date of birth invalid
400	377	The user must be over 18 years old
400	550	Incorrect or already taken e-mail
400	514	Incorrect or already taken account alias
400	515	Incorrect or already taken telephone number
400	378	Invalid country (it needs to be within the EU)

Request:

POST /api/[domaine_partenaire]/users HTTP/1.1
Content-Type: application/vnd.s-money.v1+json
Accept: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "appuserid":"client-112",
 "type":2,
 "profile":
 {
 "civility":0, 
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "birthcity": "Paris",
 "birthcountry": "FR",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont",
 },
 "company":
 {
 "name":"JD-Company",
 "SIRET":"123456789",
 "NAFCode":"4741Z" 
 }

}

Response:
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v1+json
Location: /api/users/appuserid

{
 "id":114,
 "appuserid":"client-112",
 "role":1,
 "type":2,
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "birthcity": "Paris",
 "birthcountry": "FR",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont"
 },
 "amount":0,
 "subaccounts":
 [{
 "id":"225",
 "amount":0,
 "displayname":"Jean Dupont",
 "isdefault":true
 }, {…}],
 "bankaccounts":null,
 "cbcards":null,
 "status":1,
 "company":
 {
 "name":"JD-Company",
 "SIRET":"123456789",
 "NAFCode":"4741Z"
 }

}

Create an individual user

Hadassa — 2016-07-04T11:59:14Z

To create an individual user, provide the following information:

appUserId,
surname,
firstname,
date of birth,
country of residence,
CSP.

In order to avoid any confusion, we recommend:

to use a "companyName-id" type as an appUserId
to provide an e-mail address.

Annual limits of electronic money apply to accounts created through API. In order to go beyond the limits, please provide the address and supporting documents through a dedicated API application (KYC).

Error cases :

HTTP code	Error code	Explication
401	362	Operation not authorised
401	569	Token OAuth expired
401	570	Token OAuth invalid
400	704	Request parameter not provided
400	177	Invalid request parameter
400	567	Invalid date of birth
400	377	The user should be over 18 years old
400	550	Incorrect or already taken e-mail
400	514	Incorrect or already taken account alias
400	515	Incorrect or already taken telephone number
400	378	Invalid country (it needs to be within the EU)
404	147	User cannot be found
400	302	BIC/IBAN not provided, impossible to transfer remaining funds to the user's account.
400	703	Unitary transaction limit has been reached, impossible to transfer remaining funds to the user's account
400	344	Annual transaction limit has been reached, impossible to transfer remaining funds to the user's account

POST /users
Request example:

{
 "appuserid":"client-112",
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "birthcity": "Paris",
 "birthcountry": "FR",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "email":"jeandupont@s-money.fr",
 "CSPCode":"31"
 }

}

If successful, the above call returns an HTTP code 201, and returns a JSON structured as follows:

{
 "id":114,
 "appuserid":"client-112",
 "type":1,
 "role":1,
 "profile":
 {
 "civility":0,
 "firstname":"Jean",
 "lastname":"Dupont",
 "birthdate":"1985-09-29T00:00:00",
 "birthcity": "Paris",
 "birthcountry": "FR",
 "address":
 {
 "street":"2 rue des châtaigniers",
 "zipcode":"75001",
 "city":"Paris",
 "country":"FR"
 },
 "phonenumber":"0600000001",
 "email":"jeandupont@s-money.fr",
 "alias":"jean-dupont",
 "Picture": {
 "Href": null
 },
 "ThirdPartyIntroduction": 0,
 "CSPCode":"31"
 },
 "Credentials": null,
 "amount":0,
 "subaccounts":
 [{
 "id":"225",
 "AppAccountId": "59abead",
 "amount":0,
 "displayname":"Jean Dupont",
 "CreationDate": "2019-10-02T10:58:36.1199375+02:00",
 "isdefault":true
 }, {…}],
 "bankaccounts":null,
 "cbcards":null,
 "status":1,
 "Company": null

}