Utilisateurs

Ressources

User

Propriété Type Exemple Description
Id Long 114 Id S-money de l’utilisateur
AppUserId String Client-112 Identifiant de l’utilisateur chez l’application tierce
Role int 1 Rôle de l’utilisateur
1 = Client
2 = Client étendu (KYC)
Type int 1 Type de l’utilisateur :
0 = N/A
1 = Client particulier
2 = Client professionnel
Profile UserProfile Informations de profil de l’utilisateur
Amount Long Montant cumulé de tous les sous-comptes de l’utilisateur (en centimes)
SubAccounts List<Account> Liste des sous-comptes associés à l’utilisateur
BankAccounts List<BankAccountRef > Liste des références vers les comptes bancaires de l’utilisateur
CBCards List<CBCardRef> Liste des cartes CB de l’utilisateur
Status UserStatus 1 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)
7 = En opposition
Company Company Si l’utilisateur créé est une société, il contient les informations de la société.

UserProfile

Propriété Type Exemple Description
Civility Int 0 Civilité
0 = M.
1 = Mme, Mlle
Firstname String Jean Prénom
Lastname String Dupont Nom de famille
Birthdate Datetime 1985-09-29T00:00:00 Date de naissance
Address Address Adresse
Phonenumber String 0600000001 Numéro de téléphone mobile
Email String jeandupont@s-money.fr Adresse email
Alias String Jean-dupont Pseudo de l’utilisateur.
Nombre de caractères maximum : 32
Regex : ^([a - zA - Z]) ([a - zA - Z0 - 9_-.#\s]+)$
Photo PhotoRef Référence vers la photo de l’utilisateur
Birthcity String Paris Ville de naissance de l’utilisateur
Birthcountry String FR Pays de naissance de l’utilisateur (code ISO 3166-1)
ThirdPartyIntroduction Int 0 0 si le client n’est pas Tiers Introduit
CSPCode String 31 Categorie Socio Professionnelle selon la nomenclature INSEE PCS 2003 Niveau 3 :
11 = Agriculteurs sur petite ou moyenne exploitation
13 = Agriculteurs sur grande exploitation
21 = Artisan, Commerçant et assimilés
23 = Chefs d’entreprise de 10 salariés ou plus
31 = Professions libérales
34 = Professeurs, professions scientifiques
37 = Cadres administratifs et commerciaux d’entreprise, Ingénieurs et cadres techniques d’entreprise
33 = Cadres de la fonction publique
35 = Professions de l’information, des arts et des spectacles
42 = Professeurs des écoles, instituteurs et assimilés
43 = Professions intermédiaires administratives et commerciales des entreprises, de la santé et du travail social ou Techniciens
44 = Clergé, religieux
45 = Professions intermédiaires administratives de la fonction publique
48 = Contremaîtres, agents de maîtrise
52 = Employés de commerce, d’entreprise ou de la fonction publique
53 = Policiers et militaires
56 = Personnels des services directs aux particuliers
62 = Ouvriers agricoles ou qualifiés de type industriel/artisanal
65 = Autres ouvriers
64 = Chauffeurs
84 = Etudiants
71 = Retraités
81 = Sans activité professionnelle

SubAccount

Propriété Type Exemple Description
Id Long 225 Identifiant du compte
AppAccountId String "123" Identifiant du compte chez l’application tierce
DisplayName String Jean Dupont Nom d’affichage
Amount Int 5102 Montant du compte (en centimes)
IsDefault Bool True Indique s’il s’agit du compte principal de l’utilisateur
CreationDate DateTime 2013-09-29T00:00:00 Date de création du compte

BankAccountRef

Propriété Type Exemple Description
Id Long 2 Id du compte bancaire
Href String /api/bankaccounts/2 Lien vers le détail du compte bancaire

CBCardRef

Propriété Type Exemple Description
Id Long 12 Id de la carte
href String /api/cards/22 Lien vers le détail de la CB

Address

Propriété Type Exemple Description
Street String 2 rue des châtaigniers Numéro et rue
Zipcode String 75001 Code postal
City String Paris Ville
Country String "FR" Nationalité (code ISO 3166-1)
FR = France
DE = Allemagne
AT = Autriche
BE = Belgique
BG = Bulgarie
CY = Chypre
DK = Danemark
ES = Espagne
EE = Estonie
FI = Finlande
GR = Grèce
HR = Croatie
HU = Hongrie
IE = Irlande
IS = Islande
IT = Italie
LV = Lettonie
LI = Liechtenstein
LT = Lituanie
LU = Luxembourg
MT = Malte
NO = Norvège
NL = Pays-Bas
PL = Pologne
PT = Portugal
CZ = République Tchèque
RO = Roumanie
GB = Royaume-Uni
SK = Slovaquie
SI = Slovénie
SE = Suède
CH = Suisse
ZA = Afrique du sud
AU = Australie
CA = Canada
KR = Corée du sud
US = États-Unis
HK = Hong Kong
IN = Inde
JP = Japon
MX = Mexique
SG = Singapour
GP = Guadeloupe
MQ = Martinique
GF = Guyane
YT = Mayotte
NC = Nouvelle-Calédonie
PF = Polynésie française
RE = La Réunion
BL = Saint-Barthélemy
MF = Saint-Martin
PM = Saint-Pierre-et-Miquelon
TF = Terres australes et antarctiques françaises
WS = Wallis-et-Futuna

Company

Propriété Type Exemple Description
Name String JP-Company Nom de la société ou de l’association
Siret String 123456789 Siret ou RNA
NAFCode String 4741Z Code NAF de l’entreprise

Créer un utilisateur particulier

Pour créer un utilisateur particulier, les informations obligatoires à transmettre sont :

  • un appUserId,
  • le nom,
  • le prénom,
  • la date de naissance,
  • le pays de résidence,
  • le CSP.

Pour éviter toute confusion par la suite, nous vous recommandons :

  • d’utiliser un appUserId du type "companyName-id"
  • de fournir un e-mail

Les comptes créés à travers l’API sont limités par les plafonds annuels de la monnaie électronique. Pour aller au-delà des plafonds, il faudra compléter l’adresse et transmettre les pièces justificatives via l’API dédiée (cf. chapitre Demande de KYC).

Cas d’erreurs :

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide
400 704 Paramètre d’appel manquant
400 177 Paramètre d’appel invalide
400 567 Date de naissance invalide
400 377 L’utilisateur doit avoir plus de 18 ans
400 550 Email incorrect ou déjà utilisé
400 514 Alias du compte incorrect ou déjà utilisé
400 515 Numéro de téléphone incorrect ou déjà utilisé
400 378 Pays invalide (doit faire partie de l’Union Européenne)
404 147 Utilisateur introuvable
400 302 BIC/IBAN non renseignés, impossible de virer les fonds restants sur le compte de l’utilisateur.
400 703 Plafond de transaction unitaire atteint, impossible de virer les fonds restants sur le compte de l’utilisateur
400 344 Plafond de transaction annuel atteint, impossible de virer les fonds restants sur le compte de l’utilisateur
400 182 Code pays inconnu

Créer un utilisateur professionnel

Pour une société ou une association, les informations obligatoires supplémentaires à transmettre sont :

  • le type : en lui donnant la valeur 2,
  • le nom de la société (ou de l’association),
  • le code NAF constitué de cinq caractères (quatre chiffres et une lettre).

Remarque : pour un CSE/Comité d’entreprise, vous devez obligatoirement indiquer le code NAF 9420Z.

Pour éviter toute confusion par la suite, nous vous recommandons :

  • d’utiliser un appUserId du type "companyName-id"
  • de fournir un e-mail
  • d’indiquer un SIRET

Pour créer un utilisateur professionnel référez-vous à l’exemple présent dans la marge de droite.

Cas d’erreurs :

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide
400 704 Paramètre d’appel manquant
400 177 Paramètre d’appel invalide
400 177 Valeur de paramètre invalide (Code NAF)
400 567 Date de naissance invalide
400 377 L’utilisateur doit avoir plus de 18 ans
400 550 Email incorrect ou déjà utilisé
400 514 Alias du compte incorrect ou déjà utilisé
400 515 Numéro de téléphone incorrect ou déjà utilisé
400 378 Pays invalide (doit faire partie de l’Union Européenne)

Récupérer la liste des utilisateurs

Pour récupérer la liste des utilisateurs référez-vous à l’exemple présent dans la marge de droite.

Requête :

Propriété Type Description Valeur par défaut
page Int Numéro de la page (commence à 1) 1
per_page Int Nombre d’objets par page 50

Cas d’erreurs :

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide

Récupérer un utilisateur

Pour récupérer un utilisateur référez-vous à l’exemple présent dans la marge de droite.

Cas d’erreurs :

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide
404 147 Utilisateur introuvable

Modifier un utilisateur

Pour modifier un utilisateur référez-vous à l’exemple présent dans la marge de droite.

Cas d’erreurs :

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide
400 704 Paramètre d’appel manquant
400 177 Paramètre d’appel invalide
404 147 Utilisateur introuvable
400 567 Date de naissance invalide
400 377 L’utilisateur doit avoir plus de 18 ans
400 550 Email incorrect ou déjà utilisé
400 514 Alias du compte incorrect ou déjà utilisé
400 515 Numéro de téléphone incorrect ou déjà utilisé

Clôturer le compte d’un utilisateur

Pour clôturer le compte d’un utilisateur référez-vous à l’exemple présent dans la marge de droite.

Cas d’erreurs :

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide
400 704 Paramètre d’appel manquant
400 177 Paramètre d’appel invalide
404 147 Utilisateur introuvable
400 302 BIC/IBAN non renseignés, impossible de virer les fonds restants sur le compte de l’utilisateur.
400 703 Plafond de transaction unitaire atteint, impossible de virer les fonds restants sur le compte de l’utilisateur
400 344 Plafond de transaction annuel atteint, impossible de virer les fonds restants sur le compte de l’utilisateur
400 1050 Le statut du compte ne permet pas cette opération
400 1036 Le compte n’a pas un solde nul. Merci de vider le compte avant fermeture

Changer le type du compte utilisateur (particulier vers pro)

Pour changer le type du compte utilisateur (particulier vers pro) référez-vous à l’exemple présent dans la marge de droite.

Cas d’erreurs :

Code HTTP Code erreur Explication
400 704 Paramètre d’appel manquant

Rechercher un utilisateur

Pour rechercher un utilisateur, référez-vous à l’exemple présent dans la marge de droite.

Propriété Type Description Valeur par défaut
page Int Numéro de la page (commence à 1 1
per_page Int Nombre d’objets par page 50
smoneyid string Liste d’ID S-money, séparés par des virgules
firstname string Prénom
lastname string Nom
email string email

Cas d’erreur

Code HTTP Code d’erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide

Mettre en opposition un utilisateur

Pour mettre en opposition un utilisateur, merci de vous référer à l’exemple présent dans la marge de droite.

Cas d’erreur

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide
401 704 Paramètre d’appel manquant
401 177 Paramètre d’appel invalide
401 147 Utilisateur introuvable