Transactions attachments
The attachments feature lets you retrieve the attachments related to the transactions of an institution account of end users.
This feature is not activated by default on your domain. Please contact us to request access.
Upon activation, the property attachments
is available in the Bank transactions.
API endpoint
List attachments.
GET
https://{domain}.biapi.pro/2.0/users/{userId}/transactions?expand=attachments
List attachments for transactions.
Path Parameters
Name | Type | Description |
---|---|---|
userId* | Integer or "me" | ID of the related user. |
Query Parameters
Name | Type | Description |
---|---|---|
limit* | Integer | Number of transactions to return. The maximum value is 1000. |
attachments* | String | Attachments related to the transactions |
Response body: #transactionslist-object
Get a bank transaction and its attachment.
GET
https://{domain}.biapi.pro/2.0/users/{userId}/transactions/{transactionId}/attachments
Get a single bank transaction by ID, and its attachment.
Path Parameters
Name | Type | Description |
---|---|---|
userId* | Integer or "me" | ID for the related user. |
transactionId* | Integer | ID of the transaction. |
Response body: #transaction-object
Attachment object
Property | Type | Description |
---|---|---|
| Integer | ID of the attachment. |
| String | Name of the attachment. |
| String | A text description that provides additional information about the file. This field can be used to describe the content, purpose, or any relevant details related to the file. |
| String | Media type of the attachment (A media type is a two-part identifier for file formats and format contents transmitted on the Internet.) |
| Integer | Size of the attachment in bytes. |
| Date | Date when the attachment was created. |
| DateTime | Date and time when the attachment was created. |
| DateTime | Datetime of the last synchronization of the attachment. |
| String | The url to retrieve the attachment. |
Webhook
Attachment found
A TRANSACTION_ATTACHMENTS_FOUND
webhook is emitted during a sync after bank accounts have been synchronized, and after the transactions are processed.
Webhook request:
Property | Type | Description |
---|---|---|
| Integer | ID of the connection. |
| Integer | ID of the account. |
| Integer | ID of the transaction. |
| List of AttachmentObject | Array of attachments of a transaction. |
Last updated