/api/conversations/{conversationId}/bankTransactionsRetrieving a list of banking transactions related to the conversation
The method allows you to get user transactions, if the conversation contains them. By default, it downloads transactions for a maximum of 90 full days, that is: today + 90 previous days. If you need a larger scope - please contact us. Transactions are returned as defined when creating the conversation. By default, this means both crediting and debiting the account, and only transactions that have already been made (posted or pending). Transactions are available when the appropriate callback is received, or when the bankTransactions status reaches FINISHED.
Query Parameters Description
The method supports the following query parameters:
| Parameter | Example | Description |
|---|---|---|
| page | 10 | Page number. Paging starts on page 0 (default). |
| pageSize | 10 | Number of transactions on the results page. Currently, values above 200 are treated as 200. |
Response Content
Detailed description of returned fields:
| Parameter | Example | Description |
|---|---|---|
| id | 34df2bd6-b790-4560-9fc9-f86c86d87990 | Unique transaction identifier |
| date | 2020-08-27T10: 40: 28.348Z | Date of operation in UTC time |
| status | PENDING | Status of a given transaction at the time of downloading information from the bank. Allowed values: BOOKED - posted transaction, PENDING - transaction in progress, SCHEDULED - future transaction. Scheduled transactions appear when the flags field with the value INCLUDE_SCHEDULED was specified when creating the conversation. |
| bank | BREXPLPW | Bank where the transaction was performed. The value identifies the bank as the SWIFT / BIC code. |
| accountId | PL68249000050000400075212326 | Account number where transaction was registered. |
| type | DEBIT | Type of transaction. Available values: DEBIT (account debit) and CREDIT (account credit) |
| amount | 1000 | Value of the transaction in a currency unit, e.g. in grosze. |
| currency | PLN | type of currency |
| title | Account top-up | Transaction title |
| sender | Jan Kowalski | Transaction sender |
| senderAccountId | PL68249000050000400075212326 | Account number of the sender |
| recipient | Jan Kowalski | Recipient of the transaction |
| recipientAccountId | PL32114020040000320250132522 | Account number of the receiver |
| tags | "transfer🏦commission", "income:crypto" | Transaction categories |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversationId | path | string | Required | Conversation ID |
page | query | integer · int32 | Optional | Page number |
pageSize | query | integer · int32 | Optional | The number of items on the page |
Responses
Transaction list available
application/vnd.authologic.v1.1+jsonmoreboolean required Information whether there are more pages available
itemsarray<object> required List of transactions
List of transactions
idstring required Unique identifier for the transaction
datestring · date-time required Transaction date
bankstring required Bank's SWIFT / BIC code
accountIdstring required Account number where transaction was registered.
typestring required Transaction Type / Direction:
- CREDIT - account crediting
- DEBIT - debiting the account
CREDITDEBITstatusstring required Transaction status:
- BOOKED - transaction booked
- PENDING - transaction in progress
- SCHEDULED - Transaction scheduled in the future
BOOKEDPENDINGSCHEDULEDamountinteger · int32 required Transaction value in basic units - e.g. in cents
currencystring required Currency code in which the transaction took place
titlestring optional Transaction title
senderstring optional Information about the sender
recipientstring optional Information about the recipient
senderAccountIdstring optional Account number of the sender
recipientAccountIdstring optional Account number of the receiver
tagsarray<string> optional Transaction categories
Bad Request
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Exhaustion of the plan or limitations related to non-payment
Forbidden
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Conversation not found
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Conversation is unavailable
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Server side error