Skip to main content
GET
Get the account summary for a given account

Headers

Auth-Token
string
required

Authentication token provided during the authentication process

Path Parameters

bank_account_id
integer<int64>
required

Query Parameters

source
enum<string>
Available options:
DEFAULT,
FINICITY,
FDE,
MX

Response

The bank account summary

status
enum<string>
Available options:
100 CONTINUE,
101 SWITCHING_PROTOCOLS,
102 PROCESSING,
103 EARLY_HINTS,
103 CHECKPOINT,
200 OK,
201 CREATED,
202 ACCEPTED,
203 NON_AUTHORITATIVE_INFORMATION,
204 NO_CONTENT,
205 RESET_CONTENT,
206 PARTIAL_CONTENT,
207 MULTI_STATUS,
208 ALREADY_REPORTED,
226 IM_USED,
300 MULTIPLE_CHOICES,
301 MOVED_PERMANENTLY,
302 FOUND,
302 MOVED_TEMPORARILY,
303 SEE_OTHER,
304 NOT_MODIFIED,
305 USE_PROXY,
307 TEMPORARY_REDIRECT,
308 PERMANENT_REDIRECT,
400 BAD_REQUEST,
401 UNAUTHORIZED,
402 PAYMENT_REQUIRED,
403 FORBIDDEN,
404 NOT_FOUND,
405 METHOD_NOT_ALLOWED,
406 NOT_ACCEPTABLE,
407 PROXY_AUTHENTICATION_REQUIRED,
408 REQUEST_TIMEOUT,
409 CONFLICT,
410 GONE,
411 LENGTH_REQUIRED,
412 PRECONDITION_FAILED,
413 PAYLOAD_TOO_LARGE,
413 REQUEST_ENTITY_TOO_LARGE,
414 URI_TOO_LONG,
414 REQUEST_URI_TOO_LONG,
415 UNSUPPORTED_MEDIA_TYPE,
416 REQUESTED_RANGE_NOT_SATISFIABLE,
417 EXPECTATION_FAILED,
418 I_AM_A_TEAPOT,
419 INSUFFICIENT_SPACE_ON_RESOURCE,
420 METHOD_FAILURE,
421 DESTINATION_LOCKED,
422 UNPROCESSABLE_ENTITY,
423 LOCKED,
424 FAILED_DEPENDENCY,
425 TOO_EARLY,
426 UPGRADE_REQUIRED,
428 PRECONDITION_REQUIRED,
429 TOO_MANY_REQUESTS,
431 REQUEST_HEADER_FIELDS_TOO_LARGE,
451 UNAVAILABLE_FOR_LEGAL_REASONS,
500 INTERNAL_SERVER_ERROR,
501 NOT_IMPLEMENTED,
502 BAD_GATEWAY,
503 SERVICE_UNAVAILABLE,
504 GATEWAY_TIMEOUT,
505 HTTP_VERSION_NOT_SUPPORTED,
506 VARIANT_ALSO_NEGOTIATES,
507 INSUFFICIENT_STORAGE,
508 LOOP_DETECTED,
509 BANDWIDTH_LIMIT_EXCEEDED,
510 NOT_EXTENDED,
511 NETWORK_AUTHENTICATION_REQUIRED
message
string
id
integer<int64>
source
string

Which provider this connection is on: FINICITY, MX, FDE or PDF. The same value the account list returns for this connection, and the value to send as the source parameter on the other per-connection calls.

customerId
string
bankAccount
string

The provider's own identifier for this connection: the institution login id for Finicity, the member guid for MX, the account code for FDE.

name
string
addedBy
string

Username of the accounting firm the connection was added under, recorded when the connection was created: the firm itself when the firm owns the connection, otherwise the client's firm. It is not the person who completed the bank login. For FDE connections it is the username of the connection's owner.

institutionUrl
string
accounts
object[]
extractTransactionsFrom
string
extractStatementsFrom
string
accountCode
string

FDE connections only: the FDE account code, the same value as bankAccount. Omitted for Finicity and MX connections, whose identifier is in bankAccount.

customerCode
string
statusType
string
statusMessage
string
balanceUpdateStatus
string
balanceUpdateErrorMsg
string
aggregationStatusCode
integer<int32>