Finicity pay

Finicity Pay includes premium and non-premium API services to connect to customer accounts, retrieve the routing and account numbers, and account balance information from financial institutions (FI) before initiating payments. Premium services are billable per every successful API call.

Note: Before calling premium endpoints, see Financial institution certified for premium services.

Premium services

Non-premium services

Financial institution certified for premium services

Check to see that the financial institution (FI) for the customer’s account is certified to provide services, such as ach, aha, state_agg, and so on before calling any of the premium endpoints.

  1. Call the Get Certified Institutions a couple of times a day and cache the results.
  2. Call the Get Customer Accounts API to retrieve the institutionId from the account record.
  3. Check if the account’s institutionId is certified for the premium service from the Get Certified Institutions results you cached earlier.
  4. If the FI is supported, call the API and retrieve the premium service information.

Get account ACH details

Retrieve a customer’s routing and account number for a specified account used for payment initiation. Use the customerId and the accountId parameters to specify the customer’s account.

Note: This is a premium service, billable per every successful API call.

See Get Account ACH Details API

Get account owner

Retrieve the names and addresses of the account owner from a financial institution.

Note: This is a premium service, billable per every successful API call.

See Get Account Owner API

Get available balance—live

Retrieve the available and cleared account balances for a single account in real-time from a financial institution.

See Get available balance-Live API

Get available balance

Retrieve the latest cached available and cleared account balances for a single customer account. Since we update and store balances throughout the day, this is the most accurate balance information available when a connection to a financial institution is unavailable or when a faster response is needed.

See Get available balance API

Get account balance Information

By default, after the customer adds their accounts through a Connect session, the account numbers and balances are automatically retrieved, and then updated every 24 hours.

To get an account’s balance information for the first time, use the Refresh Customer Accounts by Institution Login API. Otherwise, use the Get Customer Account API to retrieve the balance information for the Customer Account.