How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Finicity Payments API

Fetch ACH details and account balances

Finicity Payments API is one of 41 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.43.0.

Requests are made against a single base URL, https://api.finicity.com.

5 operations 5 paths 19 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.43.0
Base URL
https://api.finicity.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Finicity Payments API declares 2 security schemes for authenticating requests. An API key is passed in the header as Finicity-App-Key (FinicityAppKey). An API key is passed in the header as Finicity-App-Token (FinicityAppToken). By default, every request must be authenticated.

  • FinicityAppKey — The "Finicity-App-Key" from the developer dashboard
  • FinicityAppToken — A token returned by the /authentication API

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Payments 5

Fetch ACH details and account balances

GET
/aggregation/v2/customers/{customerId}/accounts/{accountId}/loanDetails
Get Loan Payment Details
GetLoanPaymentDetails 2 params → 200400401404
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/details
Get Account ACH Details
GetAccountACHDetails 2 params → 200400401404
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalance/live
Get Available Balance
GetAvailableBalanceLive 3 params → 200400401404
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalancedeprecated
Get Available Balance - Cached
GetAvailableBalance 2 params → 200400401404
GET
/aggregation/v3/customers/{customerId}/accounts/{accountId}/details
Get Account ACH Details with RTP/FedNow
GetAccountPaymentInstructionDetails 2 params → 200400401404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ErrorMessage (10 properties), AvailableBalance (8 properties), LoanPaymentDetailsAccount (8 properties), LoanPaymentDetailsGroup (7 properties). Each schema is shown below with its type and property counts.

Currency
string
A currency code
AvailableBalance
object
8 properties 8 required
ErrorMessage
object
10 properties 1 required
AccountId
string
An account ID
NumericCustomerId
integer
A customer ID represented as a number. See Add Customer API for how to create a customer ID.
LoanPaymentDetailsAccount
object
8 properties 4 required
PaymentInstructions
object
A list of payment instructions
1 property
ACHDetails
object
The routing and account number information to initiate ACH transfers
2 properties 2 required
AllowedBalanceCacheInterval
integer
Cache interval in minutes for available balance retrieval. If omitted, the default interval is 30 minutes. If 0, always fetch live balance. If greater than 0,…
Descriptor
object
2 properties 2 required
LoanPaymentDetails
object
Loan payment details for a customer account
4 properties 3 required
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
AggregationStatusCode
integer
The status of the most recent aggregation attempt (see [Aggregation Status Codes](https://developer.mastercard.com/open-finance-us/documentation/products/manag…
LoanPaymentDetailsGroup
object
Group details
7 properties 5 required
LoanPaymentDetailsLoan
object
Loan details
6 properties 4 required
UnixDate
integer
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practi…
AccountNumberLast4
string
The last 4 digits of the account number, derived by Mastercard from the account number provided by the financial institution. This is only returned for ACH-ena…
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
PaymentInstruction
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

finicity-payments-api-openapi.yml Raw ↑

Other APIs Finicity publishes across the network.

Finicity Connect
Finicity Verification of Assets (VoA) API
Finicity Verification of Income & Employment (VoIE) API
Finicity Transaction Analysis (Cash Flow) API
Finicity Payments (Account Validation) API
Finicity Open Banking Data Access (FDX)
Finicity Account Validation Assistance API
Finicity Accounts API
Finicity Accounts (Simple) API
Finicity App Registration API
Finicity Authentication API
Finicity Balance Analytics API
Where this information came from

This is an independent, third-party profile of Finicity Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.