Yapily
Yapily Data Access API (AIS)

Account Information Service Provider (AISP) endpoints for retrieving accounts, balances, transactions, identity, beneficiaries, scheduled payments, standing orders, direct debits, and statements with active end-user consent. Supports cursor pagination on transactions.
Yapily Data Access API (AIS) is one of 9 APIs that Yapily publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 machine-runnable capability that can be deployed as REST, MCP, or Agent Skill surfaces via Naftiko and 4 JSON Schema definitions.
Tagged areas include Account Information, AISP, Accounts, Balances, and Transactions. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, a JSON-LD context, sample payloads, 1 Naftiko capability spec, and 4 JSON Schemas.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.1
info:
  title: Yapily Data Access API (AIS)
  description: Account Information Service Provider (AISP) endpoints for retrieving accounts, balances, transactions, identity,
    beneficiaries, scheduled payments, standing orders, direct debits, and statements with user consent.
  version: 12.4.0
  contact:
    name: Yapily Support
    url: https://docs.yapily.com/resources/support
    email: [email protected]
servers:
- url: https://api.yapily.com
security:
- basicAuth: []
tags:
- description: In order to access a user's Financial Data, you are required to request an [Authorisation](#tag/Authorisations)
    from the user to share the account information the bank has. Once a `consent-token` is obtained, you can call the necessary
    Financial Data endpoint(s) to retrieve the user's data.
  name: Financial Data
paths:
  /accounts:
    get:
      description: 'Returns all accounts and balances for the end user associated with the presented consent token.


        Feature: `ACCOUNTS`'
      operationId: getAccounts
      x-mint:
        content: '<Info>Learn more: [Balance Types](/data/financial-data-resources/accounts-and-balances#balance-types)</Info>'
      parameters:
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a personal account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a business account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-corporate-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. The IP address of the PSU. \n\nSee [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers)\
          \ to see if this header is required."
        in: header
        name: psu-ip-address
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                OBIE Example Response:
                  $ref: '#/components/examples/obie-example-accounts-response'
              schema:
                $ref: '#/components/schemas/AccountApiListResponse'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Accounts
      tags:
      - Financial Data
  /accounts/{accountId}:
    get:
      description: 'Returns the account and balance information for a user''s specified account.


        Feature: `ACCOUNT`'
      operationId: getAccount
      x-mint:
        content: '<Info>Learn more: [Main Balance Selection](/data/financial-data-resources/accounts-and-balances#main-balance)</Info>'
      parameters:
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a personal account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a business account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-corporate-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. The IP address of the PSU. \n\nSee [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers)\
          \ to see if this header is required."
        in: header
        name: psu-ip-address
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                OBIE Example Response:
                  $ref: '#/components/examples/obie-example-account-response'
              schema:
                $ref: '#/components/schemas/ApiResponseOfAccount'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account
      tags:
      - Financial Data
  /accounts/{accountId}/balances:
    get:
      description: 'Returns the balance for the end user associated with the presented consent token.


        Feature: `ACCOUNT_BALANCES`'
      operationId: getAccountBalances
      parameters:
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a personal account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a business account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-corporate-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. The IP address of the PSU. \n\nSee [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers)\
          \ to see if this header is required."
        in: header
        name: psu-ip-address
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                Example response:
                  $ref: '#/components/examples/example-acc-balance-response'
              schema:
                $ref: '#/components/schemas/ApiResponseOfBalances'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account Balances
      tags:
      - Financial Data
      x-mint:
        content: '<Info>Learn more: [Balance Types](/data/financial-data-resources/accounts-and-balances#balance-types) explained</Info>'
  /accounts/{accountId}/beneficiaries:
    get:
      description: 'Returns all the beneficiaries of a user''s account.


        Feature: `ACCOUNT_BENEFICIARIES`'
      operationId: getBeneficiaries
      parameters:
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                OBIE Example Response:
                  $ref: '#/components/examples/obie-example-acc-beneficiaries-response'
              schema:
                $ref: '#/components/schemas/ApiListResponseOfBeneficiary'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account Beneficiaries
      tags:
      - Financial Data
      x-mint:
        content: '<Info>Learn more: [Data Access Restrictions](/data/financial-data-resources/data-restrictions#uk-banks)</Info>'
  /accounts/{accountId}/direct-debits:
    get:
      description: 'Returns the list of direct debits for an account.


        Feature: `ACCOUNT_DIRECT_DEBITS`'
      operationId: getAccountDirectDebits
      parameters:
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      - description: __Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                OBIE Example Response:
                  $ref: '#/components/examples/obie-example-acc-direct-debits-response'
              schema:
                $ref: '#/components/schemas/ApiListResponseOfDirectDebitResponse'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account Direct Debits
      tags:
      - Financial Data
      x-mint:
        content: '<Info>Learn more: [Data Access Restrictions](/data/financial-data-resources/data-restrictions#uk-banks)</Info>'
  /accounts/{accountId}/periodic-payments:
    get:
      description: 'Returns the list of periodic payments (standing orders in the UK) for an account.


        Feature: `ACCOUNT_PERIODIC_PAYMENTS`'
      operationId: getAccountPeriodicPayments
      parameters:
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      - description: __Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                OBIE Example Response:
                  $ref: '#/components/examples/obie-example-acc-periodic-payments-response'
              schema:
                $ref: '#/components/schemas/ApiListResponseOfPaymentResponse'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account Periodic Payments
      tags:
      - Financial Data
      x-mint:
        content: '<Info>Learn more: [Data Access Restrictions](/data/financial-data-resources/data-restrictions#uk-banks)</Info>'
  /accounts/{accountId}/scheduled-payments:
    get:
      description: 'Returns the list of scheduled payments for an account.


        Feature: `ACCOUNT_SCHEDULED_PAYMENTS`'
      operationId: getAccountScheduledPayments
      parameters:
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      - description: __Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                OBIE Example Response:
                  $ref: '#/components/examples/obie-example-acc-scheduled-payments-response'
              schema:
                $ref: '#/components/schemas/ApiListResponseOfPaymentResponse'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account Scheduled Payments
      tags:
      - Financial Data
      x-mint:
        content: '<Info>Learn more: [Data Access Restrictions](/data/financial-data-resources/data-restrictions#uk-banks)</Info>'
  /accounts/{accountId}/statements:
    get:
      description: 'Returns the list of statements for an account.


        Feature: `ACCOUNT_STATEMENTS`'
      operationId: getStatements
      parameters:
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      - description: '__Optional__. Returned transactions will be on or after this date (yyyy-MM-dd''T''HH:mm:ss.SSSZ). '
        in: query
        name: from
        required: false
        schema:
          type: string
      - description: __Optional__. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
        in: query
        name: before
        required: false
        schema:
          type: string
      - description: __Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int32
      - description: __Optional__. Sort transaction records by date ascending with 'date' or descending with '-date'. The
          default sort order is descending
        in: query
        name: sort
        required: false
        schema:
          $ref: '#/components/schemas/SortEnum'
      - description: __Optional__. The number of transaction records to be skipped. Used primarily with paginated results.
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                Example Response:
                  $ref: '#/components/examples/account-statements-example-response'
              schema:
                $ref: '#/components/schemas/ApiListResponseOfAccountStatement'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account Statements
      tags:
      - Financial Data
      x-mint:
        content: '<Info>Learn more: [Financial Data Features](/data/financial-data-resources/financial-data-features) for
          statement availability</Info>'
  /accounts/{accountId}/statements/{statementId}:
    get:
      description: 'Returns a statement for an account.


        Feature: `ACCOUNT_STATEMENT`'
      operationId: getStatement
      parameters:
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        in: header
        name: consent
        required: true
        schema:
          type: string
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The statement Id of the statement file.
        in: path
        name: statementId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                Example Response:
                  description: Example Response
                  value:
                    meta:
                      tracingId: 8bacaae3025647efa1891157993e32fb
                    data:
                      id: '700014000000000000000002'
                      startDateTime: '2017-08-01T00:00:00Z'
                      endDateTime: '2017-08-31T23:59:59Z'
                      creationDateTime: '2017-09-01T00:00:00Z'
              schema:
                $ref: '#/components/schemas/ApiResponseOfAccountStatement'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account Statement
      tags:
      - Financial Data
      x-mint:
        content: '<Info>Learn more: [Financial Data Features](/data/financial-data-resources/financial-data-features)</Info>'
  /accounts/{accountId}/statements/{statementId}/file:
    get:
      description: 'Returns a PDF file of a statement for an account.


        Feature: `ACCOUNT_STATEMENT_FILE`'
      operationId: getStatementFile
      parameters:
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The statement Id of the statement file.
        in: path
        name: statementId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      responses:
        '200':
          content:
            application/pdf:
              schema:
                type: string
                format: binary
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account Statement File
      tags:
      - Financial Data
      x-mint:
        content: '<Info>Learn more: [Financial Data Features](/data/financial-data-resources/financial-data-features)</Info>'
  /accounts/{accountId}/transactions:
    get:
      description: 'Returns the account transactions for an account.


        Feature: `ACCOUNT_TRANSACTIONS`'
      operationId: getTransactions
      x-mint:
        content: '<Info>Learn more: [Pagination](/data/financial-data-resources/pagination) for handling large transaction
          sets (1000 limit default)</Info>'
      parameters:
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a personal account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a business account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-corporate-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. The IP address of the PSU. \n\nSee [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers)\
          \ to see if this header is required."
        in: header
        name: psu-ip-address
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      - description: '__Optional__. Returned transactions will be on or after this date (yyyy-MM-dd''T''HH:mm:ss.SSSZ). '
        in: query
        name: from
        required: false
        schema:
          type: string
      - description: __Optional__. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
        in: query
        name: before
        required: false
        schema:
          type: string
      - description: __Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int32
      - description: __Optional__. Sort transaction records by date ascending with 'date' or descending with '-date'. The
          default sort order is descending
        in: query
        name: sort
        required: false
        schema:
          $ref: '#/components/schemas/SortEnum'
      - description: __Optional__. The number of transaction records to be skipped. Used primarily with paginated results.
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int32
      - description: __Optional__. This property is not currently in use.
        in: query
        name: cursor
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                Example Response:
                  $ref: '#/components/examples/account-transactions-example-response'
              schema:
                $ref: '#/components/schemas/ApiListResponseOfTransaction'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Account Transactions
      tags:
      - Financial Data
  /identity:
    get:
      description: 'Returns the identity information for an account.


        Feature: `IDENTITY`'
      operationId: getIdentity
      parameters:
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                Example Response:
                  $ref: '#/components/examples/identity-example-response'
              schema:
                $ref: '#/components/schemas/ApiResponseOfIdentity'
          description: Ok
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Identity
      tags:
      - Financial Data
      x-mint:
        content: '<Info>Learn more: [Data Access Restrictions](/data/financial-data-resources/data-restrictions#uk-banks)</Info>'
  /accounts/{accountId}/real-time/transactions:
    get:
      description: 'Used to get the account transactions for an account in real time with cursor pagination


        Feature: `ACCOUNT_TRANSACTIONS`'
      operationId: getRealTimeTransactions
      x-mint:
        content: '<Info>Learn more: [Cursor-based Pagination](/data/financial-data-resources/pagination#cursor-based-pagination)
          - This endpoint uses cursor pagination (beta)</Info>'
      x-beta: true
      parameters:
      - description: __Mandatory__. The account Id of the user's bank account.
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent
        required: true
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a personal account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. Represents the user's login ID for the `Institution` to a business account. \n\nSee\
          \ [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required."
        in: header
        name: psu-corporate-id
        required: false
        schema:
          type: string
      - description: "__Conditional__. The IP address of the PSU. \n\nSee [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers)\
          \ to see if this header is required."
        in: header
        name: psu-ip-address
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      - description: __Optional__. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
        in: query
        name: from
        required: false
        schema:
          type: string
      - description: __Optional__. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
        in: query
        name: before
        required: false
        schema:
          type: string
      - description: __Optional__. The cursor token supplied by a previous call. The cursor represents a location in the data
          set.
        in: query
        name: cursor
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                Example Response:
                  description: Example Response
                  value:
                    meta:
                      tracingId: 488ce8243ee74a378be722ffffec8f7f
                      count: 1
                    data:
                    - id: 49d6e5c6-0130-46e3-884b-1b185432d9e0
                      date: '2021-05-06T17:44:34.589Z'
                      bookingDateTime: '2021-05-06T17:44:34.589Z'
                      valueDateTime: '2021-05-06T17:44:34.589Z'
                      status: BOOKED
                      transactionAmount:
                        amount: -100.23
                        currency: GBP
                      reference: '0'
                      description: 'Debit for Payment Id: sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60'
                      transactionInformation:
                      - 'Debit for Payment Id: sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60'
                      isoBankTransactionCode:
                        domainCode:
                          code: PMNT
                          name: Payments
                        familyCode:
                          code: ICDT
                          name: Issued Credit Transfers
                        subFamilyCode:
                          code: DMCT
                          name: Domestic Credit Transfer
                      proprietaryBankTransactionCode:
                        code: PMT
                        issuer: modelo-sandbox
                      balance:
                        type: CLOSING_AVAILABLE
                        balanceAmount:
                          amount: 426.53
                          currency: GBP
                    links:
                      first: https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=aaa
                      prev: https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=bbb
                      self: https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=ccc
                      next: https://api.yapily.com/accounts/700004000000000000000002/transactions?curso

# --- truncated at 32 KB (176 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yapily/refs/heads/main/openapi/yapily-data-api-openapi.yml
Yapily Data Access API (AIS)

Documentation

Specifications

Examples

Schemas & Data

Other Resources

OpenAPI Specification
