Returns data about whether Finicity is connected or not

API Method: GET /api/v1/getAccountConnectivityStatus

Description:

This API endpoint is used to retrieve the connectivity status of a merchant's account with Finicity, a third-party financial data aggregator. It checks whether the merchant’s bank account is successfully connected through Finicity, which is required for certain banking and payment processing services. This endpoint provides a quick status check on whether the necessary financial data integration is in place.

Request:

• HTTP Method: GET
• Endpoint: /api/v1/getAccountConnectivityStatus

Query Parameters:

• id (required):
  A unique identifier for the merchant or account whose Finicity connectivity status is being queried.
  • Type: String
  • Example: id=12345ABC

Response:

• Status Code:

  • 200 OK: If the account connectivity status is successfully retrieved.
  • 400 Bad Request: If the id parameter is missing or invalid.
  • 404 Not Found: If no connectivity data is found for the given id.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response will return the connectivity status information in JSON format. It will indicate whether the merchant’s bank account is connected with Finicity or if further actions are required to establish the connection.

Response Fields:

• id: The unique identifier for the merchant or account being queried.

  • Type: String
  • Example: "id": "12345ABC"

• connectivityStatus: The current connectivity status with Finicity.

  • Type: String
  • Accepted Values:
    • connected: The account is successfully connected to Finicity.
    • disconnected: The account is not connected, and action is required.
    • pending: The connection is in progress but not yet completed.
  • Example: "connectivityStatus": "connected"

• lastChecked: The timestamp of the last connectivity check.

  • Type: date-time (ISO 8601 format)
  • Example: "lastChecked": "2024-10-17T13:45:00Z"

Example Request:

GET /api/v1/getAccountConnectivityStatus?id=12345ABC

#### Use Case:
This API method is useful for ISO/ISV to verify the status of the connection between a merchant’s bank account and Finicity. Ensuring this connection is critical for secure and smooth financial data exchanges necessary for payment processing, account verification, and other banking services.