Spare

Spare Consent API

The Consent API from Spare — 9 operation(s) for consent.

GitHub OpenAPI

Operations 9

POST /api/v1.0/ais/Consent/Create Create consent
GET /api/v1.0/ais/Consent/List List consent
GET /api/v1.0/ais/Consent/Get Get consent by id
PATCH /api/v1.0/ais/Consent/Revoke Revoke consent
POST /api/v1.0/pis/Consent/Create Create domestic payment consent
GET /api/v1.0/pis/Consent/List List consent
GET /api/v1.0/pis/Consent/Get Get consent by id
POST /api/v1.0/ais/Consent/CreateShortLivedConsent Create short-lived consent
POST /api/v1.0/ais/Consent/CreateLongLivedConsent Create long-lived consent

Documentation

📖
Documentation
https://docs.tryspare.com/docs/auth-flow
📖
APIReference
https://docs.tryspare.com/reference/get_api-v1-0-authentication-token
📖
Documentation
https://docs.tryspare.com/docs/data-api-basics
📖
APIReference
https://docs.tryspare.com/reference/get_api-v1-0-ais-account-list-1
📖
Documentation
https://docs.tryspare.com/docs/payments-api-basics
📖
APIReference
https://docs.tryspare.com/reference/create-business-domestic-payment
📖
Documentation
https://docs.tryspare.com/docs/ksa-coverage

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/spare/refs/heads/main/openapi/spare-consent-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/spare-consent-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

spare-consent-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Information Account Consent 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'
servers:
- url: https://ob.tryspare.com/api/v1.0/authentication
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- Bearer: []
tags:
- name: Consent
paths:
  /api/v1.0/ais/Consent/Create:
    post:
      tags:
      - Consent
      summary: Create consent
      description: '**Unique resource name :** ais.v1.consent.create'
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ConsentRequestModel'
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentRequestModel'
          text/json:
            schema:
              $ref: '#/components/schemas/ConsentRequestModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ConsentRequestModel'
        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/AccountInformationConsentResponseModelApiResponse'
        '400':
          description: '- If provider id is not valid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If provider does not exist

            - If connection does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Consent/List:
    get:
      tags:
      - Consent
      summary: List consent
      description: '**Unique resource name :** ais.v1.consent.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'
      - name: providerId
        in: query
        description: Provider id (Optional)
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: query
        description: Connection id (Optional)
        schema:
          type: string
          format: uuid
      - name: customerId
        in: query
        description: Customer id (Optional)
        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/AccountInformationConsentResponseModelIEnumerablePagesModelMetaApiResponse'
        '400':
          description: '- If connection id is not valid'
  /api/v1.0/ais/Consent/Get:
    get:
      tags:
      - Consent
      summary: Get consent by id
      description: '**Unique resource name :** ais.v1.consent.get'
      parameters:
      - name: id
        in: query
        description: Consent 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/AccountInformationConsentResponseModelApiResponse'
        '400':
          description: '- If id is not valid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If consent does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Consent/Revoke:
    patch:
      tags:
      - Consent
      summary: Revoke consent
      description: '**Unique resource name :** ais.v1.consent.revoke'
      parameters:
      - name: id
        in: query
        description: Consent 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 not valid

            - If consent revocation fails'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/pis/Consent/Create:
    post:
      tags:
      - Consent
      summary: Create domestic payment consent
      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 initiation consent request model.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/DomesticPaymentConsentRequestModel'
          application/json:
            schema:
              $ref: '#/components/schemas/DomesticPaymentConsentRequestModel'
          text/json:
            schema:
              $ref: '#/components/schemas/DomesticPaymentConsentRequestModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/DomesticPaymentConsentRequestModel'
        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/DomesticPaymentConsentResponseModelApiResponse'
        '400':
          description: '- If model is not valid.

            - If signature is null or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If provider does not exist

            - If connection does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/pis/Consent/List:
    get:
      tags:
      - Consent
      summary: List consent
      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: providerId
        in: query
        description: Provider id (Optional)
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: query
        description: Connection id (Optional)
        schema:
          type: string
          format: uuid
      - 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
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomesticPaymentConsentResponseModelIEnumerablePagesModelMetaApiResponse'
        '400':
          description: '- If connection id is not valid

            - If provider id is not valid

            - If pagination parameters are not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/pis/Consent/Get:
    get:
      tags:
      - Consent
      summary: Get consent by id
      parameters:
      - name: consentId
        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/DomesticPaymentConsentResponseModelApiResponse'
        '400':
          description: '- If consents id is not valid UUID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If consents does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Consent/CreateShortLivedConsent:
    post:
      tags:
      - Consent
      summary: Create short-lived consent
      description: "**Unique resource name :** ais.v1.consent.create_short_lived_consent\n            \n**Consent lifetime :** 1 Day"
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ConsentRequestModel_2'
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentRequestModel_2'
          text/json:
            schema:
              $ref: '#/components/schemas/ConsentRequestModel_2'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ConsentRequestModel_2'
        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/AccountInformationConsentResponseModelApiResponse'
        '400':
          description: '- If provider id is not valid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If provider does not exist

            - If connection does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Consent/CreateLongLivedConsent:
    post:
      tags:
      - Consent
      summary: Create long-lived consent
      description: "**Unique resource name :** ais.v1.consent.create_long_lived_consent\n            \n**Consent lifetime :** expiry date input"
      requestBody:
        description: Long-lived consent request model
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/LongLivedConsentRequestModel'
          application/json:
            schema:
              $ref: '#/components/schemas/LongLivedConsentRequestModel'
          text/json:
            schema:
              $ref: '#/components/schemas/LongLivedConsentRequestModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/LongLivedConsentRequestModel'
        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/AccountInformationConsentResponseModelApiResponse'
        '400':
          description: '- If provider id is not valid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If provider does not exist

            - If connection does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
components:
  schemas:
    ConsentPaymentType:
      enum:
      - SingleInstantPayment
      type: string
    AccountInformationProviderModel:
      required:
      - englishName
      - isEnable
      type: object
      properties:
        id:
          type: string
          format: uuid
        country:
          $ref: '#/components/schemas/CountryResponseModel'
        allowedPermissions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccountInformationPermission'
        address:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
        useBenefit:
          type:
          - boolean
          - 'null'
        arabicName:
          maxLength: 255
          type:
          - string
          - 'null'
        englishName:
          maxLength: 255
          minLength: 1
          type: string
        status:
          $ref: '#/components/schemas/ProviderStatus'
        isEnable:
          type: boolean
        logo:
          maxLength: 255
          type:
          - string
          - 'null'
          format: uri
      additionalProperties: false
    PaymentPurpose:
      enum:
      - SELF
      - ONLP
      - LORP
      - BIL
      - DONA
      - DUES
      - GOPT
      - PERS
      - PERL
      type: string
    AccountInformationConsentResponseModelApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
        data:
          $ref: '#/components/schemas/AccountInformationConsentResponseModel'
      additionalProperties: false
    ConsentScope:
      enum:
      - Accounts
      - Payments
      type: string
    CurrencyResponseModel:
      required:
      - englishName
      - iso4117Code
      type: object
      properties:
        id:
          type: string
          format: uuid
        englishName:
          maxLength: 50
          minLength: 1
          type: string
        arabicName:
          maxLength: 50
          type:
          - string
          - 'null'
        iso4117Code:
          maxLength: 3
          minLength: 1
          type: string
        iso4117Number:
          maxLength: 4
          type:
          - string
          - 'null'
      additionalProperties: false
    AccountRequestModel:
      required:
      - identification
      - scheme
      type: object
      properties:
        scheme:
          $ref: '#/components/schemas/SchemeName'
        identification:
          minLength: 1
          type: string
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
    ObjectApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
        data: {}
      additionalProperties: false
    AccountInformationConsentResponseModel:
      type: object
      properties:
        expiryDate:
          type:
          - string
          - 'null'
          format: date-time
        transactionsFromDate:
          type:
          - string
          - 'null'
          format: date-time
        transactionsToDate:
          type:
          - string
          - 'null'
          format: date-time
        permissions:
          type:
          - array
          - 'null'
          items:
            type: string
        statusHistory:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConsentStatusHistoryModel'
        connection:
          $ref: '#/components/schemas/AccountInformationConnectionResponseModel'
        id:
          type: string
          format: uuid
        customerId:
          type:
          - string
          - 'null'
          format: uuid
        scope:
          $ref: '#/components/schemas/ConsentScope'
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/ObConsentsStatus'
        authorizationLink:
          type:
          - string
          - 'null'
        successRedirectUrl:
          type:
          - string
          - 'null'
        failureRedirectUrl:
          type:
          - string
          - 'null'
      additionalProperties: false
    ConnectionStatus:
      enum:
      - ACTIVE
      - INACTIVE
      type: string
    ProviderStatus:
      enum:
      - Active
      - Inactive
      type: string
    DomesticPaymentConsentResponseModelApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
        data:
          $ref: '#/components/schemas/DomesticPaymentConsentResponseModel'
      additionalProperties: false
    AccountInformationConsentResponseModelIEnumerablePagesModelMetaApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccountInformationConsentResponseModel'
        meta:
          $ref: '#/components/schemas/PagesModel'
      additionalProperties: false
    DomesticPaymentConsentResponseModel:
      type: object
      properties:
        paymentId:
          type:
          - string
          - 'null'
          format: uuid
        consentId:
          type:
          - string
          - 'null'
          format: uuid
        externalReference:
          type:
          - string
          - 'null'
        scope:
          $ref: '#/components/schemas/ConsentScope'
        paymentConsentType:
          $ref: '#/components/schemas/ConsentPaymentType'
        executionDateTime:
          type:
          - string
          - 'null'
          format: date-time
        authorizationLink:
          type:
          - string
          - 'null'
        amount:
          $ref: '#/components/schemas/PaymentAmountResponseModel'
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/ObConsentsStatus'
        creditorAccount:
          $ref: '#/components/schemas/PaymentAccountModel'
        debtorAccount:
          $ref: '#/components/schemas/PaymentAccountModel'
        connection:
          $ref: '#/components/schemas/PaymentInitiationConnectionResponseModel'
        purpose:
          type:
          - string
          - 'null'
        note:
          type:
          - string
          - 'null'
      additionalProperties: false
    PaymentInitiationConnectionResponseModel:
      type: object
      properties:
        provider:
          $ref: '#/components/schemas/PaymentInitiationProviderModel'
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/ConnectionStatus'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      additionalProperties: false
    AccountInformationConnectionResponseModel:
      type: object
      properties:
        provider:
          $ref: '#/components/schemas/AccountInformationProviderModel'
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/ConnectionStatus'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      additionalProperties: false
    DomesticPaymentConsentRequestModel:
      required:
      - amount
      - creditorAccount
      - currency
      - paymentConsentType
      - providerId
      - purpose
      type: object
      properties:
        connectionId:
          type:
          - string
          - 'null'
          format: uuid
        providerId:
          type: string
          format: uuid
        externalReference:
          maxLength: 255
          type:
          - string
          - 'null'
        description:
          maxLength: 500
          type:
          - string
          - 'null'
        amount:
          minLength: 1
          pattern: ^\d{1,3}(\.\d{3})?$
          type: string
        currency:
          minLength: 1
          pattern: ^[A-Z]{3}
          type: string
        successRedirectUrl:
          maxLength: 255
          type:
          - string
          - 'null'
          format: uri
        failureRedirectUrl:
          maxLength: 255
          type:
          - string
          - 'null'
          format: uri
        paymentConsentType:
          $ref: '#/components/schemas/ConsentPaymentType'
        purpose:
          $ref: '#/components/schemas/PaymentPurpose'
        note:
          type:
          - string
          - 'null'
        autoRedirect:
          type: boolean
        debtorAccount:
          $ref: '#/components/schemas/AccountRequestModel'
        creditorAccount:
          $ref: '#/components/schemas/AccountRequestModel'
      additionalProperties: false
    ConsentStatusHistoryModel:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ObConsentsStatus'
        dateTime:
          type: string
          format: date-time
      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
    ConsentRequestModel_2:
      required:
      - customerId
      - providerId
      type: object
      properties:
        connectionId:
          type:
          - string
          - 'null'
          format: uuid
        providerId:
          type: string
          format: uuid
        customerId:
          type: string
          format: uuid
        transactionsFromDate:
          type:
          - string
          - 'null'
          format: date-time
        transactionsToDate:
          type:
          - string
          - 'null'
          format: date-time
        permissions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccountInformationPermission'
        successRedirectUrl:
          maxLength: 255
          type:
          - string
          - 'null'
          format: uri
        failureRedirectUrl:
          maxLength: 255
          type:
          - string
          - 'null'
          format: uri
        autoRedirect:
          type: boolean
      additionalProperties: false
    DomesticPaymentConsentResponseModelIEnumerablePagesModelMetaApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DomesticPaymentConsentResponseModel'
        meta:
          $ref: '#/components/schemas/PagesModel'
      additionalProperties: false
    ConsentRequestModel:
      required:
      - customerId
      - providerId
      type: object
      properties:
        connectionId:
          type:
          - string
          - 'null'
          format: uuid
        providerId:
          type: string
          format: uuid
        customerId:
          type: string
          format: uuid
        expiryDate:
          type:
          - string
          - 'null'
          format: date-time
        transactionsFromDate:
          type:
          - string
          - 'null'
          format: date-time
        transactionsToDate:
          type:
          - string
          - 'null'
          format: date-time
        permissions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccountInformationPermission'
        successRedirectUrl:
          maxLength: 255
          type:
          - string
          - 'null'
          format: uri
        failureRedirectUrl:
          maxLength: 255
          type:
          - string
          - 'null'
          format: uri
        autoRedirect:
          type: boolean
      additionalProperties: false
    LongLivedConsentRequestModel:
      required:
      - customerId
      - expiryDate
      - providerId
      type: object
      properties:
        connectionId:
          type:
          - string
          - 'null'
          format: uuid
        providerId:
          type: string
          format: uuid
        customerId:
          type: string
          format: uuid
        expiryDate:
          type: string
          format: date-time
        transactionsFromDate:
          type:
          - string
          - 'null'
          format: date-time
        transactionsToDate:
          type:
          - string
          - 'null'
          format: date-time
        permissions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccountInformationPermission'
        successRedirectUrl:
          maxLength: 255
          type:
          - string
          - 'null'
          format: uri
        failureRedirectUrl:
          maxLength: 255
          type:
          - string
          - 'null'
          format: uri
        autoRedirect:
          type: boolean
      additionalProperties: false
    PaymentAccountModel:
      required:
      - identification
      - scheme
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        scheme:
          $ref: '#/components/schemas/SchemeName'
        identification:
          minLength: 1
          type: string
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
    SchemeName:
      enum:
      - IBAN
      - BBAN


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