Finicity Payment Success Indicator API is one of 41 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payment Success Indicator. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 6 paths,
and defines 32 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.
6 operations6 paths32 schemas4 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Finicity Payment Success Indicator 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 6
Across 6 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are ErrorMessage (10 properties), PaymentSuccessIndicator (9 properties), NsfReasonItem (8 properties), FcraPaymentSuccessIndicators (8 properties). Each schema is shown below with its type and property counts.
PotentialSettlementDate
string
The date for all days included in the response.
PaymentSuccessIndicator
object
9 properties7 required
PayPurposeCode
string
The 2-digit code (1P) assigned to indicate the intended purpose. 1P represents the following permissible purpose: “Determine whether a consumers payment method…
NsfDailyResults
array
An Array of 3-10 days, providing the potentialSettlementDate, score, indicator, and reasons.
Indicator
object
4 properties4 required
SettleByDate
string
The expected date that the funds, from the consumer’s account, will be moved to the receiving account. settleByDate in ISO 8601 date format (YYYY-MM-DD). settl…
NsfReasonItem
object
A collection of 8 reason codes, with a score ranging from 0-100, that explains the drivers that caused the nsf score.
8 properties8 required
ReasonItem
object
A collection of 8 reason codes, with a score ranging from 0-100, that explains the drivers that caused the score.
8 properties8 required
PaymentSuccessIndicatorsTransactionAmount
number
The transaction amount
ErrorMessage
object
10 properties1 required
AccountId
string
An account ID
FcraPaymentSuccessIndicators
object
A Payment Success Indicators score response, indicating how likely a transaction is to be returned. NSF and Unauthorized return risks are provided if the score…
8 properties6 required
PaymentSuccessIndicatorsUser
object
The user's information
4 properties
FcraNsfReturnRiskResult
object
The successful result of the execution of the nsf return risk
3 properties2 required
PaymentSuccessIndicatorsAddress
object
The customer's address
6 properties
PaymentSuccessIndicatorsTransaction
object
An object containing the requested transaction info.
2 properties2 required
FcraNsfReturnRisk
object
The result or error occurred during the execution of the nsf return risk prediction
2 properties
PayRequestId
string
Unique identifier of the Payments request
PaymentSuccessIndicatorsPhone
object
The phone information
2 properties
PaymentSuccessIndicatorsProperties
object
Properties to request a Payment Success Indicator score
2 properties1 required
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
NsfReturnRisk
object
The result or error occurred during the execution of the nsf return risk prediction
2 properties
CompositeScore
integer
A risk score from 0-100 that indicates the likelihood of return risk, where a higher score indicates a higher likelihood of settlement or lower likelihood of r…
PurposeCode
string
FCRA required 2-digit Permissible Purpose Code, specifying the reason for retrieving this report.
PaymentSuccessIndicators
object
A Payment Success Indicators score response, indicating how likely a transaction is to be returned. NSF and Unauthorized return risks are provided if the score…
8 properties6 required
NsfReturnRiskResult
object
The successful result of the execution of the nsf return risk
2 properties2 required
ScoreIndicator
string
scoreIndicator conveys the compositeScore, projecting 3 possible values: "Highly Likely to Settle", "Likely to Settle", and "Less Likely to Settle"
SettlementAmount
number
The transaction amount in USD $.
UnauthorizedReturnRisk
object
The result or error occurred during the execution of the unauthorized return risk prediction
2 properties
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
NsfIndicator
object
4 properties3 required
IndicatorsByDay
array
An Array of 3-10 days, providing the potentialSettlementDate, compositeScore, scoreIndicator, and reasons.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Finicity Payment Success Indicator 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.
