S-money API

Refund a payment

Hadassa — 2016-07-05T16:11:00Z

To refund a payment, 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
400	706	The refund amount exceeds the amount of the original operation

Request :
POST /api/payins/storedcardpayments/orderid/refunds HTTP/1.1
Accept: application/vnd.s-money.v1+json
Content-Type: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "amount": 1020, 
 "orderId": "refund123",
 "refundFee":true

}

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

{
 "id":6,
 "orderId": "refund123"
 "amount":1020,
 "refundedFee":true,
 "status":1,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "originalPayment":{
 "id":5,
 "orderId":"123",
 "href":"/api/payins/storedcardpayments/123" 
 },
 "type":1

}

Retrieve a payment

Hadassa — 2016-07-05T16:05:34Z

To retrieve a payment 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/payins/storedcardpayments/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":21,
 "orderId":"123",
 "accountId":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{
 "appcardid":"card123", 
 "href":"/api/cards/card123"
 },
 "ismine":true,
 "amount":1020,
 "status":1,
 "operationdate":"2013-09-10T15:49:58.791121+02:00",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 }

}

Retrieve the list of payments

Hadassa — 2016-07-05T15:59:32Z

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

Request :
GET /api/payins/storedcardpayments 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":21,
 "orderId":"123",
 "accountId":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{
 "appcardid":"card123", 
 "href":"/api/cards/card123"
 },
 "ismine":true,
 "amount":1020,
 "status":1,
 "operationdate":"2013-09-10T15:49:58.791121+02:00",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 }

}, {…}]

Create a payment with a registered card (one-click)

Hadassa — 2016-07-05T15:47:06Z

In order to create a payment with a registered card, please have a look at the example in the right margin of this page.

Error cases :

HTTP code	Error code	Explication
400	195	Bank card cannot be found
400	111	Your account is incorrect or incomplete
400	500	Your account has been blocked
400	149	Transaction limit has been reached

Request :
POST /api/payins/storedcardpayments HTTP/1.1
Accept: application/vnd.s-money.v1+json
Content-Type: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "orderId":"123", 
 "accountId":{
 "appaccountid":"123"
 },
 "card":{
 "appCardId":"card123"
 },
 "ismine":true,
 "amount":1020, 
 "fee":{
 "amountWithVAT":180,
 "VAT":20
 }

}

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

{
 "id":21,
 "orderId":"123",
 "accountId":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{
 "appcardid":"card123",
 "href":"/api/cards/card123"
 },
 "ismine":true,
 "amount":1020,
 "status":1,
 "operationdate":"2013-09-10T15:49:58.791121+02:00",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 }

}

Resources

Hadassa — 2016-07-05T15:44:53Z

Access to registered card payments:

Access to payments of the connected user
/api/payins/storedcardpayments

Access to payments of a user belonging to the connected third-party application.
/api/users/appUserId/payins/storedcardpayments

1.StoredCardPayment

Contains information about a registered card payment

Property	Type	Example	Description
Id	Long	22	Payment ID
OrderId	String	"123"	Payment identifier in the third-party application
AccountId	SubAccountRef		Precise the sub-account which makes the payment. If not precised, it is the main account which is used.
Card	CardRef		Bank card used
Amount	Long	1020	Payment amount (in cents)
Fee	Fee		Fee
OperationDate	DateTime	2013-09-10T 15:49:58 .791121+02:00	Payment date
IsMine	Bool		True if the account holder is also the holder of the bank card (it applies to an account top-up and not to a payment)
Status	Int	1	Payment status 0 = Waiting 1 = Completed 2 = Refunded 3 = Failed 4 = Waiting for validation 5 = Cancelled 6 = Waiting to be sent

2.CardRef

Contains information about a bank card

Property	Type	Example	Description
AppCardId	String	"card123"	AppCardId of the user's card
Href	Uri		Uri for the details of the bank card

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"	Account display name
Href	Uri	"/api/accounts/123"	Uri for details of the account

4.Fee

The Fee item defines applicable fees

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

Rembourser un paiement

Axel — 2015-07-28T16:27:12Z

Pour rembourser un paiement 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
400	706	Le montant du remboursement dépasse le montant de l'opération originale

Requête :
POST /api/payins/storedcardpayments/orderid/refunds HTTP/1.1
Accept : application/vnd.s-money.v1+json
Content-Type : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

{
 "amount": 1020, 
 "orderId": "refund123",
 "fee":true

}

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

{
 "id":6,
 "orderId": "refund123"
 "amount":1020,
 "refundedFee":true,
 "status":1,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "originalPayment":{
 "id":5,
 "orderId":"123",
 "href":"/api/payins/storedcardpayments/123" 
 },
 "type":1

}

Récupérer un paiement

Axel — 2015-07-28T16:26:42Z

Pour récupérer un paiement effectué avec une carte enregistrée, 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/payins/storedcardpayments/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":21,
 "orderId":"123",
 "accountId":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{
 "appcardid":"card123", 
 "href":"/api/cards/card123"
 },
 "ismine":true,
 "amount":1020,
 "status":1,
 "operationdate":"2013-09-10T15:49:58.791121+02:00",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 }

}

Récupérer la liste des paiements

Axel — 2015-07-28T16:26:15Z

Pour récupérer la liste des paiements effectués avec une carte enregistrée, veuillez vous référer à l'exemple présent en marge de droite de cette page.

Requête :
GET /api/payins/storedcardpayments 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":21,
 "orderId":"123",
 "accountId":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{
 "appcardid":"card123", 
 "href":"/api/cards/card123"
 },
 "ismine":true,
 "amount":1020,
 "status":1,
 "operationdate":"2013-09-10T15:49:58.791121+02:00",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 }

}, {…}]

Créer un paiement avec une carte enregistrée (one-click)

Axel — 2015-07-28T16:22:12Z

Pour créer un paiement avec une carte déjà enregistrée 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	195	Carte bancaire introuvable
400	111	Votre compte est incorrect ou incomplet
400	500	Votre compte est en opposition
400	149	Plafond de transaction atteint

Requête :
POST /api/payins/storedcardpayments HTTP/1.1
Accept : application/vnd.s-money.v1+json
Content-Type : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

{
 "orderId":"123", 
 "accountId":{
 "appaccountid":"123"
 },
 "card":{
 "appCardId":"card123"
 },
 "ismine":true,
 "amount":1020, 
 "fee":{
 "amountWithVAT":180,
 "VAT":20
 }

}

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

{
 "id":21,
 "orderId":"123",
 "accountId":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/accounts/123"
 },
 "card":{
 "appcardid":"card123",
 "href":"/api/cards/card123"
 },
 "ismine":true,
 "amount":1020,
 "status":1,
 "operationdate":"2013-09-10T15:49:58.791121+02:00",
 "fee":{
 "amount":150,
 "VAT":20,
 "amountWithVAT":180,
 "status":1
 }

}

Ressources

Axel — 2015-07-28T16:21:38Z

Accès aux paiements avec carte enregistrée :

Accès aux paiements d'un utilisateur connecté
/api/payins/storedcardpayments

Accès aux paiements d'un utilisateur appartenant à l'application tierce connectée.
/api/users/appUserId/payins/storedcardpayments

1.StoredCardPayment

Contient les informations d'un paiement avec carte enregistrée

Propriété	Type	Exemple	Description
Id	Long	22	Id du paiement
OrderId	String	"123"	Identifiant du paiement chez l'application tierce
AccountId	SubAccountRef		Précise le sous-compte qui effectue le paiement. Si non précisé, c'est le compte principal qui est utilisé.
Card	CardRef		Carte bancaire utilisée
Amount	Long	1020	Montant du paiement (en centimes)
Fee	Fee		Commission
OperationDate	DateTime	2013-09-10T 15:49:58 .791121+02:00	Date du paiement
IsMine	Bool		Vrai si le titulaire du compte est également le titulaire de la carte bancaire (il s'agit d'un chargement du compte et non pas d'un paiement)
Status	Int	1	Statut du paiement 0 = En attente 1 = Réalisé 2 = Remboursé 3 = Échoué 4 = En attente de validation 5 = Annulé 6 = En attente de remise

2.CardRef

Contient les informations d'une carte bancaire

Propriété	Type	Exemple	Description
AppCardId	String	"card123"	AppCardId de la carte à utiliser
Href	Uri		Uri vers le détail de la carte bancaire

3.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

4.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 = Échoué 5 = Annulé