S-money API

Retrieve a bank transfer top-up

Hadassa — 2016-07-05T18:15:21Z

To retrieve a bank transfer top-up, please have a look at the example in the right margin of this page.

Error cases:

HTTP code	Error code	Explication
404	356	Operation cannot be found

Request :
GET
/api/[domaine_partenaire]/users/appuserid/payins/banktransfers
/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

{
 "id":5, 
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "amount":1000,
 "status":1,
 "ismine":true,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "reference":"A1B2C3D4E5",
 "BankAccount":{
 "Name": "S-money",
 "address": {
 "street":"110 avenue de France",
 "zipcode":"75013",
 "city":"Paris",
 "country":"FR" 
 },
 "BIC": "XXXXXX",
 "IBAN": "FRXX XXXX XXXX XXXX XXXX XXXX XX"
 }

}

Retrieve the list of bank transfer top-ups

Hadassa — 2016-07-05T18:12:28Z

To retrieve the list of bank transfer top-ups, please have a look at the example in the right margin of this page.

Request :
GET
/api/[domaine_partenaire]/users/appuserid/payins
/banktransfers HTTP/1.1
Ou
/api/[domaine_partenaire]/users/appuserid/payins
/banktransfers?reference=reference
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":5, 
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "amount": 1000, 
 "status":1,
 "ismine":true,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "reference":"A1B2C3D4E5",
 "BankAccount":{
 "Name": "S-money",
 "address": {
 "street":"110 avenue de France",
 "zipcode":"75013",
 "city":"Paris",
 "country":"FR" 
 },
 "BIC": "XXXXXX",
 "IBAN": "FRXX XXXX XXXX XXXX XXXX XXXX XX"
 }

}, {…}]

Retrieve a reference of a bank transfer top-up

Hadassa — 2016-07-05T18:09:42Z

To retrieve a reference of a bank transfer top-p, please have a look at the example in the right margin of this page.

Error cases

HTTP code	Error code	Explication
404	822	This transfer reference does not exist

Request :
GET
/api/[domaine_partenaire]/users/appuserid/
banktransferreferences/id HTTP/1.1
Ou
/api/[domaine_partenaire]/users/appuserid/
banktransferreferences/reference
Ou
/api/[domaine_partenaire]/users/appuserid/payins/
banktransfers/references/id
Ou /api/[domaine_partenaire]/users/appuserid/payins/
banktransfers/references/reference
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":5, 
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "ismine":true,
 "reference":"A1B2C3D4E5",
 "BankAccount":{
 "Name": "S-money",
 "address": {
 "street":"110 avenue de France",
 "zipcode":"75013",
 "city":"Paris",
 "country":"FR" 
 },
 "BIC": "XXXXXX",
 "IBAN": "FRXX XXXX XXXX XXXX XXXX XXXX XX"
 }

}

Retrieve the list of the references of bank transfer top-ups

Hadassa — 2016-07-05T18:02:56Z

To retrieve the list of the references of bank transfer top-ups, please have a look at the example in the right margin of this page.

Request :
GET
/api/[domaine_partenaire]/users/appuserid
/banktransferreferences
Ou
/api/[domaine_partenaire]/users/appuserid/payins/
banktransfers/references 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":5, 
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "ismine":true,
 "reference":"A1B2C3D4E5",
 "BankAccount":{
 "Name": "S-money",
 "address": {
 "street":"110 avenue de France",
 "zipcode":"75013",
 "city":"Paris",
 "country":"FR" 
 },
 "BIC": "XXXXXX",
 "IBAN": "FRXX XXXX XXXX XXXX XXXX XXXX XX"
 }

}, {…}]

Request a reference of a bank transfer top-up

Hadassa — 2016-07-05T17:58:40Z

Sequence diagram

Send the data of the bank transfer top-up request to the S-money server.

To send the data of the bank transfer top-up request, please have a look at the example in the right margin of this page.

Send the data of the completed transfer top-up to the third-party server

The third party server should provide the S-money server with a url, so that the latter can communicate the result of the top-up execution. Note that more top-ups can come with the same reference. .

The HTTP POST method is used to invoke the S-money server.

The parameters of the HTTP request are:

Parameter	Type	Description
id	long	Top-up operation ID
reference	string	Transfer operation ID
error	Int	Error code for failed payments, 0, if no errors.
type	Int	Operation type 8 = bank transfer top-up
status	Int	Operation status -1 = unknown 0 = waiting 1 = Realised 2 = refunded 3 = refused 4 = waiting for validation
userid	String	User identifier in the third-party application
userstatus	Int	User status 0 = Not confirmed 1 = OK 2 = Frozen 3 = On the fly 4 = Being closed 5 = Closed

Request :
POST
/api/[domaine_partenaire]/users/appuserid
/banktransferreferences
Ou
/api/[domaine_partenaire]/users/appuserid
/payins/banktransfers/references HTTP/1.1
Accept: application/vnd.s-money.v1+json
Content-Type: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "beneficiary":{
 "appaccountid": "123" 
 },
 "ismine": true

}

Response :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v1+json
Location: /api/[domaine_partenaire]/payins/banktransfers/id

{
 "id":5, 
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "ismine":true,
 "reference":"A1B2C3D4E5",
 "BankAccount":{
 "Name": "S-money",
 "address": {
 "street":"110 avenue de France",
 "zipcode":"75013",
 "city":"Paris",
 "country":"FR" 
 },
 "BIC": "XXXXXX",
 "IBAN": "FRXX XXXX XXXX XXXX XXXX XXXX XX"
 }

}

Resources

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

Retrieve the references of the transfer associated to a user:
/api/[partner_domain]/users/AppUserId/banktransferreferences
/api/[partner_domain]/users/AppUserId/payins/banktransfers/references

Retrieve one particular reference:
/api/[partner_domain]/users/AppUserId/banktransferreferences/id
/api/[partner_domain]/users/AppUserId/banktransferreferences/reference
/api/[partner_domain]/users/AppUserId/payins/banktransfers/references/id
/api/[partner_domain]/users/AppUserId/payins/banktransfers/references/reference

Retrieve the list of top-ups by user's transfers:
/api/[partner_domain]/users/AppUserId/payins/banktransfers

Retrieve the list of top-ups through a transfer made by a user associated to one reference:
/api/[partner_domain]/users/AppUserId/payins/banktransfers?reference=reference

Retrieve a top-up by user's transfer:
/api/[partner_domain]/users/AppUserId/payins/banktransfers/id

1.References

It contains the informations of a money transfer reference.

Property	Type	Example	Description
Id	Long	123	Reference Id
Beneficiary	SubAccountRef		Item containg the details of the receiver sub-account. If not precised, it is the main sub-account of the connected user, which is used.
IsMine	Bool	True	True, if the account holder is also the bank account holder (it applies to an account top-up and not a payment)
Reference	String	"A1B2C3D4E5"	Bank transfer reference to be indicated
BankAccount	BankAccount		Details of the account into which the client should make his/her transfer

2.BankTransfers

Contains information about a bank transfer top-up

Property	Type	Example	Description
Id	Long	123	Top-up Id
PaymentDate	DateTime	2013-09-10T15:49:58. 791121+02:00	Top-up date
Amount	Long	2350	Top-up amount (in cents )
Status	Int	1	Payment status -1 = unknow 0 = Waiting 1 = Realised 2 = Refunded 3 = Refused 4 = Waiting for validation
Beneficiary	SubAccountRef		Item containg the details of the receiver sub-account If not precised, it is the main sub-account of the connected user, which is used
IsMine	Bool	True	True, if the account holder is also the holder of the bank account (it applies to an account top-up and not to a payment)
Reference	String	"A1B2C3D4E5"	Reference to be indicated during a bank transfer
BankAccount	BankAccount		Details of the account into which the client should make his/her transfer

3. SubaccountRef

This item allows to identify the accounts between which the operations 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"	Display account name
Href	Uri	"/api/[partner_domain] /accounts/123"	Uri for the account details

4. BankAccount

This item refers to the references of the account to which the bank transfer needs to be made.

Property	Type	Example	Description
Name	String	"S-money"	Name of the account holder
Address	Address		Address of the account holder
BIC	String	"XXXXXXX"	Account BIC
IBAN	String	"FRXX XXXX XXXX XXXX XXXX XXXX XX"	Account IBAN

5. Address

Propriété	Type	Exemple	Description
Street	String	2 rue des châtaigniers	Number and street
Zipcode	String	75001	Postcode
City	String	Paris	City
Country	String	"FR"	Nationality (ISO 3166-1 code) FR = France

Récupérer un chargement par virement bancaire

Axel — 2015-07-28T17:04:19Z

Pour récupérer un chargement par virement bancaire veuillez vous référer à l'exemple présent en marge de droite de cette page.

Cas d'erreurs :

Code HTTP	Code erreur	Explication
404	356	Opération introuvable

Requête :
GET
/api/[domaine_partenaire]/users/appuserid/payins/banktransfers
/id 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":5, 
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "amount":1000,
 "status":1,
 "ismine":true,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "reference":"A1B2C3D4E5",
 "BankAccount":{
 "Name": "S-money",
 "address": {
 "street":"110 avenue de France",
 "zipcode":"75013",
 "city":"Paris",
 "country":"FR" 
 },
 "BIC": "XXXXXX",
 "IBAN": "FRXX XXXX XXXX XXXX XXXX XXXX XX"
 }

}

Récupérer la liste des chargements par virements bancaires

Axel — 2015-07-28T17:03:34Z

Pour récupérer la liste des chargements par virements bancaires veuillez vous référer à l'exemple présent en marge de droite de cette page.

Requête :
GET
/api/[domaine_partenaire]/users/appuserid/payins
/banktransfers HTTP/1.1
Ou
/api/[domaine_partenaire]/users/appuserid/payins
/banktransfers ?reference=reference
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":5, 
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "amount": 1000, 
 "status":1,
 "ismine":true,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "reference":"A1B2C3D4E5",
 "BankAccount":{
 "Name": "S-money",
 "address": {
 "street":"110 avenue de France",
 "zipcode":"75013",
 "city":"Paris",
 "country":"FR" 
 },
 "BIC": "XXXXXX",
 "IBAN": "FRXX XXXX XXXX XXXX XXXX XXXX XX"
 }

}, {…}]

Récupérer une référence de chargement par virement bancaire

Axel — 2015-07-28T17:02:49Z

Pour récupérer une référence de chargement par virement bancaire veuillez vous référer à l'exemple présent en marge de droite de cette page.

Cas d'erreurs :

Code HTTP	Code erreur	Explication
404	822	Cette référence de virement n'existe pas.

Requête :
GET
/api/[domaine_partenaire]/users/appuserid/
banktransferreferences/id HTTP/1.1
Ou
/api/[domaine_partenaire]/users/appuserid/
banktransferreferences/reference
Ou
/api/[domaine_partenaire]/users/appuserid/payins/
banktransfers/references/id
Ou /api/[domaine_partenaire]/users/appuserid/payins/
banktransfers/references/reference
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":5, 
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "ismine":true,
 "reference":"A1B2C3D4E5",
 "BankAccount":{
 "Name": "S-money",
 "address": {
 "street":"110 avenue de France",
 "zipcode":"75013",
 "city":"Paris",
 "country":"FR" 
 },
 "BIC": "XXXXXX",
 "IBAN": "FRXX XXXX XXXX XXXX XXXX XXXX XX"
 }

}

Récupérer la liste des références de chargement par virements bancaires

Axel — 2015-07-28T17:02:18Z

Pour récupérer la liste des références de chargement par virements bancaires veuillez vous référer à l'exemple présent en marge de droite de cette page.

Requête :
GET
/api/[domaine_partenaire]/users/appuserid
/banktransferreferences
Ou
/api/[domaine_partenaire]/users/appuserid/payins/
banktransfers/references 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":5, 
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "ismine":true,
 "reference":"A1B2C3D4E5",
 "BankAccount":{
 "Name": "S-money",
 "address": {
 "street":"110 avenue de France",
 "zipcode":"75013",
 "city":"Paris",
 "country":"FR" 
 },
 "BIC": "XXXXXX",
 "IBAN": "FRXX XXXX XXXX XXXX XXXX XXXX XX"
 }

}, {…}]