V1

Resources

History can be accessed through :

Access to history of a connected user
/api/(domainePartenaire)/historyitems/
 Access to history of a sub-account of a connected user
/api/(domainePartenaire)/subaccounts/appAccountId/historyitems/

OR

 Access to history of a user belonging to the connected third-party application
/api/(domainePartenaire)/users/appUserId/historyitems/
 Access to history of a sub-account of a user belonging to the connected third-party application.
/api/(domainePartenaire)/users/appUserId/subaccounts/appAccountId/historyitems/

1. HistoryItem
History item is an item allows retrieving all money transactions associated to an account of a selected user .

Property Type Example Description
Id Long 18 Operation identifier
Account AccountIdentifier Account used to perform the operation
OperationDate DateTime "2013-09-10T
15:50:37.2363199
+02:00"
Operation date
Amount Long 1250 Operation amount (without fee)
Label String "Dinner at a restaurant" Description associated with the operation
Attachment Attachment Attachment details
IsNew Bool false The item is new
Type Int 0 Operation type
0 = Money transfer
1 = Top-up by CB
2 = Bank transfer to BIC/IBAN
3 = e-commerce payment
4 = e-commerce card payment
5 = Vending machine payment
6 = Fee
7 = Refund
8 = Regulation operation
9 = Top-up by bank transfer
10 = Top-up by transfer
Direction Int 1 Precise if it is an incoming or outcoming operation
0 = None
1 = In
2 = Out
Status Int 1 Operation status
0 = Pending
1 = Succeeded
2 = Cancelled
3 = Failed
4 = Expired
5 = Refunded
OrderId String Order123 Operation reference in the third-party application

2.Payment : HistoryItem

Property Type Example Description
Sender AccountIdentifier Payment sender
Receiver AccountIdentifier Payment receiver
ChatMessages List<ChatMessage> List of chat messages associated with the operation
PaymentRequest PaymentRequest Money request associated with the payment

3. MoneyIn : HistoryItem

Property Type Example Description
AccountLabel string "Bank card" Bank account description

4. MoneyOut : HistoryItem

Property Type Example Description
AccountLabel string "Bank account" Bank account description

5. VendingMachinePayment : HistoryItem

Property Type Example Description
MerchantTransactionId String "1245XJK1" Identifier of the vending machine transaction
Product String "Coffee" Purchased product label
MerchantName String "Vending machine" Supplier commercial name

6.EcommercePayment : HistoryItem

Property Type Example Description
MerchantTransactionId String "12345XJK1" Identifier of the e-commerce transaction
MerchantName String "Marchand" E-commerce merchant name
MerchantImageUrl String "http://marchand.fr/img.png" Merchant picture Url

7. Refund : HistoryItem

Property Type Example Description
RefundedOperation HistoryItemReference Reference to the refunded operation

8. HistoryItemReference

Property Type Example Description
Id Long 12 Operation ID
Type Int 0 Operation type
href Url /api/historyitems/12 Link to operation details

9. ChatMessage

Property Type Example Description
Message String "Thank you !" Chat message
Sender AccountIdentifier Message sender
Date DateTime "2013-09-29T17:04:05" Date the message was sent

10. Attachment

Property Type Example Description
Id Long 23 Attachment ID
Name String "Facture" Attachment name
ContentType String "image/png" Attachment content type
Size Int 233450 Attachment size in bytes
Href Url /api/attachments/23 Link to the attachment