Bank History

What is a bank history?

Bank history is a special type of Bank record that allows for the retrieval of bank history transactions associated with a bank account.

To get started with Bank History for a bank account, the bank account must first be enrolled as a Bank History bank using the Bank history enrollment checkout flow.

>Enroll a Bank</button>

Flow of a bank history request

A bank history will begin with lastRequestProgress in the "ready" state. This indicates that the bank history is available to be requested.

You can request a bank history by calling the Request a history endpoint. When the history is requested the lastRequestProgress will change to the "processing" state, indicating that the request is currently being processed. In addition, the lastRequestStatus field will change to "inProgress". Requesting a bank history while it is already in progress will have no effect.

When the bank history is ready, a BankHistory event will be sent indicating that the bank history request has been processed. The lastRequestProgress field will turn back to "ready" indicating that it is available for further requests and lastRequestStatus field will change to either "hasNewResults" or "noNewResults", depending on whether or not new history has been added since the last request.

Occasionally a bank history will become disconnected, indicated by both the lastRequestProgress field and the lastRequestStatus field switching to "reconnect". When this happens, the bank must be reconnected using the Bank History enrollment checkout. A request for history will not be enabled when the bank history is in a "reconnect" state. Any history that had previously been requested will still be available via the Retrieve a history endpoint.

Bank History Parameters

idType: string
Length: 25

The unique id for the bank history bank.
objectType: string
Value: bankHistory

Identifies this as the bank history object.
accountTypeType: enum
Values: checking, savings
bankNameType: string
Length: 256

The name of the bank.
accountNameType: string
Length: 256

The name of the account.
routingNumberType: string
Length: 32

The bank routing number.
nameOnAccountType: string
Length: 256

The name on the bank account.
accountHolderTypeType: enum
Values: individual, company
currencyType: ISO4217 currency code

The currency for the bank account.
countryType: ISO 3166-1 alpha-3

The country where this bank account is located.
last4Type: string
Length: 4

The last four digits of the bank account.
lastRequestProgressType: string
Enum: reconnect, ready, processing

The progress of the last bank history request.
lastRequestStatusType: string
Enum: hasNewResults, noNewResults, reconnect, inProgress

The status of the last bank history request.
lastRequestDateType: date string
statusType: string
Enum: active, inactive

The overall status of the bank history
createdType: date string

The date the bank history was created
lastUpdatedType: date string

The date the bank history was last updated

History Results Parameters

results.idType: string
Length: 25
results.amountType: decimal string

The amount of the transaction.
results.dateType: date string

The date of the transaction.
results.currentBalanceType: decimal string

The current balance after the transaction.
results.debitType: boolean

Was the transaction a debit or credit.
results.descriptionType: string
Length: 0-256

A description of the transaction.
results.pendingType: boolean

Is the transaction pending or complete.
results.recurringType: boolean

Is the transaction a recurring transaction.