Ordo

Ordo Account Data (Ordo Hosted) API

Ordo-hosted Account Information (AIS) and Account Verification — create and manage account information consents, request and read account data, cancel consents, and run account verification against supported institutions, with Ordo hosting the end-user authorisation UX. 13 documented operations.

GitHub OpenAPI

Documentation

📖
Documentation
https://ordopay.com/products/account/data
📖
APIReference
https://docs.myordo.com/docs/introduction-account-data

Specifications

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

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/ordo/refs/heads/main/overlays/ordo-account-data-ordo-hosted-overlay.yaml

OpenAPI Specification

ordo-account-data-ordo-hosted.yml Raw ↑ 
openapi: 3.0.1
info:
  title: ACCOUNT DATA - Ordo Hosted
  version: '1.0'
servers:
- url: https://test.api.ordopay.com/hosted
paths:
  /account/information/create:
    post:
      tags:
      - Account Data - Ordo 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 - Ordo 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 - Ordo 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: 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/consent/{aisConsentId}:
    get:
      tags:
      - Account Data - Ordo Hosted
      summary: Retrieves an existing AIS consent
      description: Retrieves an existing AIS consent
      operationId: get-account-information-consent-aisconsentid
      parameters:
      - name: aisConsentId
        in: path
        description: Consent ID specified in the route
        required: true
        schema:
          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/GetAISRequestResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/GetAISRequestResponse'
              example:
                aisConsentId: string
                billerApprovedName: string
                status: string
                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/GetAISRequestResponse'
              example:
                aisConsentId: string
                billerApprovedName: string
                status: string
                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/Pro

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