openapi: 3.2.0 info: title: Account Data - Ordo Hosted API version: '1.0' servers: - url: https://test.api.ordopay.com/hosted security: - apiKeyHeader: [] - apiKeyQuery: [] tags: - name: Account Data - Ordo 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/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/consents: get: tags: - Account Data - Ordo Hosted summary: Gets all AIS consents associated with a participant description: Returns all AIS consents associated with a participant operationId: get-account-information-consents parameters: - 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/AISRequestResponses' examples: default: value: null application/json: schema: $ref: '#/components/schemas/AISRequestResponses' example: aisRequestResponse: - 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 paging: totalRecords: 0 currentPage: 0 totalPages: 0 nextPage: 0 previousPage: 0 text/json: schema: $ref: '#/components/schemas/AISRequestResponses' example: aisRequestResponse: - 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 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/cancel: post: tags: - Account Data - Ordo Hosted summary: Cancels an AIS Request description: Cancels an AIS Request operationId: post-account-information-cancel parameters: - name: participantId in: header description: Format - int32. Participant ID in the header required: true schema: type: integer - name: aisConsentId in: header description: AIS consent ID in the header required: true schema: type: string - name: cancelledBy in: header description: The entity that cancelled the request required: true schema: enum: - MERCHANT - PAYER - ORDO - ASPSP type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/AISCancelRequestResponse' examples: default: value: null application/json: schema: $ref: '#/components/schemas/AISCancelRequestResponse' example: status: string text/json: schema: $ref: '#/components/schemas/AISCancelRequestResponse' example: status: 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/request/{aisDataRequestId}: 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-request-aisdatarequestid parameters: - name: aisDataRequestId in: path description: request ID 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/AISDataRequestResponse' examples: default: value: null application/json: schema: $ref: '#/components/schemas/AISDataRequestResponse' example: aisDataRequestId: string aisConsentId: string status: string merchantReference: string participantId: 0 institutionCode: string idempotencyId: string fromDate: string toDate: string createdDate: string createdBy: string updatedDate: string text/json: schema: $ref: '#/components/schemas/AISDataRequestResponse' example: aisDataRequestId: string aisConsentId: string status: string merchantReference: string participantId: 0 institutionCode: string idempotencyId: string fromDate: string toDate: string createdDate: string createdBy: string updatedDate: 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/requests/{aisConsentId}: get: tags: - Account Data - Ordo Hosted summary: Gets data requests for AIS consent and Participant description: Gets data requests for AIS consent and Participant operationId: get-account-information-data-requests-aisconsentid parameters: - name: aisConsentId in: path description: AIS Consent ID 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/GetAllAISDataRequestResponse' examples: default: value: null application/json: schema: $ref: '#/components/schemas/GetAllAISDataRequestResponse' example: aisDataRequestResponses: - aisDataRequestId: string aisConsentId: string status: string merchantReference: string participantId: 0 institutionCode: string idempotencyId: string fromDate: string toDate: string createdDate: string createdBy: string updatedDate: string permissionGroupings: - string text/json: schema: $ref: '#/components/schemas/GetAllAISDataRequestResponse' example: aisDataRequestResponses: - aisDataRequestId: string aisConsentId: string status: string merchantReference: string participantId: 0 institutionCode: string idempotencyId: string fromDate: string toDate: string createdDate: string createdBy: string updatedDate: string permissionGroupings: - 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 components: schemas: CurrencyExchange: type: object properties: SourceCurrency: type: - string - 'null' TargetCurrency: type: - string - 'null' UnitCurrency: type: - string - 'null' ExchangeRate: type: - number - 'null' format: double ContractIdentification: type: - string - 'null' QuotationDate: type: - string - 'null' format: date-time InstructedAmount: $ref: '#/components/schemas/Amount' additionalProperties: false GetAllAISDataRequestResponse: type: object properties: aisDataRequestResponses: type: - array - 'null' items: $ref: '#/components/schemas/AISDataRequestResponse' permissionGroupings: type: - array - 'null' items: type: string additionalProperties: false CreditorAccount: type: object properties: SchemeName: {} Identification: {} Name: {} SecondaryIdentification: {} additionalProperties: false AISRequestResponses: type: object properties: aisRequestResponse: type: - array - 'null' items: $ref: '#/components/schemas/AISRequestResponse' paging: $ref: '#/components/schemas/Paging' additionalProperties: false ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} AISCancelRequestResponse: type: object properties: status: type: - string - 'null' additionalProperties: false Amount: type: object properties: Amount: type: - string - 'null' currency: type: - string - 'null' additionalProperties: false Balance: type: object properties: creditDebitIndicator: type: - string - 'null' type: type: - string - 'null' amount: $ref: '#/components/schemas/BalanceAmount' additionalProperties: false GetAISRequestResponse: type: object properties: aisConsentId: type: - string - 'null' billerApprovedName: type: - string - 'null' status: type: - string - 'null' consentName: type: - string - 'null' merchantReference: type: - string - 'null' participantId: type: integer format: int32 payerAliasType: type: - string - 'null' payerAliasValue: type: - string - 'null' ordoInstitutionId: type: - string - 'null' permissions: type: - array - 'null' items: type: string redirectURL: type: - string - 'null' cancelURL: type: - string - 'null' errorURL: type: - string - 'null' expiryDate: type: - string - 'null' format: date-time createdDate: type: string format: date-time cancelledBy: type: - string - 'null' additionalProperties: false ProprietaryBankTransactionCode: type: object properties: code: type: - string - 'null' additionalProperties: false BankTransactionCode: type: object properties: Code: type: - string - 'null' SubCode: type: - string - 'null' additionalProperties: false AISExecuteDataRequest: required: - aisConsentId type: object properties: aisConsentId: type: string merchantReference: type: - string - 'null' fromDate: type: - string - 'null' format: date-time toDate: type: - string - 'null' format: date-time additionalProperties: false MerchantDetails: type: object properties: MerchantName: type: - string - 'null' MerchantCategoryCode: type: - string - 'null' additionalProperties: false DebtorAgent: type: object properties: SchemeName: {} Identification: {} Name: {} PostalAddress: $ref: '#/components/schemas/PostalAddress' additionalProperties: false CardInstrument: type: object properties: CardSchemeName: type: - string - 'null' AuthorisationType: type: - string - 'null' Name: type: - string - 'null' Identification: type: - string - 'null' additionalProperties: false Transaction: type: object properties: AccountId: {} TransactionId: {} TransactionReference: {} StatementReference: type: - array - 'null' items: {} CreditDebitIndicator: type: - string - 'null' Status: type: - string - 'null' TransactionMutability: type: - string - 'null' BookingDateTime: {} ValueDateTime: {} TransactionInformation: {} AddressLine: {} Amount: $ref: '#/components/schemas/Amount' ChargeAmount: $ref: '#/components/schemas/Amount' CurrencyExchange: $ref: '#/components/schemas/CurrencyExchange' BankTransactionCode: $ref: '#/components/schemas/BankTransactionCode' ProprietaryBankTransactionCode: $ref: '#/components/schemas/ProprietaryBankTransactionCode' Balance: $ref: '#/components/schemas/Balance' MerchantDetails: $ref: '#/components/schemas/MerchantDetails' CreditorAgent: $ref: '#/components/schemas/CreditorAgent' CreditorAccount: $ref: '#/components/schemas/CreditorAccount' DebtorAgent: $ref: '#/components/schemas/DebtorAgent' DebtorAccount: $ref: '#/components/schemas/DebtorAccount' CardInstrument: $ref: '#/components/schemas/CardInstrument' SupplementaryData: {} additionalProperties: false PostalAddress: type: object properties: AddressType: type: - string - 'null' Department: type: - string - 'null' SubDepartment: type: - string - 'null' StreetName: {} BuildingNumber: {} PostCode: {} TownName: {} CountrySubDivision: type: - string - 'null' Country: type: - string - 'null' AddressLine: type: - array - 'null' items: type: string additionalProperties: false CreateAISConsentRequest: required: - cancelURL - consentName - errorURL - merchantReference - permissions - redirectURL type: object properties: consentName: maxLength: 256 minLength: 0 type: string merchantReference: maxLength: 128 minLength: 0 type: string payerAliasType: $ref: '#/components/schemas/PayerAliasTypeEnum' payerAliasValue: maxLength: 350 minLength: 0 type: - string - 'null' ordoInstitutionId: maxLength: 50 minLength: 0 type: - string - 'null' permissions: minItems: 1 type: array items: type: string redirectURL: type: string cancelURL: type: string errorURL: type: string expiryDate: type: - string - 'null' format: date-time additionalProperties: false PayerAliasTypeEnum: enum: - EMAIL - PHONE type: string AccountTransactionResponses: type: object properties: accountTransactions: type: - array - 'null' items: $ref: '#/components/schemas/Transaction' paging: $ref: '#/components/schemas/Paging' additionalProperties: false Paging: type: object properties: totalRecords: type: integer format: int32 currentPage: type: integer format: int32 totalPages: type: integer format: int32 nextPage: type: - integer - 'null' format: int32 previousPage: type: - integer - 'null' format: int32 additionalProperties: false AISExecuteDataResponse: type: object properties: aisDataRequestId: type: - string - 'null' additionalProperties: false BalanceAmount: type: object properties: amount: type: - string - 'null' currency: type: - string - 'null' additionalProperties: false OrdoValidationProblemDetails: type: object properties: title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' code: type: - string - 'null' errors: type: - object - 'null' additionalProperties: type: array items: type: string readOnly: true type: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} CreditorAgent: type: object properties: SchemeName: {} Identification: {} Name: {} PostalAddress: $ref: '#/components/schemas/PostalAddress' additionalProperties: false ErrorResponse: type: object properties: errorCode: type: - string - 'null' errorMessage: type: - string - 'null' additionalProperties: false DebtorAccount: type: object properties: SchemeName: {} Identification: {} Name: {} SecondaryIdentification: {} additionalProperties: false AISDataRequestResponse: type: object properties: aisDataRequestId: type: - string - 'null' aisConsentId: type: - string - 'null' status: type: - string - 'null' merchantReference: type: - string - 'null' participantId: type: integer format: int32 institutionCode: type: - string - 'null' idempotencyId: type: - string - 'null' fromDate: type: - string - 'null' format: date-time toDate: type: - string - 'null' format: date-time createdDate: type: string format: date-time createdBy: type: - string - 'null' updatedDate: type: string format: date-time additionalProperties: false CreateAISConsentResponse: type: object properties: aisAuthUrl: type: - string - 'null' aisConsent: $ref: '#/components/schemas/AISRequestResponse' additionalProperties: false AISStatusTypeEnum: enum: - INITIATED - CANCELLED - EXPIRED - AWAITINGAUTHORISATION - AUTHORISED type: string AISRequestResponse: type: object properties: aisConsentId: type: - string - 'null' status: $ref: '#/components/schemas/AISStatusTypeEnum' consentName: type: - string - 'null' merchantReference: type: - string - 'null' participantId: type: integer format: int32 payerAliasType: type: - string - 'null' payerAliasValue: type: - string - 'null' ordoInstitutionId: type: - string - 'null' permissions: type: - array - 'null' items: type: string redirectURL: type: - string - 'null' cancelURL: type: - string - 'null' errorURL: type: - string - 'null' expiryDate: type: - string - 'null' format: date-time createdDate: type: string format: date-time cancelledBy: type: - string - 'null' additionalProperties: false securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query x-readme: explorer-enabled: true proxy-enabled: true