Chargement par virement bancaire

Ressources

- Récupérer les références de virement associées à un utilisateur :
/api/[domaine_partenaire]/users/AppUserId/banktransferreferences
/api/[domaine_partenaire]/users/AppUserId/payins/banktransfers/references

- Récupérer une référence en particulier :
/api/[domaine_partenaire]/users/AppUserId/banktransferreferences/id
/api/[domaine_partenaire]/users/AppUserId/banktransferreferences/reference
/api/[domaine_partenaire]/users/AppUserId/payins/banktransfers/references/id
/api/[domaine_partenaire]/users/AppUserId/payins/banktransfers/references/reference

- Récupérer la liste des chargements par virement d’un utilisateur :
/api/[domaine_partenaire]/users/AppUserId/payins/banktransfers

- Récupérer la liste des chargements par virement d’un utilisateur associés à une référence :
/api/[domaine_partenaire]/users/AppUserId/payins/banktransfers ?reference=reference

- Récupérer un chargement par virement d’un utilisateur :
/api/[domaine_partenaire]/users/AppUserId/payins/banktransfers/id

1.Réferences

Contient les informations d’une référence de virement bancaire

Propriété Type Exemple Description
Id Long 123 Id de la référence
Beneficiary SubAccountRef Objet contenant le détail du sous compte receveur.
Si non précisé, c’est le sous compte principal de l’utilisateur connecté qui est utilisé
IsMine Bool True Vrai si le titulaire du compte est également le titulaire du compte bancaire (il s’agit d’un chargement du compte et non pas d’un paiement)
Reference String "A1B2C3D4E5" Référence à indiquer en libellé lors du virement bancaire
BankAccount BankAccount Informations du compte vers lequel le client doit réaliser son virement

2.BankTransfers

Contient les informations d’un chargement par virement bancaire

Propriété Type Exemple Description
Id Long 123 Id du chargement
PaymentDate DateTime 2013-09-10T15:49:58. 791121+02:00 Date du chargement
Amount Long 2350 Montant du chargement (en centimes)
Status Int 1 Statut du paiement
-1 = inconnu
0 = En attente
1 = Réalisé
2 = remboursé
3 = refusé
4 = en attente de validation
Beneficiary SubAccountRef Objet contenant le détail du sous compte receveur.
Si non précisé, c’est le sous compte principal de l’utilisateur connecté qui est utilisé
IsMine Bool True Vrai si le titulaire du compte est également le titulaire du compte bancaire (il s’agit d’un chargement du compte et non pas d’un paiement)
Reference String "A1B2C3D4E5" Référence à indiquer en libellé lors du virement bancaire
BankAccount BankAccount Informations du compte vers lequel le client doit réaliser son virement

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/[domaine_partenaire] /accounts/123" Uri vers le détail du compte

4. BankAccount

Cet objet précise les références du compte vers lequel effectuer le virement bancaire

Propriété Type Exemple Description
Name String "S-money" Nom du titulaire du compte
Adress Adress Adresse du titulaire du compte
BIC String "XXXXXXX" BIC du compte
IBAN String "FRXX XXXX XXXX XXXX XXXX XXXX XX" IBAN du compte

5. Address

Propriété Type Exemple Description
Street String 2 rue des châtaigniers Numéro et rue
Zipcode String 75001 Code postal
City String Paris Ville
Country String "FR" Nationalité (code ISO 3166-1)
FR = France

Demander une référence de chargement par virement bancaire

Diagramme de Séquence

Envoi des données de la requête de chargement par virement bancaire au serveur S-money

Pour l’envoi des données de la requête de chargement par virement bancaire au serveur S-money veuillez vous référer à l’exemple présent en marge de droite de cette page.

Envoi des données d’un chargement par virement réalisé au serveur Tiers

Le serveur tiers doit mettre à disposition une url serveur permettant au serveur S-money de le notifier du résultat de l’exécution d’un chargement. Attention, plusieurs chargements peuvent arriver avec la même référence.

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
id long Id de l’opération de chargement
reference string Référence de l’opération de virement
error Int Code d’erreur pour les chargements échoués, 0 si aucune erreur.
type Int Type de l’opération
8 = chargement par virement bancaire
status Int Statut de l’opération
-1 = inconnu
0 = En attente
1 = Réalisé
2 = remboursé
3 = refusé
4 = en attente de validation
userid String Identifiant de l’utilisateur chez l’application tierce
userstatus Int Statut de l’utilisateur
0 = Non confirmé
1 = OK
2 = Gelé
3 = A la volée
4 = En cours de fermeture
5 = Fermé

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

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.

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

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.

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

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.

Récupérer un chargement par virement bancaire

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