Finicity

Finicity Payment Success Indicator API

Predict a transaction's likelihood to settle

GitHub OpenAPI

Operations 6

POST /payments/customers/{customerId}/accounts/{accountId}/fcra-payment-success-indicators Generate FCRA Payment Success Indicators #
GET /payments/customers/{customerId}/accounts/{accountId}/fcra-payment-success-indicators/{payRequestId} Get FCRA Payment Success Indicators by Pay Request ID #
POST /payments/customers/{customerId}/accounts/{accountId}/payment-success-indicators Generate Non-FCRA Payment Success Indicators #
GET /payments/customers/{customerId}/accounts/{accountId}/payment-success-indicators/{payRequestId} Get Non-FCRA Payment Success Indicators by Pay Request ID #
GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/payments/paymentIndicator/fcra Get FCRA Payment Success Indicator (Legacy) #
GET /aggregation/v2/customers/{customerId}/accounts/{accountId}/payments/paymentIndicator Get Non-FCRA Payment Success Indicator (Legacy) #

Documentation

📖
Documentation
https://developer.mastercard.com/open-banking-us/documentation/
📖
APIReference
https://developer.mastercard.com/open-banking-us/documentation/api-reference/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/finicity/refs/heads/main/openapi/finicity-payment-success-indicator-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/finicity/refs/heads/main/asyncapi/finicity-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/finicity-payment-success-indicator-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

finicity-payment-success-indicator-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Open Finance Payment Success Indicator API
  description: 'OpenAPI specification for Finicity APIs.


    Open Finance (formerly Open Banking) solutions in the US are provided by

    Finicity, a Mastercard company.'
  contact:
    name: API Support
    email: apisupport@mastercard.com
    url: https://developer.mastercard.com/open-finance-us/documentation/support/
  version: 1.43.0
servers:
- url: https://api.finicity.com
  description: Production
security:
- FinicityAppKey: []
  FinicityAppToken: []
tags:
- name: Payment Success Indicator
  description: Predict a transaction's likelihood to settle
paths:
  /payments/customers/{customerId}/accounts/{accountId}/fcra-payment-success-indicators:
    post:
      tags:
      - Payment Success Indicator
      summary: Generate FCRA Payment Success Indicators
      description: 'Payment Success Indicator (PSI) allows the user to evaluate the likelihood of a specific ACH transaction resulting in either an insufficient funds return (NSF) or an unauthorized return due to first- or third-party fraud. PSI is powered by a machine learning model trained on consumer-permissioned data. PSI provides a risk assessment, which includes a real-time balance check, predictive risk scores forecasting a consumer’s likelihood of having sufficient funds over a 10-day period, a real-time score predicting the likelihood of an unauthorized return, and risk attributes to explain and enhance decisioning. Provision and use of this report is subject to all applicable obligations of the FCRA and any applicable analogous state law. This product may only be used for the stated permissible purpose under the FCRA.

        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: GenerateFcraPaymentSuccessIndicators
      parameters:
      - $ref: '#/components/parameters/CustomerIdParameter'
      - $ref: '#/components/parameters/AccountIdParameter'
      - $ref: '#/components/parameters/PurposeParameter'
      requestBody:
        $ref: '#/components/requestBodies/GeneratePaymentSuccessIndicatorsRequest'
      responses:
        '202':
          $ref: '#/components/responses/GeneratePaymentSuccessIndicatorsResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAllowedErrorResponse'
  /payments/customers/{customerId}/accounts/{accountId}/fcra-payment-success-indicators/{payRequestId}:
    get:
      tags:
      - Payment Success Indicator
      summary: Get FCRA Payment Success Indicators by Pay Request ID
      description: 'Get the FCRA Payment Success Indicator scores that have been generated by a previous call to Generate FCRA Payment Success Indicators.

        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: GetFcraPaymentSuccessIndicators
      parameters:
      - $ref: '#/components/parameters/CustomerIdParameter'
      - $ref: '#/components/parameters/AccountIdParameter'
      - $ref: '#/components/parameters/PayRequestIdParameter'
      - $ref: '#/components/parameters/IncludeReasonsParameter'
      responses:
        '200':
          $ref: '#/components/responses/RetrieveFcraPaymentSuccessIndicatorsResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAllowedErrorResponse'
  /payments/customers/{customerId}/accounts/{accountId}/payment-success-indicators:
    post:
      tags:
      - Payment Success Indicator
      summary: Generate Non-FCRA Payment Success Indicators
      description: 'Payment Success Indicator (PSI) allows the user to evaluate the likelihood of a specific ACH transaction resulting in either an insufficient funds return (NSF) or an unauthorized return due to first- or third-party fraud. PSI is powered by a machine learning model trained on consumer-permissioned data. PSI provides a risk assessment, which includes a real-time balance check, predictive risk scores forecasting a consumer’s likelihood of having sufficient funds over a 10-day period, a real-time score predicting the likelihood of an unauthorized return, and risk attributes to explain and enhance decisioning. This product may not be used for uses subject to the FCRA.


        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: GeneratePaymentSuccessIndicators
      parameters:
      - $ref: '#/components/parameters/CustomerIdParameter'
      - $ref: '#/components/parameters/AccountIdParameter'
      requestBody:
        $ref: '#/components/requestBodies/GeneratePaymentSuccessIndicatorsRequest'
      responses:
        '202':
          $ref: '#/components/responses/GeneratePaymentSuccessIndicatorsResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAllowedErrorResponse'
  /payments/customers/{customerId}/accounts/{accountId}/payment-success-indicators/{payRequestId}:
    get:
      tags:
      - Payment Success Indicator
      summary: Get Non-FCRA Payment Success Indicators by Pay Request ID
      description: 'Get the Non-FCRA Payment Success Indicator scores that have been generated by a previous call to Generate Payment Success Indicators.


        _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)'
      operationId: GetPaymentSuccessIndicators
      parameters:
      - $ref: '#/components/parameters/CustomerIdParameter'
      - $ref: '#/components/parameters/AccountIdParameter'
      - $ref: '#/components/parameters/PayRequestIdParameter'
      - $ref: '#/components/parameters/IncludeReasonsParameter'
      responses:
        '200':
          $ref: '#/components/responses/RetrievePaymentSuccessIndicatorsResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAllowedErrorResponse'
  /aggregation/v1/customers/{customerId}/accounts/{accountId}/payments/paymentIndicator/fcra:
    get:
      tags:
      - Payment Success Indicator
      summary: Get FCRA Payment Success Indicator (Legacy)
      description: "Payment Success Indicator (PSI) allows the user to evaluate the likelihood of a specific ACH transaction resulting in an insufficient funds return (NSF). PSI is powered by a machine learning model trained on Finicity’s consumer-permissioned data network. PSI provides a risk assessment, which includes a real-time balance check, a predictive risk score for the up to the next 9 days, and 8 risk attributes to explain and enhance decisioning. Provision and use of this report is subject to all applicable obligations of the FCRA and any applicable analogous state law. This product may only be used for the stated permissible purpose under the FCRA.\n\n\n _Supported regions_: ![\U0001F1FA\U0001F1F8](https://flagcdn.com/20x15/us.png)"
      operationId: GetFCRAPaymentSuccessIndicator
      parameters:
      - $ref: '#/components/parameters/CustomerIdParameter'
      - $ref: '#/components/parameters/AccountIdParameter'
      - $ref: '#/components/parameters/SettlementAmountParameter'
      - $ref: '#/components/parameters/SettleByDateParameter'
      - $ref: '#/components/parameters/PayPurposeCodeParameter'
      responses:
        '200':
          $ref: '#/components/responses/GetPaymentSuccessIndicatorResponse'
        '400':
          $ref: '#/components/responses/GetPaymentSuccessIndicatorFcraBadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/GetPaymentSuccessIndicatorNotFoundResponse'
  /aggregation/v2/customers/{customerId}/accounts/{accountId}/payments/paymentIndicator:
    get:
      tags:
      - Payment Success Indicator
      summary: Get Non-FCRA Payment Success Indicator (Legacy)
      description: "Payment Success Indicator (PSI) is a Payment Intelligence solution that uses Financial Institution (FI) data to help payment originators evaluate a consumer's ability to pay now and in the future within a given time period. PSI is for payment originators to assess a consumer's real-time FI account balance and historical FI account activities to help minimize ACH declines and enable payment originators to gracefully transition to alternative payment methods or schedules when payment settlement using ACH / Account-based payment is less likely. PSI may not be used for credit or insurance underwriting, employment or rental screening, or any other purpose(s) that would implicate the Fair Credit Reporting Act or other consumer reporting law.\n\n\n _Supported regions_: ![\U0001F1FA\U0001F1F8](https://flagcdn.com/20x15/us.png)"
      operationId: GetPaymentSuccessIndicator
      parameters:
      - $ref: '#/components/parameters/CustomerIdParameter'
      - $ref: '#/components/parameters/AccountIdParameter'
      - $ref: '#/components/parameters/SettlementAmountParameter'
      - $ref: '#/components/parameters/SettleByDateParameter'
      responses:
        '200':
          $ref: '#/components/responses/GetPaymentSuccessIndicatorResponse'
        '400':
          $ref: '#/components/responses/GetPaymentSuccessIndicatorBadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/GetPaymentSuccessIndicatorNotFoundResponse'
components:
  examples:
    MissingFinicityAppKeyExample:
      value:
        code: '10026'
        message: Missing parameter (Finicity-App-Key)
    ResellerNoReportForPartnerExample:
      value:
        code: '10100'
        message: Cannot find resellerBilling reports with id 2445581559892.
    ResellerInvalidDateRangeGreaterThan31DaysExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Invalid date range - It is more than 31 days'
    ResellerInvalidDateRangeGreaterThanEndDateExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Invalid date range - startDate is greaterThan endDate'
    BothCraAndFtcPurposeTrueExample:
      value:
        code: '10100'
        status: '400'
        message: forCRAPurpose and forFTCPurpose may not both be TRUE.
    MissingFieldExample:
      value:
        code: '10005'
        message: Missing parameter (partnerId)
    PaymentSuccessIndicatorsSuccessResponseExample:
      value:
        payRequestId: '476412776235977427'
        status: SUCCESS
        customerId: '1005061234'
        accountId: '20050961233'
        requestDate: '2025-04-24'
        transaction:
          settleByDate: '2025-04-25'
          amount: 12.98
        nsfReturnRisk:
          result:
            availableBalance: 82.32
            dailyResults:
            - potentialSettlementDate: '2024-04-24'
              score: 7
              indicator: High Risk
              reasons:
                recentBalance: 12
                balanceHistory: 23
                nsfHistory: 40
                recentNsfHistory: 78
                recurringNsf: 34
                spendHistory: 44
                depositHistory: 10
                transactionAmount: 65
            - potentialSettlementDate: '2024-04-25'
              score: 6
              indicator: High Risk
              reasons:
                recentBalance: 12
                balanceHistory: 23
                nsfHistory: 40
                recentNsfHistory: 78
                recurringNsf: 34
                spendHistory: 44
                depositHistory: 10
                transactionAmount: 65
            - potentialSettlementDate: '2024-04-26'
              score: 8
              indicator: High Risk
              reasons:
                recentBalance: 12
                balanceHistory: 23
                nsfHistory: 40
                recentNsfHistory: 78
                recurringNsf: 34
                spendHistory: 44
                depositHistory: 10
                transactionAmount: 65
          unauthorizedReturnRisk:
            score: 89
            indicator: Low Risk
    IncorrectFieldTypeExample:
      value:
        code: '10007'
        message: '[FIELD] is the incorrect type'
    ResellerInvalidDateRangeLessThanZeroExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Invalid date range - start or end date less than or equal to zero'
    InvalidSettleByDateExample:
      value:
        code: '10006'
        message: settleByDate must not be in the past
    InvalidConsumerEmailExample:
      value:
        code: '10100'
        message: Invalid format for field consumer.email.
    MissingEmailExample:
      value:
        code: '12022'
        message: An email is required when registering a customer for PSI-FCRA
    ForbiddenErrorResponseExample:
      value:
        code: '10405'
        status: '403'
        message: An active security freeze for this customer exists.
    BadCredentialsExample:
      value:
        code: '24302'
        message: Bad credentials
    InvalidForesightReportRequestExample:
      value:
        code: '10100'
        message: At least one of customerId or externalCustomerId must be provided; both are also allowed.
    RequiredFieldParameterExample:
      value:
        code: '10009'
        message: '[FIELD] is a required parameter'
    NoRegisteredApplicationExample:
      value:
        code: '50051'
        message: No registered partner applications found.
    ExpiredFinicityAppTokenExample:
      value:
        code: '10023'
        message: Expired (Finicity-App-Token)
    InvalidFieldExample:
      value:
        code: '10010'
        status: '400'
        message: Customer ID does not exist or does not belong to this partner
        user_message: One or more of the fields could not be validated. Please ensure you have entered the correct data.
        tags: ''
    InvalidValueExample:
      value:
        code: '1618'
        message: Negative or invalid value entered. Please use positive numbers only.
    InvalidConsumerSSNExample:
      value:
        code: '10100'
        message: Invalid format for field consumer.ssn.  Required format is 9 digits.
    InvalidFinicityAppTokenExample:
      value:
        code: '10022'
        message: Invalid (Finicity-App-Token)
    NoAccountForInstitutionLoginIdExample:
      value:
        code: '38007'
        message: Customer does not have any accounts associated with institutionLoginId.
    CustomerNotFoundExample:
      value:
        code: '14001'
        message: Customer not found.
    PaymentSuccessIndicatorWarningExample:
      value:
        code: '2000'
        message: Successful Warning - settlement amount exceeds available balance
        customerId: '453752752892'
        accountId: '453752772892'
        payReqId: '484265782033818817'
        settleByDate: '2023-06-07'
        settlementAmount: 102.05
        availableBalance: 82.32
        indicatorsByDay:
        - potentialSettlementDate: '2023-06-07'
          compositeScore: 7
          scoreIndicator: Less Likely to Settle
          reasons:
            recentBalance: 12
            balanceHistory: 23
            nsfHistory: 40
            recentNsfHistory: 78
            recurringNsf: 34
            spendHistory: 44
            depositHistory: 10
            transactionAmount: 65
        - potentialSettlementDate: '2023-06-08'
          compositeScore: 6
          scoreIndicator: Less Likely to Settle
          reasons:
            recentBalance: 12
            balanceHistory: 23
            nsfHistory: 40
            recentNsfHistory: 78
            recurringNsf: 34
            spendHistory: 44
            depositHistory: 10
            transactionAmount: 65
        - potentialSettlementDate: '2023-06-09'
          compositeScore: 5
          scoreIndicator: Less Likely to Settle
          reasons:
            recentBalance: 12
            balanceHistory: 23
            nsfHistory: 40
            recentNsfHistory: 78
            recurringNsf: 34
            spendHistory: 44
            depositHistory: 10
            transactionAmount: 65
    ResellerNoDataForPartnerExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Reports not found 2445583947903 resellerBilling reports'
    NotAllowedErrorResponseExample:
      value:
        code: '20000'
        status: '406'
        message: Only 'application/json' is supported.
    ExpiredTokenExample:
      value:
        code: '10023'
        message: Expired (Finicity-App-Token)
    ResellerInvalidDateRangeExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Invalid date range - start or end date is empty or null'
    ResourceNotFoundExample:
      value:
        code: '14001'
        message: Resource not found.
    ConsumerNotFoundExample:
      value:
        code: '10100'
        message: Cannot find consumer with id 1234.
    GenericBadRequestExample:
      value:
        code: '14020'
        message: Bad request.
    PaymentSuccessIndicatorsNoReasonsSuccessResponseExample:
      value:
        payRequestId: '476412776235977427'
        status: SUCCESS
        customerId: '1005061234'
        accountId: '20050961233'
        requestDate: '2025-04-24'
        transaction:
          settleByDate: '2025-04-25'
          amount: 12.98
        nsfReturnRisk:
          result:
            availableBalance: 82.32
            dailyResults:
            - potentialSettlementDate: '2024-04-24'
              score: 7
              indicator: High Risk
            - potentialSettlementDate: '2024-04-25'
              score: 6
              indicator: High Risk
            - potentialSettlementDate: '2024-04-26'
              score: 8
              indicator: High Risk
          unauthorizedReturnRisk:
            score: 89
            indicator: Low Risk
    MissingSettleByDateExample:
      summary: Missing parameter (settleByDate)
      value:
        code: 10009
        message: Missing parameter (settleByDate)
    InvalidConsumerPhoneExample:
      value:
        code: '10100'
        message: Invalid format for field consumer.phone.
    MissingSettlementAmountExample:
      summary: Missing parameter (settlementAmount)
      value:
        code: 10009
        message: Missing parameter (settlementAmount)
    PaymentSuccessIndicatorsFailureResponseExample:
      value:
        payRequestId: '476412776235977427'
        status: FAILURE
        customerId: '1005061234'
        accountId: '20050961233'
        requestDate: '2025-04-24'
        transaction:
          settleByDate: '2025-04-25'
          amount: 12.98
        nsfReturnRisk:
          error:
            code: 185
            status: '500'
            message: MFA Required
        unauthorizedReturnRisk:
          error:
            code: 185
            status: '500'
            message: MFA Required
    AccountTypeNotSupportedExample:
      value:
        code: '14020'
        message: Bad request. (Account type not supported).
    PaymentSuccessIndicatorsInProgressResponseExample:
      value:
        payRequestId: '476412776235977427'
        status: IN PROGRESS
        customerId: '1005061234'
        accountId: '20050961233'
        requestDate: '2025-04-24'
        transaction:
          settleByDate: '2025-04-25'
          amount: 12.98
    PermissiblePurposeCodeExample:
      value:
        code: '10100'
        status: '400'
        message: Permissible Purpose Code is required
    PaymentSuccessIndicatorExample:
      value:
        customerId: '453752752892'
        accountId: '453752772892'
        payReqId: '484265782033818817'
        settleByDate: '2023-06-07'
        settlementAmount: 10.05
        availableBalance: 823.32
        indicatorsByDay:
        - potentialSettlementDate: '2023-06-07'
          compositeScore: 7
          scoreIndicator: Less Likely to Settle
          reasons:
            recentBalance: 12
            balanceHistory: 23
            nsfHistory: 40
            recentNsfHistory: 78
            recurringNsf: 34
            spendHistory: 44
            depositHistory: 10
            transactionAmount: 65
        - potentialSettlementDate: '2023-06-08'
          compositeScore: 6
          scoreIndicator: Less Likely to Settle
          reasons:
            recentBalance: 12
            balanceHistory: 23
            nsfHistory: 40
            recentNsfHistory: 78
            recurringNsf: 34
            spendHistory: 44
            depositHistory: 10
            transactionAmount: 65
        - potentialSettlementDate: '2023-06-09'
          compositeScore: 5
          scoreIndicator: Less Likely to Settle
          reasons:
            recentBalance: 12
            balanceHistory: 23
            nsfHistory: 40
            recentNsfHistory: 78
            recurringNsf: 34
            spendHistory: 44
            depositHistory: 10
            transactionAmount: 65
    InactiveAccountExample:
      value:
        code: '10013'
        message: Only active accounts can be used, please use a different account
    InvalidPurposeCodeExample:
      value:
        code: '10005'
        message: invalid purpose code
    ResellerPartnerNotAuthorizedExample:
      value:
        code: '10100'
        message: 'RESELLER_BILLING_REPORT: Partner is not authorized to access resellerBilling reports for partnerId 2445583947903'
    CustomerReportLimitExceedExample:
      value:
        code: '20400'
        message: The max report generation limit was exceeded for this customer.
    InvalidAccountIdExample:
      value:
        code: '38003'
        message: customer does not have given account (customerId = 6018989036,    accountId = [6024048234])
    InvalidExperienceFieldExample:
      value:
        code: '10010'
        status: '400'
        message: '"experience" must be a valid GUID'
        user_message: One or more of the fields could not be validated. Please ensure you have entered the correct data.
        tags: ''
    AccountHasNoTransactionExample:
      value:
        code: '10008'
        message: account has no transactions
    NoConsumerForCustomerExample:
      value:
        code: '10100'
        message: Cannot find consumer for customer with id 5011115315."
    MissingFinicityAppTokenExample:
      value:
        code: '10024'
        message: Missing parameter (Finicity-App-Token)
  responses:
    NotAllowedErrorResponse:
      description: Not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            NotAllowedErrorResponseExample:
              $ref: '#/components/examples/NotAllowedErrorResponseExample'
    GetPaymentSuccessIndicatorBadRequestResponse:
      description: The request was rejected
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            GenericBadRequestExample:
              $ref: '#/components/examples/GenericBadRequestExample'
            MissingSettleByDateExample:
              $ref: '#/components/examples/MissingSettleByDateExample'
            MissingSettlementAmountExample:
              $ref: '#/components/examples/MissingSettlementAmountExample'
            InvalidSettleByDateExample:
              $ref: '#/components/examples/InvalidSettleByDateExample'
            IncorrectFieldTypeExample:
              $ref: '#/components/examples/IncorrectFieldTypeExample'
            AccountHasNoTransactionExample:
              $ref: '#/components/examples/AccountHasNoTransactionExample'
            RequiredFieldParameterExample:
              $ref: '#/components/examples/RequiredFieldParameterExample'
            InactiveAccountExample:
              $ref: '#/components/examples/InactiveAccountExample'
    BadRequestErrorResponse:
      description: The request was rejected
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            PermissiblePurposeCodeExample:
              $ref: '#/components/examples/PermissiblePurposeCodeExample'
            InvalidForesightReportRequestExample:
              $ref: '#/components/examples/InvalidForesightReportRequestExample'
            BothCraAndFtcPurposeTrueExample:
              $ref: '#/components/examples/BothCraAndFtcPurposeTrueExample'
            MissingFieldExample:
              $ref: '#/components/examples/MissingFieldExample'
            InvalidFieldExample:
              $ref: '#/components/examples/InvalidFieldExample'
            InvalidExperienceFieldExample:
              $ref: '#/components/examples/InvalidExperienceFieldExample'
            GenericBadRequestExample:
              $ref: '#/components/examples/GenericBadRequestExample'
            AccountTypeNotSupportedExample:
              $ref: '#/components/examples/AccountTypeNotSupportedExample'
            ResellerPartnerNotAuthorizedExample:
              $ref: '#/components/examples/ResellerPartnerNotAuthorizedExample'
            ResellerInvalidDateRangeExample:
              $ref: '#/components/examples/ResellerInvalidDateRangeExample'
            ResellerInvalidDateRangeLessThanZeroExample:
              $ref: '#/components/examples/ResellerInvalidDateRangeLessThanZeroExample'
            ResellerInvalidDateRangeGreaterThanEndDateExample:
              $ref: '#/components/examples/ResellerInvalidDateRangeGreaterThanEndDateExample'
            ResellerInvalidDateRangeGreaterThan31DaysExample:
              $ref: '#/components/examples/ResellerInvalidDateRangeGreaterThan31DaysExample'
            CustomerReportLimitExceedExample:
              $ref: '#/components/examples/CustomerReportLimitExceedExample'
            InvalidConsumerSSNExample:
              $ref: '#/components/examples/InvalidConsumerSSNExample'
            InvalidConsumerPhoneExample:
              $ref: '#/components/examples/InvalidConsumerPhoneExample'
            InvalidConsumerEmailExample:
              $ref: '#/components/examples/InvalidConsumerEmailExample'
            InvalidValue:
              $ref: '#/components/examples/InvalidValueExample'
    ForbiddenErrorResponse:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            ForbiddenErrorResponseExample:
              $ref: '#/components/examples/ForbiddenErrorResponseExample'
    GeneratePaymentSuccessIndicatorsResponse:
      description: Successfully requested to generate a Payment Success Indicators score
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentSuccessIndicators'
          examples:
            PaymentSuccessIndicatorsInProgressResponseExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorsInProgressResponseExample'
    GetPaymentSuccessIndicatorResponse:
      description: The payment success indicator was successfully retrieved
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentSuccessIndicator'
          examples:
            PaymentSuccessIndicatorExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorExample'
            PaymentSuccessIndicatorWarningExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorWarningExample'
    UnauthorizedErrorResponse:
      description: The request lacks valid authentication credentials. Check "Finicity-App-Key" or "Finicity-App-Token".
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            ExpiredTokenExample:
              $ref: '#/components/examples/ExpiredTokenExample'
            MissingFinicityAppKeyExample:
              $ref: '#/components/examples/MissingFinicityAppKeyExample'
            MissingFinicityAppTokenExample:
              $ref: '#/components/examples/MissingFinicityAppTokenExample'
            InvalidFinicityAppTokenExample:
              $ref: '#/components/examples/InvalidFinicityAppTokenExample'
            ExpiredFinicityAppTokenExample:
              $ref: '#/components/examples/ExpiredFinicityAppTokenExample'
            BadCredentialsExample:
              $ref: '#/components/examples/BadCredentialsExample'
        text/plain:
          schema:
            type: string
            example: Invalid (Finicity-App-Key)
    GetPaymentSuccessIndicatorFcraBadRequestResponse:
      description: The request was rejected
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            GenericBadRequestExample:
              $ref: '#/components/examples/GenericBadRequestExample'
            MissingSettleByDateExample:
              $ref: '#/components/examples/MissingSettleByDateExample'
            MissingSettlementAmountExample:
              $ref: '#/components/examples/MissingSettlementAmountExample'
            InvalidPurposeCodeExample:
              $ref: '#/components/examples/InvalidPurposeCodeExample'
            InvalidSettleByDateExample:
              $ref: '#/components/examples/InvalidSettleByDateExample'
            IncorrectFieldTypeExample:
              $ref: '#/components/examples/IncorrectFieldTypeExample'
            AccountHasNoTransactionExample:
              $ref: '#/components/examples/AccountHasNoTransactionExample'
            RequiredFieldParameterExample:
              $ref: '#/components/examples/RequiredFieldParameterExample'
            InactiveAccountExample:
              $ref: '#/components/examples/InactiveAccountExample'
            MissingEmailExample:
              $ref: '#/components/examples/MissingEmailExample'
    RetrieveFcraPaymentSuccessIndicatorsResponse:
      description: Successfully requested to retrieve a Payment Success Indicators score
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FcraPaymentSuccessIndicators'
          examples:
            PaymentSuccessIndicatorsNoReasonsSuccessResponseExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorsNoReasonsSuccessResponseExample'
            PaymentSuccessIndicatorsSuccessResponseExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorsSuccessResponseExample'
            PaymentSuccessIndicatorsInProgressResponseExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorsInProgressResponseExample'
            PaymentSuccessIndicatorsFailureResponseExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorsFailureResponseExample'
    RetrievePaymentSuccessIndicatorsResponse:
      description: Successfully requested to retrieve a Payment Success Indicators score
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentSuccessIndicators'
          examples:
            PaymentSuccessIndicatorsNoReasonsSuccessResponseExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorsNoReasonsSuccessResponseExample'
            PaymentSuccessIndicatorsSuccessResponseExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorsSuccessResponseExample'
            PaymentSuccessIndicatorsInProgressResponseExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorsInProgressResponseExample'
            PaymentSuccessIndicatorsFailureResponseExample:
              $ref: '#/components/examples/PaymentSuccessIndicatorsFailureResponseExample'
    ResourceNotFoundErrorResponse:
      description: The resource doesn't exist
      content:
        application/json:
          schema:
   

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finicity/refs/heads/main/openapi/finicity-payment-success-indicator-api-openapi.yml