Ressources
L’accès à l’historique peut se faire via :
Accès à l’historique d’un utilisateur connecté
/api/(domainePartenaire)/historyitems/
Accès à l’historique d’un sous-compte d’un utilisateur connecté
/api/(domainePartenaire)/subaccounts/appAccountId/historyitems/
OU
Accès à l’historique d’un utilisateur appartenant à l’application tierce connectée
/api/(domainePartenaire)/users/appUserId/historyitems/
Accès à l’historique d’un sous-compte d’un utilisateur appartenant à l’application tierce connectée.
/api/(domainePartenaire)/users/appUserId/subaccounts/appAccountId/historyitems/
1. HistoryItem
L’objet historique est un objet permettant de récupérer l’ensemble des mouvements d’argent associés au compte du user sélectionné.
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| Id | Long | 18 | Identifiant de l’opération |
| Account | AccountIdentifier | Compte utilisé pour effectuer l’opération | |
| OperationDate | DateTime | "2013-09-10T 15:50:37.2363199 +02:00" |
Date de l’opération |
| Amount | Long | 1250 | Montant de l’opération (hors commission) |
| Label | String | "Dîner au restaurant" | Libellé associé à l’opération |
| Attachment | Attachment | Informations de la pièce jointe | |
| IsNew | Bool | false | L’élément est nouveau |
| Type | Int | 0 | Type de l’opération 0 = Transfert d’argent 1 = Chargement par CB 2 = Virement vers un BIC/IBAN 3 = Paiement e-commerce 4 = Paiement e-commerce carte 5 = Paiement distributeur 6 = Commission 7 = Remboursement 8 = Opération de régulation 9 = Chargement par virement 10 = Chargement par prélèvement |
| Direction | Int | 1 | Précise si c’est une opération entrante ou sortante 0 = None 1 = In 2 = Out |
| Status | Int | 1 | Statut de l’opération 0 = Pending 1 = Succeeded 2 = Cancelled 3 = Failed 4 = Expired 5 = Refunded |
| OrderId | String | Order123 | Référence de l’opération chez l’application tierce |
2.Payment : HistoryItem
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| Sender | AccountIdentifier | Émetteur du paiement | |
| Receiver | AccountIdentifier | Receveur du paiement | |
| ChatMessages | List<ChatMessage |
Liste des messages de chat associés à l’opération | |
| PaymentRequest | PaymentRequest | Demande d’argent associée au paiement |
3. MoneyIn : HistoryItem
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| AccountLabel | string | "Carte bancaire" | Libellé de la carte utilisée |
4. MoneyOut : HistoryItem
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| AccountLabel | string | "Compte bancaire" | Libellé du compte bancaire utilisé |
5. VendingMachinePayment : HistoryItem
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| MerchantTransactionId | String | "1245XJK1" | Identifiant de la transaction distributeur |
| Product | String | "Café" | Label du produit acheté |
| MerchantName | String | "Distributeur" | Nom commercial du fournisseur |
6.EcommercePayment : HistoryItem
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| MerchantTransactionId | String | "12345XJK1" | Identifiant de la transaction e-commerce |
| MerchantName | String | "Marchand" | Nom du marchand e-commerce |
| MerchantImageUrl | String | "http://marchand.fr/img.png" | Url de l’image du marchand |
7. Refund : HistoryItem
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| RefundedOperation | HistoryItemReference | Référence vers l’opération qui a été remboursée |
8. HistoryItemReference
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| Id | Long | 12 | Id de l’opération |
| Type | Int | 0 | Type de l’opération |
| href | Url | /api/historyitems/12 | Lien vers le détail de l’opération |
9. ChatMessage
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| Message | String | "Merci !" | Message de chat |
| Sender | AccountIdentifier | Auteur du message | |
| Date | DateTime | "2013-09-29T17:04:05" | Date de l’envoi du message |
10. Attachment
| Propriété | Type | Exemple | Description |
|---|---|---|---|
| Id | Long | 23 | Id de la pièce jointe |
| Name | String | "Facture" | Nom de la pièce jointe |
| ContentType | String | "image/png" | Content-type de la pièce jointe |
| Size | Int | 233450 | Taille de la pièce jointe en octet |
| Href | Url | /api/attachments/23 | Lien vers la pièce jointe |