S-money API

Retrieve history of a sub-account

Hadassa — 2016-07-04T18:18:31Z

In order to retrieve history of a sub-account, please have a look at the example in the right margin of this page.

Property	Type	Description	Default value
page	Int	Page number (starts with 1)	1
per_page	Int	Number of items per page	50
DateStart	DateTime	"2013-09-29T17:04:05"	Statement start date
DateEnd	DateTime	"2013-10-29T17:04:05"	Statement end date

Request :
GET /api/users/appuserid/subaccounts/appAccountId/historyitems?datestart=2013-09-30T00:00:00&dateend=2015-10-31T00:00:00 HTTP/1.1
Accept: application/vnd.s-money.v1+json
ou Accept: application/pdf
Authorization: Bearer ACCESS_TOKEN

Response :
HTTP/1.1 200 OK
Content-Type: application/ vnd.s-money.v1+json
Link: /api/subaccounts/appAccountId/historyitems?page=2&per_page=50; rel="next",
/api/subaccounts/appAccountId/historyitems?page=4&per_page=50; rel="last"
Total-count: 226

[{
 "id":24,
 "account":{
 "displayname":"envoyeur",
 "identifier":"identifiant-envoyeur"
 },
 "operationdate":"2013-09-29T17:04:05",
 "label":"Dîner au restaurant",
 "amount":5000,
 "direction":2,
 "isnew":false,
 "status":5,
 "type":0,
 "beneficiary":{
 "displayname":" beneficiaire",
 "identifier":"identifiant-beneficiaire"
 },
 "sender":{
 "displayname":"envoyeur",
 "identifier":"identifiant-envoyeur"
 }
 }, 

{…}]

Retrieve user's history

Hadassa — 2016-07-04T18:14:48Z

To retrieve user's history, please have a look at the example in the right margin of this page.

Property	Type	Description	Default value
page	Int	Page number (starts with 1)	1
perpage	Int	Number of items per page	50
DateStart	DateTime	"2013-09-30T00:00:00"	Statement start date
DateEnd	DateTime	"2013-10-31T00:00:00"	Statement end date

Request :
GET /api/historyitems 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: /api/historyitems?page=2&perpage=50; rel="next",
/api/historyitems?page=5&perpage=50; rel="last"
Total-count: 253

[{
 "id" : 26,
 "account" : {
 "displayname" : "envoyeur",
 "identifier" : "identifiant-envoyeur"
 },
 "operationdate" : "2013-09-29T17:04:05",
 "label" : "Remboursement",
 "amount" : 5180,
 "direction" : 1,
 "isnew" : false,
 "status" : 1,
 "type" : 7,
 "refundedoperation" : {
 "id" : 24,
 "type" : 0,
 "href" : "/api/historyitems/24"
 }
 }, 

{
 "id" : 24,
 "account" : {
 "displayname" : "envoyeur",
 "identifier" : "identifiant-envoyeur"
 },
 "operationdate" : "2013-09-29T17:04:05",
 "label" : "Dîner au restaurant",
 "amount" : 5000,
 "direction" : 2,
 "isnew" : false,
 "status" : 5,
 "type" : 0,
 "beneficiary" : {
 "displayname" : " beneficiaire",
 "identifier" : "identifiant-beneficiaire"
 },
 "sender" : {
 "displayname" : "envoyeur",
 "identifier" : "identifiant-envoyeur"
 },
 }, 

{…}]

Resources

Hadassa — 2016-07-04T18:06:40Z

History can be accessed through:

Access to history of a connected user
/api/(domainePartenaire)/historyitems/
Access to history of a sub-account of a connected user
/api/(domainePartenaire)/subaccounts/appAccountId/historyitems/

Access to history of a user belonging to the connected third-party application
/api/(domainePartenaire)/users/appUserId/historyitems/
Access to history of a sub-account of a user belonging to the connected third-party application.
/api/(domainePartenaire)/users/appUserId/subaccounts/appAccountId/historyitems/

1. HistoryItem
History item is an item allows retrieving all money transactions associated to an account of a selected user .

Property	Type	Example	Description
Id	Long	18	Operation identifier
Account	AccountIdentifier		Account used to perform the operation
OperationDate	DateTime	"2013-09-10T 15:50:37.2363199 +02:00"	Operation date
Amount	Long	1250	Operation amount (without fee)
Label	String	"Dinner at a restaurant"	Description associated with the operation
Attachment	Attachment		Attachment details
IsNew	Bool	false	The item is new
Type	Int	0	Operation type 0 = Money transfer 1 = Top-up by CB 2 = Bank transfer to BIC/IBAN 3 = e-commerce payment 4 = e-commerce card payment 5 = Vending machine payment 6 = Fee 7 = Refund 8 = Regulation operation 9 = Top-up by bank transfer 10 = Top-up by transfer
Direction	Int	1	Precise if it is an incoming or outcoming operation 0 = None 1 = In 2 = Out
Status	Int	1	Operation status 0 = Pending 1 = Succeeded 2 = Cancelled 3 = Failed 4 = Expired 5 = Refunded
OrderId	String	Order123	Operation reference in the third-party application

2.Payment: HistoryItem

Property	Type	Description
Sender	AccountIdentifier	Payment sender
Receiver	AccountIdentifier	Payment receiver
ChatMessages	List>	List of chat messages associated with the operation
PaymentRequest	PaymentRequest	Money request associated with the payment

3. MoneyIn : HistoryItem

Property	Type	Example	Description
AccountLabel	string	"Bank card"	Bank account description

4. MoneyOut : HistoryItem

Property	Type	Example	Description
AccountLabel	string	"Bank account"	Bank account description

5. VendingMachinePayment: HistoryItem

Property	Type	Example	Description
MerchantTransactionId	String	"1245XJK1"	Identifier of the vending machine transaction
Product	String	"Coffee"	Purchased product label
MerchantName	String	"Vending machine"	Supplier commercial name

6.EcommercePayment: HistoryItem

Property	Type	Example	Description
MerchantTransactionId	String	"12345XJK1"	Identifier of the e-commerce transaction
MerchantName	String	"Marchand"	E-commerce merchant name
MerchantImageUrl	String	"http://marchand.fr/img.png"	Merchant picture Url

7. Refund : HistoryItem

Property	Type	Example	Description
RefundedOperation	HistoryItemReference		Reference to the refunded operation

8. HistoryItemReference

Property	Type	Example	Description
Id	Long	12	Operation ID
Type	Int	0	Operation type
href	Url	/api/historyitems/12	Link to operation details

9. ChatMessage

Property	Type	Example	Description
Message	String	"Thank you!"	Chat message
Sender	AccountIdentifier		Message sender
Date	DateTime	"2013-09-29T17:04:05"	Date the message was sent

10. Attachment

Property	Type	Example	Description
Id	Long	23	Attachment ID
Name	String	"Facture"	Attachment name
ContentType	String	"image/png"	Attachment content type
Size	Int	233450	Attachment size in bytes
Href	Url	/api/attachments/23	Link to the attachment

Récupérer l'historique d'un sous-compte

Axel — 2015-07-28T15:16:01Z

Pour récupérer l'historique d'un sous-compte veuillez vous référer à l'exemple présent en marge de droite de cette page.

Propriété	Type	Description	Valeur par défaut
page	Int	Numéro de la page (commence à 1)	1
perpage	Int	Nombre d'objets par page	50
DateStart	DateTime	"2013-09-29T17:04:05"	Date de début du relevé
DateEnd	DateTime	"2013-10-29T17:04:05"	Date de fin du relevé

Requête :
GET /api/users/appuserid/subaccounts/appAccountId/historyitems
datestart=2013-09-30T00:00:00&dateend=2015-10-31T00:00:00 HTTP/1.1
Accept : application/vnd.s-money.v1+json
ou Accept : application/pdf
Authorization : Bearer ACCESS_TOKEN

Réponse :
HTTP/1.1 200 OK
Content-Type : application/ vnd.s-money.v1+json
Link : /api/subaccounts/appAccountId/historyitems ?page=2&perpage=50 ; rel="next",
/api/subaccounts/appAccountId/historyitems ?page=4&perpage=50 ; rel="last"
Total-count : 226

[{
 "id":24,
 "account":{
 "displayname":"envoyeur",
 "identifier":"identifiant-envoyeur"
 },
 "operationdate":"2013-09-29T17:04:05",
 "label":"Dîner au restaurant",
 "amount":5000,
 "direction":2,
 "isnew":false,
 "status":5,
 "type":0,
 "beneficiary":{
 "displayname":" beneficiaire",
 "identifier":"identifiant-beneficiaire"
 },
 "sender":{
 "displayname":"envoyeur",
 "identifier":"identifiant-envoyeur"
 }
 }, 

{…}]

Récupérer l'historique d'un utilisateur

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

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

Propriété	Type	Description	Valeur par défaut
page	Int	Numéro de la page (commence à 1)	1
perpage	Int	Nombre d'objets par page	50
DateStart	DateTime	"2013-09-30T00:00:00"	Date de début de relevé
DateEnd	DateTime	"2013-10-31T00:00:00"	Date de fin de relevé

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
404	513	Sous-compte introuvable
400	825	L'intervalle de temps passé en paramètre ne peut pas être supérieur à 31 jours

Requête :
GET /api/historyitems 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
Link : /api/historyitems ?page=2&perpage=50 ; rel="next",
/api/historyitems ?page=5&perpage=50 ; rel="last"
Total-count : 253

[{
 "id" : 26,
 "account" : {
 "displayname" : "envoyeur",
 "identifier" : "identifiant-envoyeur"
 },
 "operationdate" : "2013-09-29T17:04:05",
 "label" : "Remboursement",
 "amount" : 5180,
 "direction" : 1,
 "isnew" : false,
 "status" : 1,
 "type" : 7,
 "refundedoperation" : {
 "id" : 24,
 "type" : 0,
 "href" : "/api/historyitems/24"
 }
 }, 

{
 "id" : 24,
 "account" : {
 "displayname" : "envoyeur",
 "identifier" : "identifiant-envoyeur"
 },
 "operationdate" : "2013-09-29T17:04:05",
 "label" : "Dîner au restaurant",
 "amount" : 5000,
 "direction" : 2,
 "isnew" : false,
 "status" : 5,
 "type" : 0,
 "beneficiary" : {
 "displayname" : " beneficiaire",
 "identifier" : "identifiant-beneficiaire"
 },
 "sender" : {
 "displayname" : "envoyeur",
 "identifier" : "identifiant-envoyeur"
 },
 }, 

{…}]

Ressources

Axel — 2015-07-28T15:14:28Z

L'accès à l'historique peut se faire via :

Accès à l'historique d'un utilisateur connecté
/api/(domainePartenaire)/historyitems/
Accès à l'historique d'un sous-compte d'un utilisateur connecté
/api/(domainePartenaire)/subaccounts/appAccountId/historyitems/

Accès à l'historique d'un utilisateur appartenant à l'application tierce connectée
/api/(domainePartenaire)/users/appUserId/historyitems/
Accès à l'historique d'un sous-compte d'un utilisateur appartenant à l'application tierce connectée.
/api/(domainePartenaire)/users/appUserId/subaccounts/appAccountId/historyitems/

1. HistoryItem
L'objet historique est un objet permettant de récupérer l'ensemble des mouvements d'argent associés au compte du user sélectionné.

Propriété	Type	Exemple	Description
Id	Long	18	Identifiant de l'opération
Account	AccountIdentifier		Compte utilisé pour effectuer l'opération
OperationDate	DateTime	"2013-09-10T 15:50:37.2363199 +02:00"	Date de l'opération
Amount	Long	1250	Montant de l'opération (hors commission)
Label	String	"Dîner au restaurant"	Libellé associé à l'opération
Attachment	Attachment		Informations de la pièce jointe
IsNew	Bool	false	L'élément est nouveau
Type	Int	0	Type de l'opération 0 = Transfert d'argent 1 = Chargement par CB 2 = Virement vers un BIC/IBAN 3 = Paiement e-commerce 4 = Paiement e-commerce carte 5 = Paiement distributeur 6 = Commission 7 = Remboursement 8 = Opération de régulation 9 = Chargement par virement 10 = Chargement par prélèvement
Direction	Int	1	Précise si c'est une opération entrante ou sortante 0 = None 1 = In 2 = Out
Status	Int	1	Statut de l'opération 0 = Pending 1 = Succeeded 2 = Cancelled 3 = Failed 4 = Expired 5 = Refunded
OrderId	String	Order123	Référence de l'opération chez l'application tierce

2.Payment : HistoryItem

Propriété	Type	Description
Sender	AccountIdentifier	Émetteur du paiement
Receiver	AccountIdentifier	Receveur du paiement
ChatMessages	List>	Liste des messages de chat associés à l'opération
PaymentRequest	PaymentRequest	Demande d'argent associée au paiement