Ressources
La récupération des chargements par prélèvements bancaires se fait via :
/api/[domaine_partenaire]/users/AppUserId/payins/directdebits
OU
/api/[domaine_partenaire]/users/AppUserId/mandates/mandateid/directdebits
1.DirectDebits
Contient les informations d’un chargement par prélèvement bancaire
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| Id | Long | 123 | Id du chargement |
| OrderId | String | xh02 | Identifiant du paiement chez l’application tierce |
| CreationDate | DateTime | 2014-01-10T15:49:58. 791121+02:00 | Date de création du chargement |
| PaymentDate | DateTime | 2014-01-13T00:00:00. 000000+02:00 | Date prévue du chargement (entre 3 et 6 jours ouvrés après la date de création) |
| Amount | Long | 2350 | Montant du chargement (en centimes) |
| Fee | Long | Montant de la commission (la propriété "amount" ne comprend pas le montant de la commission) | |
| Status | Int | 1 | Statut du chargement 0 = En attente 1 = Réalisé 2 = Remboursé 3 = Echoué 4 = En attente de validation 5 = Annulé |
| 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) |
| Message | String | Message du paiement (limité à 140 caractères) | |
| Mandate | MandateRef | Référence du mandat utilisé pour le prélèvement | |
| Schedules | PaymentSchedule | Tableau des échéances (dans le cas des prélèvements avec plusieurs échéances) | |
| Motif | String | echeance-avril | Motif du prélèvement |
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/[domainePartenaire] /accounts/123" | Uri vers le détail du compte |
3.BankAccountRef
Cet objet permet d’identifier le compte bancaire de l’utilisateur
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| Id | Long | 98 | Identifiant du compte bancaire |
| Href | Uri | "/api/[domainePartenaire] /bankaccounts/98" |
Uri vers le détail du compte bancaire |
4.MandateRef
Cet objet permet d’identifier un mandat de prélèvement
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| Id | Long | 45 | Identifiant du mandat |
| Href | Uri | "/api/[domainePartenaire] /mandates/45" |
Uri vers le détail du mandat |