V1

Ressources

Pour créer ou récupérer les références de virement associées à un utilisateur :

/api/[domaine_partenaire]/users/AppUserId/chequereferences
/api/[domaine_partenaire]/users/AppUserId/payins/cheques/references

Pour récupérer une référence en particulier :

/api/[domaine_partenaire]/users/AppUserId/chequereferences/id
/api/[domaine_partenaire]/users/AppUserId/chequereferences/reference
/api/[domaine_partenaire]/users/AppUserId/payins/cheques/references/id
/api/[domaine_partenaire]/users/AppUserId/payins/cheques/references/reference

Pour récupérer la liste des chargements par virement d’un utilisateur :

/api/[domaine_partenaire]/users/AppUserId/payins/cheques

Pour récupérer la liste des chargements par virement d’un utilisateur associés à une référence :

/api/[domaine_partenaire]/users/AppUserId/payins/cheques ?reference=reference

Pour récupérer un chargement par virement d’un utilisateur :

/api/[domaine_partenaire]/users/AppUserId/payins/cheques/id

2.1 Références

Contient les informations d’une référence de chèque

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 chèque
BankAccount BankAccount Informations du compte vers lequel le client doit réaliser son virement

2.2 Chèques

Contient les informations d’un chargement par chèque

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
0 = En attente
1 = Réalisé
2 = Remboursé
3 = Echec
4 = En attente de validation
5 = Annulé
6 = En attente de remise
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 chèque
Address Address Informations du compte vers lequel le client doit réaliser son virement

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

2.4 ADDRESS

Propriété Type Exemple Description
Name String S-money - service encaissement des chèques de la plateforme xxx Nom + service à communiquer au client pour l’envoi du chèque
Street String 2 rue des chataîgners Numéro et rue
Zipcode String 75001 Code postal
City String Paris Ville
Country String "FR" Pays (code ISO 3166-1)