Spare Request API

openapi: 3.0.1
info:
  title: Information Account Request API
  description: Spare account information API documentation
  termsOfService: https://terms.tryspare.com/en
  contact:
    name: Spare Technologies WLL.
    email: hello@tryspare.com
  license:
    name: Spare Technologies WLL.
  version: '1.0'
security:
- Bearer: []
tags:
- name: Request
paths:
  /api/v1.0/ais/Request/Create:
    post:
      tags:
      - Request
      summary: Create account information access request
      description: '**Unique resource name :** ais.v1.request.create'
      requestBody:
        description: Account information access request.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AccountInformationRequestAccessModel'
          application/json:
            schema:
              $ref: '#/components/schemas/AccountInformationRequestAccessModel'
          text/json:
            schema:
              $ref: '#/components/schemas/AccountInformationRequestAccessModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AccountInformationRequestAccessModel'
        required: true
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInformationRequestAccessResponseModelApiResponse'
        '400':
          description: '- If model is not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Request/List:
    get:
      tags:
      - Request
      summary: List account information access requests
      description: '**Unique resource name :** ais.v1.request.list'
      parameters:
      - name: page
        in: query
        description: Page number
        schema:
          type: integer
          format: int32
          default: '1'
      - name: perPage
        in: query
        description: Number of items per page maximum allow is 500 per page
        schema:
          type: integer
          format: int32
          default: '20'
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInformationRequestAccessResponseModelIEnumerablePagesModelMetaApiResponse'
        '400':
          description: '- If page is not valid

            - If perPage is not valid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Request/Get:
    get:
      tags:
      - Request
      summary: Get account information access request by id
      description: '**Unique resource name :** ais.v1.request.get'
      parameters:
      - name: id
        in: query
        description: Account information access request id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInformationRequestAccessResponseModelApiResponse'
        '400':
          description: '- If id is null or an invalid UUID.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If request does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Request/Update:
    put:
      tags:
      - Request
      summary: Update account information access request
      description: '**Unique resource name :** ais.v1.request.update'
      parameters:
      - name: id
        in: query
        description: Account information access request id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Account information access request.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/UpdateAccountInformationRequestAccessModel'
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAccountInformationRequestAccessModel'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateAccountInformationRequestAccessModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateAccountInformationRequestAccessModel'
        required: true
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInformationRequestAccessResponseModelApiResponse'
        '400':
          description: '- If id is null or an invalid UUID.

            - If model is not valid.

            - If request is already approved or rejected'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If request does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Request/Delete:
    delete:
      tags:
      - Request
      summary: Delete account information access request
      description: '**Unique resource name :** ais.v1.request.delete'
      parameters:
      - name: id
        in: query
        description: Account information access request id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '204':
          description: ''
        '400':
          description: '- If id is null or an invalid UUID.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/pis/Request/Create:
    post:
      tags:
      - Request
      summary: Create payment request
      parameters:
      - name: x-signature
        in: header
        description: 'Json web signature (JWS: RFC7519) of the payment initiation consent request payload in detached mode. <see href="https://datatracker.ietf.org/doc/html/rfc7519" />'
        required: true
        schema:
          type: string
      requestBody:
        description: Payment request.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PaymentRequestModel'
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRequestModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PaymentRequestModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PaymentRequestModel'
        required: true
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccessRequestResponseModelApiResponse'
        '400':
          description: '- If model is not valid.

            - If signature is null or not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If provider not found.'
  /api/v1.0/pis/Request/List:
    get:
      tags:
      - Request
      summary: List payment requests
      parameters:
      - name: page
        in: query
        description: Page number
        schema:
          type: integer
          format: int32
          default: '1'
      - name: perPage
        in: query
        description: Number of items per page maximum allow is 100 per page
        schema:
          type: integer
          format: int32
          default: '20'
      - name: externalReference
        in: query
        description: External reference (Optional)
        schema:
          type: string
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccessRequestResponseModelIEnumerablePagesModelMetaApiResponse'
        '400':
          description: '- If pagination parameters are not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '200':
          description: ''
  /api/v1.0/pis/Request/Get:
    get:
      tags:
      - Request
      summary: Get payment request by id
      parameters:
      - name: id
        in: query
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccessRequestResponseModelApiResponse'
        '400':
          description: '- If payment request id is not valid UUID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If payment request does not exists'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/pis/Request/Delete:
    get:
      tags:
      - Request
      summary: Delete payment request by id
      parameters:
      - name: id
        in: query
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '204':
          description: ''
        '400':
          description: '- If payment request id is not valid UUID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '423':
          description: '- If payment request, has a consent resource created.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Request/CreateShortLivedRequest:
    post:
      tags:
      - Request
      summary: Create account information access request for short-lived consent
      description: "**Unique resource name :** ais.v1.request.create_short_lived_request\r\n            \r\n**Consent lifetime :** 1 Day"
      requestBody:
        description: Account information access request.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AisRequestAccessModel'
          application/json:
            schema:
              $ref: '#/components/schemas/AisRequestAccessModel'
          text/json:
            schema:
              $ref: '#/components/schemas/AisRequestAccessModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AisRequestAccessModel'
        required: true
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInformationRequestAccessResponseModelApiResponse'
        '400':
          description: '- If model is not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Request/CreateLongLivedRequest:
    post:
      tags:
      - Request
      summary: Create account information access request for long-lived consent
      description: "**Unique resource name :** ais.v1.request.create_long_lived_request\r\n            \r\n**Consent lifetime :** consent expiry date input"
      requestBody:
        description: Account information access request.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/LongLivedRequestModel'
          application/json:
            schema:
              $ref: '#/components/schemas/LongLivedRequestModel'
          text/json:
            schema:
              $ref: '#/components/schemas/LongLivedRequestModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/LongLivedRequestModel'
        required: true
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInformationRequestAccessResponseModelApiResponse'
        '400':
          description: '- If model is not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
components:
  schemas:
    ConsentScope:
      enum:
      - Accounts
      - Payments
      type: string
    AccountInformationPermission:
      enum:
      - ReadAccountsBasic
      - ReadAccountsDetail
      - ReadBalances
      - ReadBeneficiariesBasic
      - ReadBeneficiariesDetail
      - ReadDirectDebits
      - ReadTransactionsBasic
      - ReadTransactionsDetail
      - ReadTransactionsCredits
      - ReadTransactionsDebits
      - ReadStatementsBasic
      - ReadStatementsDetail
      - ReadSupplementaryAccountInfo
      - ReadOffers
      - ReadParty
      - ReadPartyCustomer
      - ReadFutureDatedPaymentsBasic
      - ReadFutureDatedPaymentsDetail
      - ReadPAN
      - ReadPartyPSU
      - ReadPartyPSUIdentity
      - ReadScheduledPaymentsBasic
      - ReadScheduledPaymentsDetail
      - ReadStandingOrdersBasic
      - ReadStandingOrdersDetail
      type: string
    AccountInformationProviderModel:
      required:
      - englishName
      - isEnable
      type: object
      properties:
        id:
          type: string
          format: uuid
        country:
          $ref: '#/components/schemas/CountryResponseModel'
        allowedPermissions:
          type: array
          items:
            $ref: '#/components/schemas/AccountInformationPermission'
          nullable: true
        address:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        useBenefit:
          type: boolean
          nullable: true
        arabicName:
          maxLength: 255
          type: string
          nullable: true
        englishName:
          maxLength: 255
          minLength: 1
          type: string
        status:
          $ref: '#/components/schemas/ProviderStatus'
        isEnable:
          type: boolean
        logo:
          maxLength: 255
          type: string
          format: uri
          nullable: true
      additionalProperties: false
    LongLivedRequestModel:
      required:
      - consentExpiryDate
      - countryCode
      - customerId
      - requestPermissions
      type: object
      properties:
        consentExpiryDate:
          type: string
          format: date-time
        providers:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
        customerId:
          type: string
          format: uuid
        consentTransactionsFromDate:
          type: string
          format: date-time
          nullable: true
        consentTransactionsToDate:
          type: string
          format: date-time
          nullable: true
        countryCode:
          minLength: 1
          pattern: ^[A-Z]{2}
          type: string
        requestPermissions:
          type: array
          items:
            $ref: '#/components/schemas/AccountInformationPermission'
        redirectionFlow:
          $ref: '#/components/schemas/RedirectionFlow'
        successRedirectUrl:
          maxLength: 255
          type: string
          format: uri
          nullable: true
        failureRedirectUrl:
          maxLength: 255
          type: string
          format: uri
          nullable: true
        autoRedirect:
          type: boolean
      additionalProperties: false
    ApiError:
      enum:
      - INVALID_DATA
      - INVALID_SIGNATURE
      - RESOURCE_LOCKED
      - COUNTRY_NOT_FOUND
      - CURRENCY_NOT_FOUND
      - PROVIDER_NOT_FOUND
      - CONNECTION_NOT_FOUND
      - INSUFFICIENT_CONSENT_PERMISSIONS
      - CONSENT_EXPIRED
      - CONSENT_REVOKED
      - CONSENT_UNAUTHORIZED
      - CONSENT_NOT_FOUND
      - RISK_REPORT_NOT_FOUND
      - ACCOUNT_INFORMATION_REPORT_NOT_FOUND
      - MULTIPLE_CURRENCY_NOT_ALLOWED
      - MULTIPLE_CONSENT_DATE_NOT_ALLOWED
      - PAYMENT_NOT_FOUND
      - CONSENT_REJECTED
      - PAYMENT_REQUEST_NOT_FOUND
      - CUSTOMER_NOT_FOUND
      - CUSTOMER_ALREADY_EXISTS
      - BANK_ACCOUNT_NOT_FOUND
      - SERVER_ERROR
      - PROVIDER_CONNECTION_FAILURE
      - TRANSACTION_NOT_FOUND
      - ACCOUNT_INFORMATION_ACCESS_REQUEST_NOT_FOUND
      - CONSENT_REVOCATION_FAILED
      - CONSENT_REVOKED_OR_EXPIRED
      - SUBSCRIPTION_EXPIRED
      - NOT_SUBSCRIBED_TO_SERVICE
      - BENEFICIARY_NOT_FOUND
      - PARTIES_NOT_FOUND
      - DIRECT_DEBIT_NOT_FOUND
      - SCHEDULED_PAYMENT_NOT_FOUND
      - DEBTOR_ACCOUNT_NOT_FOUND
      - CREDITOR_ACCOUNT_NOT_FOUND
      - UNAUTHORIZED_IP_ADDRESS
      type: string
    AccountInformationRequestAccessResponseModel:
      required:
      - countryCode
      - customerId
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/RequestStatus'
        source:
          $ref: '#/components/schemas/ConsentSource'
        consent:
          $ref: '#/components/schemas/AccountInformationConsentResponseModel'
        country:
          $ref: '#/components/schemas/CountryResponseModel'
        requestPermissions:
          type: array
          items:
            type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        requestLink:
          type: string
          nullable: true
        customerId:
          type: string
          format: uuid
        consentExpiryDate:
          type: string
          format: date-time
          nullable: true
        consentTransactionsFromDate:
          type: string
          format: date-time
          nullable: true
        consentTransactionsToDate:
          type: string
          format: date-time
          nullable: true
        countryCode:
          minLength: 1
          pattern: ^[A-Z]{2}
          type: string
        redirectionFlow:
          $ref: '#/components/schemas/RedirectionFlow'
        successRedirectUrl:
          maxLength: 255
          type: string
          format: uri
          nullable: true
        failureRedirectUrl:
          maxLength: 255
          type: string
          format: uri
          nullable: true
        autoRedirect:
          type: boolean
      additionalProperties: false
    PaymentAccessRequestResponseModelIEnumerablePagesModelMetaApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          nullable: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/PaymentAccessRequestResponseModel'
          nullable: true
        meta:
          $ref: '#/components/schemas/PagesModel'
      additionalProperties: false
    PaymentPurpose:
      enum:
      - SELF
      - ONLP
      - LORP
      - BIL
      - DONA
      - DUES
      - GOPT
      - PERS
      - PERL
      type: string
    SchemeName:
      enum:
      - IBAN
      - BBAN
      type: string
    PaymentAmountResponseModel:
      type: object
      properties:
        value:
          type: number
          format: double
          nullable: true
        currency:
          $ref: '#/components/schemas/CurrencyResponseModel'
      additionalProperties: false
    PaymentInitiationConsentResponseModel:
      type: object
      properties:
        connection:
          $ref: '#/components/schemas/PaymentInitiationConnectionResponseModel'
        paymentConsentType:
          $ref: '#/components/schemas/ConsentPaymentType'
        executionDateTime:
          type: string
          format: date-time
          nullable: true
        purpose:
          type: string
          nullable: true
        note:
          type: string
          nullable: true
        id:
          type: string
          format: uuid
        customerId:
          type: string
          format: uuid
          nullable: true
        scope:
          $ref: '#/components/schemas/ConsentScope'
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/ObConsentsStatus'
        authorizationLink:
          type: string
          nullable: true
        successRedirectUrl:
          type: string
          nullable: true
        failureRedirectUrl:
          type: string
          nullable: true
      additionalProperties: false
    ObjectApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          nullable: true
        data:
          nullable: true
      additionalProperties: false
    ConnectionStatus:
      enum:
      - ACTIVE
      - INACTIVE
      type: string
    ConsentSource:
      enum:
      - WEB
      - API
      type: string
    PaymentAccessRequestResponseModelApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          nullable: true
        data:
          $ref: '#/components/schemas/PaymentAccessRequestResponseModel'
      additionalProperties: false
    PaymentInitiationProviderModel:
      required:
      - englishName
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
        country:
          $ref: '#/components/schemas/CountryResponseModel'
        address:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        isEnable:
          type: boolean
        arabicName:
          maxLength: 255
          type: string
          nullable: true
        englishName:
          maxLength: 255
          minLength: 1
          type: string
        status:
          $ref: '#/components/schemas/ProviderStatus'
        logo:
          maxLength: 255
          type: string
          format: uri
          nullable: true
      additionalProperties: false
    RedirectionFlow:
      enum:
      - WEB
      - DECOUPLED
      type: string
    AisRequestAccessModel:
      required:
      - countryCode
      - customerId
      - requestPermissions
      type: object
      properties:
        providers:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
        customerId:
          type: string
          format: uuid
        consentTransactionsFromDate:
          type: string
          format: date-time
          nullable: true
        consentTransactionsToDate:
          type: string
          format: date-time
          nullable: true
        countryCode:
          minLength: 1
          pattern: ^[A-Z]{2}
          type: string
        requestPermissions:
          type: array
          items:
            $ref: '#/components/schemas/AccountInformationPermission'
        redirectionFlow:
          $ref: '#/components/schemas/RedirectionFlow'
        successRedirectUrl:
          maxLength: 255
          type: string
          format: uri
          nullable: true
        failureRedirectUrl:
          maxLength: 255
          type: string
          format: uri
          nullable: true
        autoRedirect:
          type: boolean
      additionalProperties: false
    ConsentPaymentType:
      enum:
      - SingleInstantPayment
      type: string
    AccountInformationRequestAccessResponseModelIEnumerablePagesModelMetaApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          nullable: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/AccountInformationRequestAccessResponseModel'
          nullable: true
        meta:
          $ref: '#/components/schemas/PagesModel'
      additionalProperties: false
    AccountInformationRequestAccessModel:
      required:
      - countryCode
      - customerId
      - requestPermissions
      type: object
      properties:
        customerId:
          type: string
          format: uuid
        consentExpiryDate:
          type: string
          format: date-time
          nullable: true
        consentTransactionsFromDate:
          type: string
          format: date-time
          nullable: true
        consentTransactionsToDate:
          type: string
          format: date-time
          nullable: true
        countryCode:
          minLength: 1
          pattern: ^[A-Z]{2}
          type: string
        requestPermissions:
          type: array
          items:
            $ref: '#/components/schemas/AccountInformationPermission'
        redirectionFlow:
          $ref: '#/components/schemas/RedirectionFlow'
        successRedirectUrl:
          maxLength: 255
          type: string
          format: uri
          nullable: true
        failureRedirectUrl:
          maxLength: 255
          type: string
          format: uri
          nullable: true
        autoRedirect:
          type: boolean
      additionalProperties: false
    PaymentType:
      enum:
      - SINGLE_DOMESTIC
      - RECURRENT
      type: string
    Accou

# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spare/refs/heads/main/openapi/spare-request-api-openapi.yml