Bank transactions
The Bank product lets you retrieve bank transactions of end users. Transactions are associated with a bank account.
API endpoints
Authentication: endpoints listed in this page require header authentication with a user token.
List bank transactions
GET
https://{domain}.biapi.pro/2.0/users/{userId}/transactions
List bank transactions of the authenticated user. By default, only active (not deleted
) transactions are returned, use the all
parameter to get the full list.
Path Parameters
Name | Type | Description |
---|---|---|
userId* | Integer or "me" | ID of the related user. |
Query Parameters
Name | Type | Description |
---|---|---|
all | Value-less | Flag to include deleted transactions. |
limit* | Integer | Number of transactions to return. The maximum value is 1000. |
income | Boolean | Filter on incomes or expenditures. |
deleted | Boolean | Filter on deleted transactions. |
filter | String | Name of the field to use for explicit filtering: |
min_date | Date or Month | Minimum date of the filtering field. |
max_date | Date or Month | Maximum date of the filtering field. |
wording | String | Filter transactions containing the given string. |
min_value | Decimal | Minimal (inclusive) value. |
max_value | Decimal | Maximum (inclusive) value. |
search | String | Search in wording, dates, values, categories. |
value | Decimal or String | Value of the transaction. "XX|-XX" and "±XX" format is also accepted. |
last_update | DateTime | Filter transactions updated after the specified date. |
Response body: TransactionsList object
Listing bank transactions requires explicit pagination (i.e. the limit
parameter is required). Also, this endpoint provides relational pagination.
Get a bank transaction
GET
https://{domain}.biapi.pro/2.0/users/{userId}/transactions/{transactionId}
Get a single bank transaction by ID.
Path Parameters
Name | Type | Description |
---|---|---|
userId* | Integer or "me" | ID for the related user. |
transactionId* | Integer | ID of the transaction. |
Response body: Transaction object
Transactions partially support updates to override some display-related properties:
Update a bank transaction
POST
https://{domain}.biapi.pro/2.0/users/{userId}/transactions/{transactionId}
Update metadata of a single bank transaction by ID.
Request body: TransactionUpdateRequest object
Path Parameters
Name | Type | Description |
---|---|---|
userId* | Integer or "me" | ID for the related user. |
transactionId* | Integer | ID of the transaction. |
Response body: Transaction object
Data model
TransactionsList object
Property | Type | Description |
---|---|---|
| Array of Transaction objects | List of transactions. |
| Date | Minimum available date for results. |
| Date | Maximum available date for results. |
| Date | Minimum date of results in the current response. |
| Date | Maximum date of results in the current response. |
| PaginationLinks object | Opaque links to the current, previous and next pages in the collection. |
Transaction object
Property | Type | Description |
---|---|---|
| Integer | ID of the transaction. |
| Integer | ID of the related account. |
| Date or null | Date considered by PFM services. This date can be edited. |
| Date | Date when the transaction is posted to the account. |
| DateTime or null | Date and time when the transaction is posted to the account, if available, in UTC. |
| Date or null | Value date of the transaction. In most cases, equivalent to |
| DateTime or null | Value date and time of the transaction, if available, in UTC. In most cases, equivalent to |
| Date | Date when the transaction order has been given. |
| DateTime or null | Date and time when the transaction order has been given, if available, in UTC. |
| Date or null | (Deprecated) Date displayed by the bank for the transaction. Use |
| DateTime or null | (Deprecated) Date and time displayed by the bank for the transaction, if available, in UTC. Use |
| Decimal or null | Value of the transaction. |
| Decimal or null | Gross value of the transaction. |
| TransactionType string | Type of transaction. |
| String | Full label of the transaction, as seen on the bank. |
| String | Simplified label of the transaction. |
| String or null | Label of the transaction, can be edited. |
| Integer or null | (Deprecated) ID of the related category. |
| DateTime | Date and time when the transaction was seen. |
| Boolean | If true, this transaction has not yet been posted to the account. |
| Boolean | If false, PFM services will ignore this transaction. |
| Integer or null | If the transaction is part of a cluster. |
| String or null | User comment. |
| DateTime or null | Last update of the transaction. |
| DateTime or null | If set, this transaction has been removed from the bank. |
| Decimal or null | Value in the original currency. |
| Decimal or null | Gross value in the original currency. |
| Currency or null | Original currency. |
| Decimal or null | Commission taken on the transaction. |
| Currency or null | Commission currency. |
| String or null | Original country. |
| String or null | Card number associated with the transaction. |
| Counterparty or null | The transaction counterparty, i.e. an optional business or individual entity associated with the transaction. |
Available expands
The following parameter can be used for response properties expansion:
Property | Type | Description |
---|---|---|
| Array of Attachment objects | The attachments related to a transaction. |
TransactionType values
Value | Description |
---|---|
| Transfer |
| Order |
| Check |
| Mandatory/voluntary deposits, contributions, money transfers |
| Payback |
| Withdrawal |
| Loan payment |
| Bank fees |
| Card operation |
| Deferred card operation |
| Monthly debit of a deferred card |
| Unknown transaction type |
| Market order |
| Fees regarding a market order |
| Arbitrage |
| Positive earnings from interests/coupons/dividends |
Forward compatibility requirement: additional types may be added in the future. When implementing type handling, always fallback to a generic case for unknown values.
Category object
Property | Type | Description |
---|---|---|
| String | |
| String or null |
Counterparty object
Property | Type | Description |
---|---|---|
| String or null | Label/name of the counterparty. |
| AccountSchemeName string or null | Type of the counterparty account number. |
| String or null | Account number of the counterparty. |
| String or null | Type of the counterparty: |
AccountSchemeName values
Value | Description |
---|---|
| International Bank Account Number. |
| Basic Bank Account Number. |
| United Kingdom local account number. |
| Card PAN. |
| Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. |
TransactionUpdateRequest object
Property | Type | Required | Description |
---|---|---|---|
| String | No | New wording of the transaction. |
| Date | No | New application date of the transaction. |
| Integer | No | (Deprecated) New category ID of the transaction. |
| String | No | New comment of the transaction. |
| String | No | If false, the transaction is not considered in balance summaries and sums. |
Last updated