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

200: OK List of 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.

200: OK Transaction

Response body: #transaction-object

Attachment object

Property	Type	Description
id	Integer	ID of the attachment.
name	String	Name of the attachment.
description	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.
mime_type	String	Media type of the attachment (A media type is a two-part identifier for file formats and format contents transmitted on the Internet.)
size	Integer	Size of the attachment in bytes.
created_at	Date	Date when the attachment was created.
created_datetime	DateTime	Date and time when the attachment was created.
last_update	DateTime	Datetime of the last synchronization of the attachment.
url	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
id_connection	Integer	ID of the connection.
id_account	Integer	ID of the account.
id_transaction	Integer	ID of the transaction.
attachments	List of AttachmentObject	Array of attachments of a transaction.