S-money API

Retrieve a money transfer

Hadassa — 2016-07-05T11:30:16Z

In order to retrieve the list of remittances, please have a look at the example in the right corner of this page.

Error cases:

HTTP code	Error code	Explication
401	362	Operation not allowed
401	569	Token OAuth expired
401	570	Token OAuth invalid
404	356	Operation cannot be found

Request :
GET /api/(domainePartenaire)/payments/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

{
 "id" : 18,
 "orderid" : "order_001",
 "beneficiary" : {
 "id" : 87,
 "appaccountid" : "123",
 "displayname" : "Jean Dupont",
 "href" : "/api/accounts/123"
 },
 "sender" : {
 "id" : 98,
 "appaccountid" : "45",
 "displayname" : "Sous compte",
 "href" : "/api/accounts/45"
 },
 "amount" : 1250,
 "message" : "déjeuner au restaurant",
 "fee" : {
 "amount" : 150,
 "VAT" : 20,
 "amountWithVAT" : 180,
 "status" : 1
 },
 "paymentdate" : "2013-09-10T15:49:58.791121+02:00"

}

Retrieve the list of money transfers

Hadassa — 2016-07-05T11:27:17Z

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

Error cases :

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

Request :
GET /api/(domainePartenaire)/payments/ 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":18,
 "orderid" : "order_001"
 "beneficiary":
 {
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "sender":{
 "id":98,
 "appaccountid":"45",
 "displayname":"Sous compte",
 "href":"/api/accounts/45"
 },
 "amount":1250,
 "message":"déjeuner au restaurant",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 },
 "paymentdate":"2013-09-10T15:49:58.791121+02:00"
 

}, {…}]

Send money

Hadassa — 2016-07-05T11:25:18Z

To send money, please have a look at the example in the right margin of this page.

Error cases:

HTTP Code	Error code	Explication
401	362	Operation not allowed
401	569	Token OAuth expired
401	570	Token OAuth invalid
400	704	Missing request parameter
400	177	Invalid request parameter
404	147	Account cannot found
400	500	The sender account is blocked
400	111	Sender status is invalid
400	127	The sender and the recipient cannot have be the same account
400	345	Recipient account is incorrect or incomplete
400	110	Insufficient balance to make the operation
400	701	Transaction limit has been reached (client unbanked)
400	702	Transaction limit has been reached (KYC client)
400	703	Transaction limit has been reached (no KYC client)
400	177	Parameter value is invalid (orderId already exists)
400	177	Invalid parameter value (All the orderId parameters should be unique)

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

{
 "orderid":"1234568",
 "beneficiary": {
 "appaccountid":"123" 
 },
 "sender":{
 "appaccountid":"45"
 },
 "amount":1250,
 "message":"déjeuner au restaurant",
 "fee":{ 
 "amountWithVAT":180,
 "VAT":20
 }

}

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

{
 "id":18,
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "sender":{
 "id":98,
 "appaccountid":"45",
 "displayname":"Sous compte",
 "href":"/api/accounts/45"
 },
 "amount":1250,
 "message":"déjeuner au restaurant",
 "orderid" : "1234568",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 },
 "paymentdate":"2013-09-10T15:49:58.791121+02:00"

}

Resources

Hadassa — 2016-07-05T11:19:16Z

Access to remittances:

Access to payments of the connected user
/api/(partner_domain)/payments/

Access to payments of the user belonging to the connected third-party application
/api/(partner_domain)/users/appuserid/payments/

1.Payment
Send money item is an item which allows to send money between two accounts (or sub-account).

Property	Type	Example	Description
OrderId	String	“order_001”	Money transfer identifier in the third-party application
Id	Long	18	Money transfer identifier
PaymentDate	DateTime	"2013-09-10T 15:50:37.2363199 +02:00"	Payment date
Amount	Long	1250	Payment amount (in cents)
Fee	Fee		Item containing a fee
Status	Int	1	Payment status 0 = Waiting 1 = Refund 2 = Expired 3 = Completed 4 = Error
Beneficiary	SubAccountRef		Item containing recipient details
Message	String	"Breakfast"	Money transfer message
Sender	SubAccountRef		Item containing sender details If not indicated, it is a connected user default account which is used

2.SubAccountRef
This item allows to identify the accounts between which the transactions are made.

Property	Type	Example	Description
Id	Long	98	Account identifier
AppAccountId	String	"123"	Account identifier provided by the third-party application
DisplayName	String	"Jean Dupont"	Account display name
Href	Uri	"/api/accounts/123"	Uri for account details

3.Fee
The Fee item defines the applicable fees.

Property	Type	Example	Description
Amount	long	150	Fee amount in cents (VAT not included)
VAT	double	20	Fee percentage
AmountWithVAT	long	180	Fee amount in cents (VAT included)
Status	Int	1	Fee status 0 = Waiting 1 = Completed 2 = Refunded 3 = Failed 5 = Cancelled

Récupérer un transfert d'argent

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

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

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	356	Opération introuvable

Requête :
GET /api/(domainePartenaire)/payments/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" : 18,
 "orderid" : "order_001",
 "beneficiary" : {
 "id" : 87,
 "appaccountid" : "123",
 "displayname" : "Jean Dupont",
 "href" : "/api/accounts/123"
 },
 "sender" : {
 "id" : 98,
 "appaccountid" : "45",
 "displayname" : "Sous compte",
 "href" : "/api/accounts/45"
 },
 "amount" : 1250,
 "message" : "déjeuner au restaurant",
 "fee" : {
 "amount" : 150,
 "VAT" : 20,
 "amountWithVAT" : 180,
 "status" : 1
 },
 "paymentdate" : "2013-09-10T15:49:58.791121+02:00"

}

Récupérer la liste des transferts d'argent

Axel — 2015-07-28T15:38:36Z

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

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

Requête :
GET /api/(domainePartenaire)/payments/ 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":18,
 "orderid" : "order_001"
 "beneficiary":
 {
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "sender":{
 "id":98,
 "appaccountid":"45",
 "displayname":"Sous compte",
 "href":"/api/accounts/45"
 },
 "amount":1250,
 "message":"déjeuner au restaurant",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 },
 "paymentdate":"2013-09-10T15:49:58.791121+02:00"
 

}, {…}]

Créer un transfert d'argent

Axel — 2015-07-28T15:38:02Z

Pour créer un envoi d'argent veuillez vous référer à l'exemple présent en marge de droite de cette page.

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	Compte introuvable
400	500	Le compte de l'envoyeur est en opposition
400	111	Statut de l'envoyeur invalide
400	127	L'envoyeur et le bénéficiaire ne peuvent pas être le même compte
400	345	Compte du bénéficiaire incorrect ou incomplet
400	110	Solde insuffisant pour effectuer l'opération
400	701	Plafond de transaction atteint (client non bancarisé)
400	702	Plafond de transaction atteint (client KYC)
400	703	Plafond de transaction atteint (client non KYC)
400	177	Valeur de paramètre invalide (orderId déjà existant)
400	177	Valeur de paramètre invalide (Tous les paramètres orderId doivent être uniques)

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

{
 "orderid":"1234568",
 "beneficiary": {
 "appaccountid":"123" 
 },
 "sender":{
 "appaccountid":"45"
 },
 "amount":1250,
 "message":"déjeuner au restaurant",
 "fee":{ 
 "amountWithVAT":180,
 "VAT":20
 }

}

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

{
 "id":18,
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "sender":{
 "id":98,
 "appaccountid":"45",
 "displayname":"Sous compte",
 "href":"/api/accounts/45"
 },
 "amount":1250,
 "message":"déjeuner au restaurant",
 "orderid" : "1234568",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 },
 "paymentdate":"2013-09-10T15:49:58.791121+02:00"

}

Ressources

Axel — 2015-07-28T15:37:38Z

Accès aux envois d'argent :

Accès aux paiements de l'utilisateur connecté
/api/(domainePartenaire)/payments/

Accès aux paiements d'un utilisateur appartenant à l'application tierce connectée
/api/(domainePartenaire)/users/appuserid/payments/

1.Payment
L'objet envoi d'argent est un objet permettant d'envoyer de l'argent entre deux comptes (ou sous compte).

Propriété	Type	Exemple	Description
OrderId	String	“order_001”	Identifiant de l'envoi d'argent chez l'application tierce
Id	Long	18	Identifiant de l'envoi d'argent
PaymentDate	DateTime	"2013-09-10T 15:50:37.2363199 +02:00"	Date du paiement
Amount	Long	1250	Montant du paiement (en centimes)
Fee	Fee		Objet contenant la commission
Status	Int	1	Statut du paiement 0 = En attente 1 = Remboursé 2 = Expiré 3 = Validé 4 = Erreur
Beneficiary	SubAccountRef		Objet contenant le détail du receveur
Message	String	"Déjeuner au restaurant"	Message de l'envoi d'argent
Sender	SubAccountRef		Objet contenant le détail de l'envoyeur. Si non précisé, c'est le sous-compte principal de l'utilisateur connecté qui est utilisé

2.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	Uri	"/api/accounts/123"	Uri vers le détail du compte

3.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	20	Pourcentage de la commission (en pourcentage)
AmountWithVAT	long	180	Montant TTC de la commission (en centimes)
Status	Int	1	Statut de la commission 0 = En attente 1 = Réalisé 2 = Remboursé 3 = Echoué 5 = Annulé