S-money API

Create a bank account for a subaccount

Hadassa — 2020-01-07T16:48:09Z

To create a bank account (BIC / IBAN ) for a subaccount, please have a look at the example in the right margin of this page.

Cas d'erreurs :

Code HTTP	Code erreur	Explication
400	176	Alias du compte bancaire invalide
400	179	IBAN incorrect : l'IBAN contient des caractères invalides (autre que a-z, A-Z, ou 0-9)
400	180	IBAN incorrect : l'IBAN présente une structure invalide : Les quatre premiers caractères doivent être de la forme "lettre lettre chiffre chiffre"
400	181	IBAN incorrect : Les chiffres de vérification de l'IBAN sont invalides : Seules les valeurs 00, 01 ou 99 sont valides
400	182	IBAN incorrect : Code pays inconnu
400	183	IBAN incorrect : Nombre de caractères pour le pays incorrect
500	184	IBAN incorrect
400	185	IBAN incorrect
400	186	BIC incorrect : Longueur de BIC invalide
400	187	BIC incorrect : Format du code de banque du BIC invalide
400	188	BIC incorrect : Format du code de pays du BIC invalide
400	189	BIC incorrect : Format du code de situation du BIC invalide
400	190	BIC incorrect : Format du code de branche du BIC invalide
400	551	Vous ne pouvez pas créer plus de 3 comptes bancaires par semaine glissante pour un même utilisateur
400	556	BIC incorrect
400	704	Paramètre(s) d'appel manquant(s)
400	709	Ajout d'un compte bancaire non autorisé
400	1058	BIC et IBAN non cohérents

A noter que les comptes bancaires créé sont automatiquement validés après leur création.
Les BICs sensibles et les comptes bancaires des professionnels étendus seront eux par défaut créés en statut 2 : "en attente de validation".
Ils devront faire l'objet d'une validation de RIB par S-money pour être actifs.

Rendez vous à la rubrique "Envoi du Rib d'un compte bancaire en attente de validation" de cette même page pour en savoir plus.

Attention : Vous ne pouvez pas enregistrer plus de 3 comptes bancaires par semaine glissante pour un même utilisateur.

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

{
 "displayname":"compte bancaire",
 "bic":"CMCIFR2A",
 "iban":"FR7610011000201234567890188",
 "ismine":true,
 "Holder":
 { 
 "FirstName":"John", 
 "LastName":"Doe"
 },
 "appaccountid" : "{appaccountid-sous-compte}"

}

Réponse :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v1+json
Location: /api/[domainePartenaire]/users/appuserid/bankaccounts/

{
 "Demands": null,
 "id":42,
 "displayname":"compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx7890188",
 "ismine":true,
 "status":1,
 "Holder":
 { 
 "FirstName":"John", 
 "LastName":"Doe"
 },
 "appaccountid" : "{appaccountid-sous-compte}"

}

Enregistrer un compte bancaire sur un sous-compte

Hadassa — 2019-09-25T13:40:50Z

Pour enregistrer un compte bancaire (BIC/IBAN) en l'associant à un sous-compte, veuillez vous référer à l'exemple présent en marge de droite de cette page.

Cas d'erreurs :

Code HTTP	Code erreur	Explication
400	176	Alias du compte bancaire invalide
400	179	IBAN incorrect : l'IBAN contient des caractères invalides (autre que a-z, A-Z, ou 0-9)
400	180	IBAN incorrect : l'IBAN présente une structure invalide : Les quatre premiers caractères doivent être de la forme "lettre lettre chiffre chiffre"
400	181	IBAN incorrect : Les chiffres de vérification de l'IBAN sont invalides : Seules les valeurs 00, 01 ou 99 sont valides
400	182	IBAN incorrect : Code pays inconnu
400	183	IBAN incorrect : Nombre de caractères pour le pays incorrect
500	184	IBAN incorrect
400	185	IBAN incorrect
400	186	BIC incorrect : Longueur de BIC invalide
400	187	BIC incorrect : Format du code de banque du BIC invalide
400	188	BIC incorrect : Format du code de pays du BIC invalide
400	189	BIC incorrect : Format du code de situation du BIC invalide
400	190	BIC incorrect : Format du code de branche du BIC invalide
400	551	Vous ne pouvez pas créer plus de 3 comptes bancaires par semaine glissante pour un même utilisateur
400	556	BIC incorrect
400	704	Paramètre(s) d'appel manquant(s)
400	709	Ajout d'un compte bancaire non autorisé
400	1058	BIC et IBAN non cohérents

Rendez vous à la rubrique "Envoi du Rib d'un compte bancaire en attente de validation" de cette même page pour en savoir plus.

Attention : Vous ne pouvez pas enregistrer plus de 3 comptes bancaires par semaine glissante pour un même utilisateur.

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

{
 "displayname":"compte bancaire",
 "bic":"CMCIFR2A",
 "iban":"FR7610011000201234567890188",
 "ismine":true,
 "Holder":
 { 
 "FirstName":"John", 
 "LastName":"Doe"
 },
 "appaccountid" : "{appaccountid-sous-compte}"

}

Réponse :
HTTP/1.1 201 CREATED
Content-Type : application/vnd.s-money.v1+json
Location : /api/[domainePartenaire]/users/appuserid/bankaccounts/

{
 "Demands": null,
 "id":42,
 "displayname":"compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx7890188",
 "ismine":true,
 "status":1,
 "Holder":
 { 
 "FirstName":"John", 
 "LastName":"Doe"
 },
 "appaccountid" : "{appaccountid-sous-compte}"

}

Send details of a bank account awaiting validation

Hadassa — 2017-08-10T17:00:57Z

A bank account with the status "Awaiting validation" has to be verified by S-money.

To obtain the validation of this bank account, you have to:
Do a KYC request
Send a copy of bank account details

To send the details of the bank account awaiting validation through the API, please have a look at the example in the right margin of this page.

To see the list of the user documents, please refer to this section.

Send data to the third-party server

The third-party server has to make available a server url enabling the S-money server to notify it when a bank account is registered with the status "awaiting validation" and it has been validated or rejected.

The call of the S-money Server is made using the method HTTP POST.

The parameters of the HTTP request are:

Parameter	Type	Description
type	Int	Operation type 10 = Bank account details
id	Long	Bank account ID
status	Int	2 = Awaiting validation
userid	String	User ID
userstatus	Int	User ID 6 = Awaiting KYC (transfers blocked)

Example of callback:

POST https://s-money.fr/callback?type=10&id=270978&status=2&userid=623b5620-dca3-5b73-6011-46a8871e94bc&userstatus=6

Requête :
POST /api/[domaine partenaire]/users/appuserid/bankaccounts/id-du-compte-bancaire-en-attente-de-validation/rib/attachments HTTP/1.1
Authorization: Bearer ACCESS_TOKEN
Accept: application/vnd.s-money.v1+json
Content-Type: multipart/form-data; boundary=-------------------------acebdf13572468
---------------------------acebdf13572468
Content-Disposition: form-data; name="file1"; filename="img1.png"
Content-Type: image/png
[FILE CONTENT]
---------------------------acebdf13572468

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

Envoi du Rib d'un compte bancaire en attente de validation

Hadassa — 2017-08-10T16:59:38Z

Un compte bancaire qui a le statut "En attente de validation" doit être vérifié par S-money.

Afin d'obtenir la validation du dit compte bancaire, il faut :
Effectuer une demande de KYC
Envoyer la copie du Rib

Pour envoyer la copie du Rib du compte bancaire en attente de validation via l'API, veuillez vous référer à l'exemple présent en marge de droite de cette page.

Pour consulter la liste des pièces de l'utilisateur, veuillez vous référer à ce paragraphe.

Envoi des données au serveur Tiers

Le serveur tiers doit mettre à disposition une url serveur permettant au serveur S-money de le notifier lorsqu'un compte bancaire est enregistré avec le statut "En attente de validation" et lors de la validation ou le refus de la pièce.

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
type	Int	Type de l'opération 10 = Rib
id	Long	ID du compte bancaire
status	Int	2 = En attente de validation
userid	String	Appuserid de l'utilisateur
userstatus	Int	Statut de l'utilisateur 6 = En attente de KYC (virements bloqués)

Exemple de callback envoyé :

POST https://s-money.fr/callback?type=10&id=270978&status=2&userid=623b5620-dca3-5b73-6011-46a8871e94bc&userstatus=6

Requête :
POST /api/[domaine partenaire]/users/appuserid/bankaccounts/id-du-compte-bancaire-en-attente-de-validation/rib/attachments HTTP/1.1
Authorization : Bearer ACCESS_TOKEN
Accept : application/vnd.s-money.v1+json
Content-Type : multipart/form-data ; boundary=-------------------------acebdf13572468
---------------------------acebdf13572468
Content-Disposition : form-data ; name="file1" ; filename="img1.png"
Content-Type : image/png
[FILE CONTENT]
---------------------------acebdf13572468

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

Delete a bank account

Hadassa — 2016-07-04T17:42:54Z

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

Error cases:

HTTP code	Error code	Explication
404	302	Bank account cannot be found

Request :
DELETE /api/[domainePartenaire]/users/appuserid/bankaccounts/id HTTP/1.1
Authorization: Bearer ACCESS_TOKEN

Response :
HTTP/1.1 204 No Content

Edit a bank account

Hadassa — 2016-07-04T17:40:08Z

In order to edit the bank account's name, please have a look at the example in the right margin of this page.

Error cases::

HTTP Code	Code	Explication
404	302	Bank account cannot be found
400	176	Invalid alias of the bank account
400	573	BIC/IBAN update is being validated.
400	551	BIC/IBAN update is not available
400	704	Missing request(s) parameter(s)

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

{
 "id":42,
 "displayname":"compte bancaire"

}

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

{
 "Demands": null,
 "id":42,
 "displayname":"compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx3520962",
 "ismine":true

}

Retrieve a bank account

Hadassa — 2016-07-04T17:23:37Z

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

Error case

HTTP case	Error code	Explication
404	302	Bank account cannot be found

Request :
GET /api/[domainePartenaire]/users/appuserid/bankaccounts/id 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

{
 "Demands": null,
 "id":42,
 "displayname":"compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx3520962",
 "ismine":true,
 "status":1,
 "Holder":
 { 
 "FirstName":"John", 
 "LastName":"Doe"
 }

}

Retrieve the list of bank accounts

Hadassa — 2016-07-04T17:20:48Z

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

Request :
GET /api/[domainePartenaire]/users/appuserid/bankaccounts/ 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

[{
 "Demands": null,
 "id":42,
 "displayname":"compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx3520962",
 "ismine":true,
 "status":1,
 "Holder":
 { 
 "FirstName":"John", 
 "LastName":"Doe"
 }

}, {…}]

Create a bank account (BIC / Iban)

Hadassa — 2016-07-04T17:17:30Z

To create a bank account (BIC / IBAN ), please have a look at the example in the right margin of this page.

Error cases:

HTTP Code	Error code	Explication
400	176	Invalid alias of the bank account
400	179	Incorrect IBAN: IBAN contains invalid characters (different from a-z, A-Z or 0-9)
400	180	Incorrect IBAN: IBAN presents an invalid structure: the first four characters must be structured as follows "letter letter number number"
400	181	Incorrect IBAN: The verification numbers of IBAN are invalid: the allowed values are 00, 01 or 99
400	182	Incorrect IBAN: unknown country code
400	183	IBAN incorrect: the number of characters for the country is incorrect
500	184	Incorrect IBAN
400	185	Incorrect IBAN
400	186	Incorrect BIC: BIC length is invalid
400	187	Incorrect BIC: Format of the BIC bank code is invalid
400	188	Incorrect BIC: Format of the BIC country code is invalid
400	189	Incorrect BIC: Format of the code of the BIC situation is invalid
400	190	Incorrect BIC: Format of the BIC branch code is invalid
400	551	You cannot create more than 3 bank accounts for a single user and per seven days (week)
400	556	Incorrect BIC
400	704	Parameter(s) of the missing request (s)
400	709	Adding a bank account is not allowed
400	1058	BIC and IBAN incoherent

Bank accounts are automatically validated after their creation, except for the sensitive BICs and for the extended professionals. In this case, you must send a RIB to S-money for validation.
Rendez-vous at the section "Send details of a bank account awaiting validation"

Warning : You can save only 3 bank account per week for one user (week to week)

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

{
 "displayname":"compte bancaire",
 "bic":"CMCIFR2A",
 "iban":"FR7610011000201234567890188",
 "ismine":true,
 "Holder":
 { 
 "FirstName":"John", 
 "LastName":"Doe"
 }

}

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

{
 "Demands": null,
 "id":42,
 "displayname":"compte bancaire",
 "bic":"CMxxxx2A",
 "iban":"FR76xxxxxxxxxxxxxxxx7890188",
 "ismine":true,
 "status":1,
 "Holder":
 { 
 "FirstName":"John", 
 "LastName":"Doe"
 }

}

Resources

Hadassa — 2016-07-04T17:01:44Z

Access to a bank account:

Access to bank accounts of the connected user
/api/[domainePartenaire]/users/appuserid/bankaccounts/
Access to a bank account of the connected user
/api/[domainePartenaire]/users/appuserid/bankaccounts/id

1. Bankaccount

Property	Type	Example	Description
Id	Long	12	Bank account identifier
DisplayName	String	"Compte Bancaire"	Bank account name
Bic	String	"CMCIFR2A"	Bank Identifier Code (BIC)
Iban	String	"FRXXXXXXXXXXX XXXXXXXXXXXX"	International Bank Account Number (IBAN)
IsMine	Bool	true	Ownership of the user's bank account
Status	Int	1	Bank account status 1 : Validated 2 : Waiting validation 3 : Refused
Holder	Holder		Object indicating the name and surname of the bank account holder
Demands	Demands		Object detailing the specifics of the request of validation of the bank account (RIB)

2. Holder

Property	Type	Exemple	Description
FirstName	String	"John"	Name of the bank account holder
LastName	String	"Doe"	Surname of the bank account holder. Mandatory if the bank account does not belong to the connected user.

3. Demands

Property	Type	Exemple	Description
Id	Long	125	ID of the request of bank account details
RequestDate	DateTime	2018-01-09T15:55:44	Date of the request
Status	Int	0	Request status: 0 = Incomplete 1 = Ongoing 2 = Denied 3 = Accepted
Reason	String		Reason why the request has been denied
VoucherCopies	List < Attachment >		List of supporting documents