Skip to main content
GET/api/conversations/{conversationId}/bankTransactions/accounts

Retrieving information on bank accounts related to the conversation

Returns information about the accounts from which transactions have been downloaded. This information occurs only when the bankTransactions section was defined when creating a conversation. and are available when the appropriate callback is received, or when the bankTransactions status reaches FINISHED.

Description of the Response Content

Detailed description of returned fields:

ParameterExampleDescription
date2020-09-17T11: 18: 21.999ZDate on which the information was collected.
balance10030Account balance in a currency unit, e.g. in pennies. The value determines the balance of funds available on the account or, if there is no such information, the balance of funds booked. It may not occur if the bank does not provide the balance.
bankBREXPLPWBank where the transaction was performed. The value identifies the bank as the SWIFT / BIC code.
accountIdPL68249000050000400075212326Account number.
currencyPLNcurrency type
activationDate2014-11-19The date when the account was opened or the date of the oldest transaction found.

Parameters

NameInTypeRequiredDescription
conversationIdpathstringRequired

Conversation ID

Responses

200

Account information available

application/vnd.authologic.v1.1+json
itemsarray<object> required

List of transaction information for each account

Array of object

List of transaction information for each account

datestring · date-time required

The date for which the data is valid

balanceinteger · int32 optional

Account balance in basic units - e.g. in cents

bankstring required

Bank's SWIFT / BIC code

accountIdstring required

Unique account identifier. All transactions from one account have the same ID

currencystring required

Currency code for the account

activationDatestring · date optional

The date when the account was opened or the date of the oldest transaction found

400

Bad Request

application/vnd.authologic.v1.1+json
One of:
Variant 1
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

Variant 2
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

Variant 3
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

Variant 4
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

Variant 5
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

Variant 6
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

Variant 7
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

402

Exhaustion of the plan or limitations related to non-payment

403

Forbidden

application/vnd.authologic.v1.1+json
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

404

Conversation not found

application/vnd.authologic.v1.1+json
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

410

Conversation is unavailable

application/vnd.authologic.v1.1+json
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

500

Server side error

Powered by Authologic Nisaba