Ordo

Ordo Account Data - Client Hosted API

The Account Data - Client Hosted API from Ordo — 9 operation(s) for account data - client hosted.

GitHub OpenAPI

Operations 10

GET /account/information/institutions Gets a list of AIS enabled institutions #
POST /account/information/create Creates a new AIS request #
POST /account/information/data Execute a data request using an AIS consent #
GET /account/information/data Gets transaction data held in storage #
GET /account/information/consents Gets all AIS consents associated with a participant #
POST /account/information/cancel Cancels an AIS Request #
GET /account/information/data/request/{aisDataRequestId} Gets a data request #
GET /account/information/data/requests/{aisConsentId} Gets data requests for AIS consent and Participant #
POST /account/information/initiate Creates an AIS consent at the bank, and returns the authorisation URL #

Documentation

📖
Documentation
https://ordopay.com/products/payments
📖
APIReference
https://docs.myordo.com/docs/introduction-single-payments
📖
Documentation
https://ordopay.com/products/vrp
📖
APIReference
https://docs.myordo.com/docs/introduction-recurring-payment-mandates
📖
Documentation
https://ordopay.com/products/account/data
📖
APIReference
https://docs.myordo.com/docs/introduction-account-data
📖
Documentation
https://ordopay.com/products/account/verify
📖
APIReference
https://docs.myordo.com/docs/client-hosted-account-data
📖
APIReference
https://docs.myordo.com/docs/financial-institution

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ordo/refs/heads/main/openapi/ordo-account-data-client-hosted-api-openapi.yml

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/ordo/refs/heads/main/apis.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/ordo-account-data-client-hosted-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

ordo-account-data-client-hosted-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Account Data - Client Hosted API
  version: '1.0'
servers:
- url: https://test.api.ordopay.com/client
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Account Data - Client Hosted
paths:
  /account/information/institutions:
    get:
      tags:
      - Account Data - Client Hosted
      summary: Gets a list of AIS enabled institutions
      description: Gets a list of AIS enabled institutions
      operationId: get-account-information-institutions
      parameters:
      - name: OrdoInstitutionId
        in: query
        schema:
          maxLength: 50
          minLength: 0
          type: string
      - name: Permissions
        in: query
        schema:
          type: array
          items:
            type: string
      - name: participantId
        in: header
        description: Format - int32. Participant ID in the header
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/InstitutionResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/InstitutionResponse'
              example:
                ordoInstitutionId: string
                name: string
                media:
                  iconUrl: string
                  logoUrl: string
                refundDataAvailable: true
                aisEnabled: true
                features:
                - string
            text/json:
              schema:
                $ref: '#/components/schemas/InstitutionResponse'
              example:
                ordoInstitutionId: string
                name: string
                media:
                  iconUrl: string
                  logoUrl: string
                refundDataAvailable: true
                aisEnabled: true
                features:
                - string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /account/information/create:
    post:
      tags:
      - Account Data - Client Hosted
      summary: Creates a new AIS request
      description: Creates a new AIS request
      operationId: post-account-information-create
      parameters:
      - name: participantId
        in: header
        description: Format - int32. Participant ID in the header
        required: true
        schema:
          type: integer
      requestBody:
        description: Parameters for a new AIS request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAISConsentRequest'
            example:
              consentName: string
              merchantReference: string
              payerAliasType: EMAIL
              payerAliasValue: string
              ordoInstitutionId: string
              permissions:
              - string
              redirectURL: string
              cancelURL: string
              errorURL: string
              expiryDate: string
          text/json:
            schema:
              $ref: '#/components/schemas/CreateAISConsentRequest'
            example:
              consentName: string
              merchantReference: string
              payerAliasType: EMAIL
              payerAliasValue: string
              ordoInstitutionId: string
              permissions:
              - string
              redirectURL: string
              cancelURL: string
              errorURL: string
              expiryDate: string
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateAISConsentRequest'
            example:
              consentName: string
              merchantReference: string
              payerAliasType: EMAIL
              payerAliasValue: string
              ordoInstitutionId: string
              permissions:
              - string
              redirectURL: string
              cancelURL: string
              errorURL: string
              expiryDate: string
      responses:
        '201':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateAISConsentResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAISConsentResponse'
              example:
                aisAuthUrl: string
                aisConsent:
                  aisConsentId: string
                  status: INITIATED
                  consentName: string
                  merchantReference: string
                  participantId: 0
                  payerAliasType: string
                  payerAliasValue: string
                  ordoInstitutionId: string
                  permissions:
                  - string
                  redirectURL: string
                  cancelURL: string
                  errorURL: string
                  expiryDate: string
                  createdDate: string
                  cancelledBy: string
            text/json:
              schema:
                $ref: '#/components/schemas/CreateAISConsentResponse'
              example:
                aisAuthUrl: string
                aisConsent:
                  aisConsentId: string
                  status: INITIATED
                  consentName: string
                  merchantReference: string
                  participantId: 0
                  payerAliasType: string
                  payerAliasValue: string
                  ordoInstitutionId: string
                  permissions:
                  - string
                  redirectURL: string
                  cancelURL: string
                  errorURL: string
                  expiryDate: string
                  createdDate: string
                  cancelledBy: string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /account/information/data:
    post:
      tags:
      - Account Data - Client Hosted
      summary: Execute a data request using an AIS consent
      description: Execute a data request using an AIS consent
      operationId: post-account-information-data
      parameters:
      - name: participantId
        in: header
        description: Format - int32. Participant ID in the header
        required: true
        schema:
          type: integer
      requestBody:
        description: AIS consent ID
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AISExecuteDataRequest'
            example:
              aisConsentId: string
              merchantReference: string
              fromDate: string
              toDate: string
          text/json:
            schema:
              $ref: '#/components/schemas/AISExecuteDataRequest'
            example:
              aisConsentId: string
              merchantReference: string
              fromDate: string
              toDate: string
          application/*+json:
            schema:
              $ref: '#/components/schemas/AISExecuteDataRequest'
            example:
              aisConsentId: string
              merchantReference: string
              fromDate: string
              toDate: string
      responses:
        '201':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AISExecuteDataResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/AISExecuteDataResponse'
              example:
                aisDataRequestId: string
            text/json:
              schema:
                $ref: '#/components/schemas/AISExecuteDataResponse'
              example:
                aisDataRequestId: string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
    get:
      tags:
      - Account Data - Client Hosted
      summary: Gets transaction data held in storage
      description: Gets transaction data held in storage
      operationId: get-account-information-data-aisdatarequestid-aisdatarequestid
      parameters:
      - name: AISDataRequestId
        in: query
        required: true
        schema:
          type: string
      - name: PageNumber
        in: query
        description: Format - int32.
        schema:
          type: integer
          format: int32
      - name: PageSize
        in: query
        description: Format - int32.
        schema:
          type: integer
          format: int32
      - name: participantId
        in: header
        description: Format - int32. Participant ID in the header
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AccountTransactionResponses'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/AccountTransactionResponses'
              example:
                accountTransactions:
                - AccountId: {}
                  TransactionId: {}
                  TransactionReference: {}
                  StatementReference:
                  - {}
                  CreditDebitIndicator: string
                  Status: string
                  TransactionMutability: string
                  BookingDateTime: {}
                  ValueDateTime: {}
                  TransactionInformation: {}
                  AddressLine: {}
                  Amount:
                    Amount: {}
                    Currency: {}
                  ChargeAmount:
                    Amount: {}
                    Currency: {}
                  CurrencyExchange:
                    SourceCurrency: string
                    TargetCurrency: string
                    UnitCurrency: string
                    ExchangeRate: 0
                    ContractIdentification: string
                    QuotationDate: string
                    InstructedAmount:
                      Amount: {}
                      Currency: {}
                  BankTransactionCode:
                    Code: string
                    SubCode: string
                  ProprietaryBankTransactionCode:
                    Code: string
                    Issuer: string
                  Balance:
                    CreditDebitIndicator: string
                    Type: string
                    Amount:
                      Amount: {}
                      Currency: {}
                  MerchantDetails:
                    MerchantName: string
                    MerchantCategoryCode: string
                  CreditorAgent:
                    SchemeName: {}
                    Identification: {}
                    Name: {}
                    PostalAddress:
                      AddressType: string
                      Department: string
                      SubDepartment: string
                      StreetName: {}
                      BuildingNumber: {}
                      PostCode: {}
                      TownName: {}
                      CountrySubDivision: string
                      Country: string
                      AddressLine:
                      - string
                  CreditorAccount:
                    SchemeName: {}
                    Identification: {}
                    Name: {}
                    SecondaryIdentification: {}
                  DebtorAgent:
                    SchemeName: {}
                    Identification: {}
                    Name: {}
                    PostalAddress:
                      AddressType: string
                      Department: string
                      SubDepartment: string
                      StreetName: {}
                      BuildingNumber: {}
                      PostCode: {}
                      TownName: {}
                      CountrySubDivision: string
                      Country: string
                      AddressLine:
                      - string
                  DebtorAccount:
                    SchemeName: {}
                    Identification: {}
                    Name: {}
                    SecondaryIdentification: {}
                  CardInstrument:
                    CardSchemeName: string
                    AuthorisationType: string
                    Name: string
                    Identification: string
                  SupplementaryData: {}
                paging:
                  totalRecords: 0
                  currentPage: 0
                  totalPages: 0
                  nextPage: 0
                  previousPage: 0
            text/json:
              schema:
                $ref: '#/components/schemas/AccountTransactionResponses'
              example:
                accountTransactions:
                - AccountId: {}
                  TransactionId: {}
                  TransactionReference: {}
                  StatementReference:
                  - {}
                  CreditDebitIndicator: string
                  Status: string
                  TransactionMutability: string
                  BookingDateTime: {}
                  ValueDateTime: {}
                  TransactionInformation: {}
                  AddressLine: {}
                  Amount:
                    Amount: {}
                    Currency: {}
                  ChargeAmount:
                    Amount: {}
                    Currency: {}
                  CurrencyExchange:
                    SourceCurrency: string
                    TargetCurrency: string
                    UnitCurrency: string
                    ExchangeRate: 0
                    ContractIdentification: string
                    QuotationDate: string
                    InstructedAmount:
                      Amount: {}
                      Currency: {}
                  BankTransactionCode:
                    Code: string
                    SubCode: string
                  ProprietaryBankTransactionCode:
                    Code: string
                    Issuer: string
                  Balance:
                    CreditDebitIndicator: string
                    Type: string
                    Amount:
                      Amount: {}
                      Currency: {}
                  MerchantDetails:
                    MerchantName: string
                    MerchantCategoryCode: string
                  CreditorAgent:
                    SchemeName: {}
                    Identification: {}
                    Name: {}
                    PostalAddress:
                      AddressType: string
                      Department: string
                      SubDepartment: string
                      StreetName: {}
                      BuildingNumber: {}
                      PostCode: {}
                      TownName: {}
                      CountrySubDivision: string
                      Country: string
                      AddressLine:
                      - string
                  CreditorAccount:
                    SchemeName: {}
                    Identification: {}
                    Name: {}
                    SecondaryIdentification: {}
                  DebtorAgent:
                    SchemeName: {}
                    Identification: {}
                    Name: {}
                    PostalAddress:
                      AddressType: string
                      Department: string
                      SubDepartment: string
                      StreetName: {}
                      BuildingNumber: {}
                      PostCode: {}
                      TownName: {}
                      CountrySubDivision: string
                      Country: string
                      AddressLine:
                      - string
                  DebtorAccount:
                    SchemeName: {}
                    Identification: {}
                    Name: {}
                    SecondaryIdentification: {}
                  CardInstrument:
                    CardSchemeName: string
                    AuthorisationType: string
                    Name: string
                    Identification: string
                  SupplementaryData: {}
                paging:
                  totalRecords: 0
                  currentPage: 0
                  totalPages: 0
                  nextPage: 0
                  previousPage: 0
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value

# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ordo/refs/heads/main/openapi/ordo-account-data-client-hosted-api-openapi.yml