> ## Documentation Index
> Fetch the complete documentation index at: https://developers.ingopayments.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve Account Data via Open Banking

> Retrieve detailed account information, balances, owners, or transaction history from a supported open banking provider.

<Warning>
  **Under Development — Coming Soon.** This endpoint is currently under development and is not yet available for integration. Specifications are subject to change prior to general availability. Contact your Ingo integration manager for availability updates.
</Warning>


## OpenAPI

````yaml specs/ingopay-open-banking-account.yaml POST /gateway/v1/open-banking-account
openapi: 3.0.3
info:
  title: IngoPay API — Open Banking Account Data
  description: >
    ⚠️ **Under Development — Coming Soon.** This endpoint is currently under
    development and is not yet available for integration. Specifications are
    subject to change prior to general availability.


    Retrieves account data from a supported open banking provider. Use this
    endpoint to fetch detailed account information, balances, account owner(s),
    or transaction history for an account, identified either by a
    `customer_account_token` returned from a prior Verify call or by an explicit
    provider account identifier.


    The account is identified one of two ways — provide **either**
    `customer_account_token` **or** the `account_identifier` object, never both.
    Open banking provider and the requested data type are selected via
    `open_banking_provider` and `requested_data`. The client must be configured
    to use the selected open banking provider.
  version: '1'
  contact:
    name: Ingo Money Developer Support
    url: https://developers.ingopayments.com
servers:
  - url: https://payapi-sandbox.ingo.money
    description: Sandbox
  - url: https://payapi.ingo.money
    description: Production
security:
  - HmacAuth: []
paths:
  /gateway/v1/open-banking-account:
    post:
      tags:
        - Open Banking
      summary: Retrieve account data via Open Banking
      description: >
        ⚠️ **Under Development — Coming Soon.** This endpoint is currently under
        development. Specifications are subject to change prior to general
        availability.


        Returns the requested account data, as provided by the configured open
        banking provider, for the identified account. The `requested_data` value
        selects which data set is returned: detailed account information (`1`),
        balance (`2`), owner(s) (`3`), or transaction history (`4`). When
        requesting transaction history (`4`), `from_date` and `to_date` are
        required.


        Identify the account with **either** `customer_account_token` **or** the
        `account_identifier` object — never both.
      operationId: openBankingAccount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenBankingAccountRequest'
            examples:
              detailedByToken:
                summary: Detailed account info by customer account token
                value:
                  request:
                    participant_id: '12345'
                    timestamp: '1718900000'
                  open_banking_request:
                    open_banking_provider: '6'
                    requested_data: '1'
                    customer_account_token: eyJhbGciOiJI…token…
              transactionsByIdentifier:
                summary: Transaction history by explicit Finicity identifier
                value:
                  request:
                    participant_id: '12345'
                    timestamp: '1718900000'
                  open_banking_request:
                    open_banking_provider: '6'
                    requested_data: '4'
                    from_date: '1717200000'
                    to_date: '1718900000'
                    account_identifier:
                      account_identifier_finicity:
                        customer_id: '1005061234'
                        account_id: '5012345678'
      responses:
        '200':
          description: Account data retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenBankingAccountResponse'
              example:
                request:
                  participant_id: '12345'
                  timestamp: '1718900000'
                response:
                  status: '100'
                  message: Success
                  duration: '1.842'
                open_banking:
                  open_banking_response: >-
                    { "account": { "id": "5012345678", "balance": 1542.33,
                    "type": "checking" } }
components:
  schemas:
    OpenBankingAccountRequest:
      type: object
      required:
        - request
        - open_banking_request
      properties:
        request:
          type: object
          description: >-
            Information about the API request — general information associated
            with the call to the API method.
          required:
            - participant_id
            - timestamp
          properties:
            participant_id:
              type: string
              minLength: 1
              maxLength: 5
              pattern: ^[0-9]{1,5}$
              description: Unique participant identifier assigned by Ingo.
              example: '12345'
            timestamp:
              type: string
              minLength: 1
              maxLength: 32
              pattern: ^[0-9]{1,32}$
              description: Unix timestamp of the request. Must be a valid Unix timestamp.
              example: '1718900000'
        open_banking_request:
          type: object
          description: >
            Open banking data required to access the requested information.
            Identify the account with **either** `customer_account_token` **or**
            the `account_identifier` object — never both.
          required:
            - open_banking_provider
            - requested_data
          properties:
            open_banking_provider:
              type: string
              minLength: 1
              maxLength: 5
              pattern: ^[0-9]{1,5}$
              enum:
                - '6'
              description: >
                Indicates the client's open banking services provider. Accepted
                values: `6` = Finicity. Must be a valid, supported open banking
                provider code, and the client must be configured to use the
                selected provider.
              example: '6'
            requested_data:
              type: string
              minLength: 1
              maxLength: 5
              pattern: ^[0-9]{1,5}$
              enum:
                - '1'
                - '2'
                - '3'
                - '4'
              description: >
                Indicates the specific account data to be retrieved. Accepted
                values: `1` = Detailed Account Information, `2` = Account
                Balance Information, `3` = Account Owner(s) Information, `4` =
                Account Transaction Information.
              example: '1'
            from_date:
              type: string
              minLength: 1
              maxLength: 32
              pattern: ^[0-9]{1,32}$
              description: >
                Unix timestamp representing the "from date" for the request.
                Required when `requested_data` = `4` (transaction information);
                otherwise should be excluded. Must be a valid Unix timestamp.
              example: '1717200000'
            to_date:
              type: string
              minLength: 1
              maxLength: 32
              pattern: ^[0-9]{1,32}$
              description: >
                Unix timestamp representing the "to date" for the request.
                Required when `requested_data` = `4` (transaction information);
                otherwise should be excluded. Must be a valid Unix timestamp.
              example: '1718900000'
            customer_account_token:
              type: string
              minLength: 1
              maxLength: 255
              description: >
                Value representing the account number and customer data as
                provided in the response from a previous Verify API call. Used
                to extract the data required to access the requested
                information. Provide **either** `customer_account_token` **or**
                `account_identifier` — never both. If `account_identifier` is
                provided, exclude this parameter.
              example: eyJhbGciOiJI…token…
            account_identifier:
              type: object
              description: >
                Explicit account identifier(s) provided by the client. Required
                if `customer_account_token` is not provided. If
                `customer_account_token` is provided, exclude this object.
              properties:
                account_identifier_finicity:
                  type: object
                  description: >
                    Open banking account identification for Finicity. Required
                    if the client is configured to use Finicity for open banking
                    services.
                  required:
                    - customer_id
                    - account_id
                  properties:
                    customer_id:
                      type: string
                      minLength: 1
                      maxLength: 50
                      description: Finicity customer ID.
                      example: '1005061234'
                    account_id:
                      type: string
                      minLength: 1
                      maxLength: 50
                      description: Finicity account ID.
                      example: '5012345678'
    OpenBankingAccountResponse:
      type: object
      properties:
        request:
          type: object
          description: >-
            Information about the API request — echoed general information
            associated with the call to the API method.
          properties:
            participant_id:
              type: string
              description: Unique participant identifier assigned by Ingo.
              example: '12345'
            timestamp:
              type: string
              description: Unix timestamp of the request.
              example: '1718900000'
        response:
          type: object
          description: >-
            Information about the API response — general information associated
            with the outcome of the call to the API method.
          properties:
            status:
              type: string
              description: >-
                Numeric code describing the status of the API request (e.g.
                `100` = Success).
              example: '100'
            message:
              type: string
              description: Text description associated with the status code.
              example: Success
            duration:
              type: string
              description: Time in seconds to complete the request.
              example: '1.842'
        open_banking:
          type: object
          description: >-
            Response data as provided by the applicable open banking services
            provider.
          properties:
            open_banking_response:
              type: string
              description: >
                Raw response, as provided by the open banking services provider,
                returned as a JSON string. The shape of this payload is defined
                by the provider. For Finicity, refer to the Mastercard Open
                Finance documentation for the requested data type:


                • Detailed Account Information —
                https://developer.mastercard.com/open-finance-us/documentation/api-reference/?view=api#GetCustomerAccount


                • Account Balance Information —
                https://developer.mastercard.com/open-finance-us/documentation/products/pay/account-balance/


                • Account Owner(s) Information —
                https://developer.mastercard.com/open-finance-us/documentation/products/pay/verification-account-owner/#api---get-account-owner-details


                • Account Transaction Information —
                https://developer.mastercard.com/open-finance-us/documentation/api-reference/?view=api#GetCustomerAccountTransactions
              example: >-
                { "account": { "id": "5012345678", "balance": 1542.33, "type":
                "checking" } }
  securitySchemes:
    HmacAuth:
      type: http
      scheme: hmac-sha512
      description: >-
        HMAC-SHA512 signed Authorization header. See the Authentication page for
        the complete signing guide.

````