| API Developer Portal

Account Information

The Account Information APIs let you retrieve real-time account and transaction data from all your authorized Online Banking for Business accounts. In most cases you'll want to call a summary of your accounts first, which will return accountIDs to be used to identify accounts in future calls.

Endpoints Summary

get

/accounts

Search for Authorized Accounts

get

/accounts/{accountId}

Get an Account

get

/accounts/{accountId}/transactions

Search for Account Transactions

Search for Accounts

Get a list of all your accounts as a starting point for more specific requests. This call will return accountIDs and account balances.

Get

/accounts

Try It

Request

Code Samples

Headers

x-api-key required

string

authorization required

string

Query Parameters

accountIds

array

Comma separated list of account ids

startTime

array

Start time for use in retrieval of transactions. Please ignore this parameter.

endTime

array

End time for use in retrieval of transactions. Please ignore this parameter.

resultType

string

Flag to indicate if you want a lightweight array of descriptors or full account details. If set to `lightweight`, should only return the fields associated with the `AccountDescriptor` entity. This field is not required, but defaults to lightweight

offset

string

Opaque cursor used by the provider to send the next set of records

limit

integer

Number of elements that the consumer wishes to receive - Providers should implement reasonable defaults and maximum

Response

Table JSON

Accounts { . . .}

}

Accounts { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Get an Account

Check real-time balances for requested accounts.

Get

/accounts/{accountId}

Try It

Request

Code Samples

Headers

x-api-key required

string

authorization required

string

Path Parameters

accountId required

string

Account Identifier

coming soon

Response

Table JSON

AccountWithDetails { . . .}

}

Accounts { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Search for Account Transactions

Get a detailed transaction history for requested accounts.

Get

/accounts/{accountId}/transactions

Try It

Request

Code Samples

Headers

x-api-key required

string

authorization required

string

Query Parameters

startTime

array

Start time for use in retrieval of transactions. Please ignore this parameter.

endTime

array

End time for use in retrieval of transactions. Please ignore this parameter.

offset

string

Opaque cursor used by the provider to send the next set of records

limit

integer

Number of elements that the consumer wishes to receive - Providers should implement reasonable defaults and maximum

Path Parameters

accountId required

string

Account Identifier

coming soon

Response

Table JSON

Transactions { . . .}

}

Accounts { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

Error { . . .}

}

FAQs

More FAQs

Which bank account is associated with my BMO API account ID?

When you make a GET call to our system, specifically Search for Accounts, you'll be returned a list of authorized accounts. For security reasons, these accounts will be identified with a unique account ID that is different from the account number.

To see which account is associated with the account ID returned, check the account_number field in the body of the return.

What accounts will I be able to see when I connect an application in Production?

When you connect an application in production, you’ll be able to see the same accounts you’re entitled to in Online Banking for Business.