openapi: 3.0.1
info:
  title: Webhooks
  version: '1.0'
servers:
  - url: https://api.solaris-sandbox.de
    description: Sandbox
  - url: https://api.solarisbank.de
    description: Production
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhook subscription
      summary: Create a webhook subscription
      description: >-
        Creates a new webhook subscription for a specific event.<br> When you
        create a webhook subscription, Solaris checks the validity of the
        provided `url` by sending a single `POST` notification. The notification
        contains an empty body and the `SOLARIS-WEBHOOK-EVENT-TYPE` header with
        a value of `WEBHOOK-SUBSCRIPTION`.<br> The response from this endpoint
        contains a unique `id` for the subscription and a `secret`. Use this
        `secret` to verify the authenticity of the notifications.<br> Webhook
        URLs cannot be changed after creating a webhook subscription. You must
        delete the existing webhook and register a new one with the new URL.
        Note that you will receive a new `id` and `secret`. 
      requestBody:
        description: The content of the request.
        content:
          application/json:
            schema:
              type: object
              properties:
                event_type:
                  type: string
                  description: The type of event to subscribe to.
                url:
                  type: string
                  description: The URL where Solaris should send the webhook notifications.
              example:
                event_type: IDENTIFICATION
                url: https://example.com/identification
        required: false
      responses:
        '201':
          description: Successful result of the operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Solaris-Server-Decorators-Webhook'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '403':
          description: You are not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        default:
          description: Unexpected error
          content: {}
      security:
        - oauth2:
            - solaris_service_webhook#create
      x-codegen-request-body-name: body
    get:
      tags:
        - Webhook subscription
      summary: Index webhooks
      description: Returns an array containing all of your webhook subscriptions.
      parameters:
        - name: page[number]
          in: query
          description: The number of results pages to return.
          schema:
            type: string
        - name: page[size]
          in: query
          description: The size of each page in the response.
          schema:
            type: string
      responses:
        '200':
          description: Successful result of the operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Solaris-Server-Decorators-Webhook'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '403':
          description: You are not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        default:
          description: Unexpected error
          content: {}
      security:
        - oauth2:
            - solaris_service_webhook#all
  /v1/webhooks/{id}:
    get:
      tags:
        - Webhook subscription
      summary: Retrieve a webhook
      description: >-
        Returns the webhook subscription specified in the request URL. Note that
        the API only returns `secret` value when the webhook is created; this
        endpoint will return `null` as the value for `secret`.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful result of the operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Solaris-Server-Decorators-Webhook'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '403':
          description: You are not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        default:
          description: Unexpected error
          content: {}
      security:
        - oauth2:
            - solaris_service_webhook#find
    delete:
      tags:
        - Webhook subscription
      summary: Delete a webhook
      description: >-
        Deletes the webhook subscription specified in the request URL. Please
        ensure that you have a replacement for a webhook before deleting it; all
        stored and unsent notifications will be lost.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Successful result of the operation
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '403':
          description: You are not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        default:
          description: Unexpected error
          content: {}
      security:
        - oauth2:
            - solaris_service_webhook#find
            - solaris_service_webhook#delete
x-webhooks:
  account_block:
    post:
      tags:
        - Webhook events
      summary: "ACCOUNT_BLOCK\_"
      description: >-
        The `locking_status` or `locking_reason` for a customer's account has
        changed. See the [Account management
        guide](https://docs.solarisgroup.com/guides/digital-banking/account-management/#appendix-iii-account-blocking)
        for more information about account blocking.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type: string
                  description: The ID of customer's account that was blocked.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                person_id:
                  type: string
                  description: >-
                    The ID of the person resource of the customer whose account
                    was blocked.
                  example: dc1a6812a14f6cc338cd084208535bcdcper
                business_id:
                  type: string
                  description: >-
                    The ID of the business resource of the customer whose
                    account was blocked.
                  example: 'null'
                iban:
                  type: string
                  description: The IBAN of the account that was blocked.
                  example: DE87110101001000057123
                locking_status:
                  type: string
                  description: >-
                    Read-only booking block indicating whether funds can be
                    transferred to/from the account. The default status is
                    `NO_BLOCK`. Other status values indicate that funds may
                    neither be credited to, nor debited from, the account. Only
                    authorized Solaris employees can change the status of this
                    value. Attempting to perform an action not compliant with
                    the current blocking status (e.g., initiating a transaction
                    to or from a blocked account) will cause either a return of
                    the transaction or an exception.
                  enum:
                    - NO_BLOCK
                    - CREDIT_BLOCK
                    - DEBIT_BLOCK
                    - BLOCK
                  example: DEBIT_BLOCK
                updated_at:
                  type: string
                  description: >-
                    UTC timestamp from when the account's locking status has
                    changed.
                  example: '2018-10-18T13:06:54.000Z'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  account_closure:
    post:
      tags:
        - Webhook events
      summary: ACCOUNT_CLOSURE
      description: >-
        The [account
        closure](https://docs.solarisgroup.com/guides/compliance/account-closure/)
        process has completed for a customer's account.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type: string
                  description: The ID of customer's account that was closed.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                person_id:
                  type: string
                  description: >-
                    The ID of the person resource of the customer whose account
                    was closed.
                  example: dc1a6812a14f6cc338cd084208535bcdcper
                business_id:
                  type: string
                  description: >-
                    The ID of the business resource of the customer whose
                    account was closed.
                  example: 'null'
                iban:
                  type: string
                  description: The IBAN of the account that was closed.
                  example: DE87110101001000057123
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  account_closure_request:
    post:
      tags:
        - Webhook events
      summary: ACCOUNT_CLOSURE_REQUEST
      description: >-
        Solaris has initiated the [account
        closure](https://docs.solarisgroup.com/guides/compliance/account-closure/)
        process for a customer's account.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account_closure_request'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  account_closure_request_update:
    post:
      tags:
        - Webhook events
      summary: ACCOUNT_CLOSURE_REQUEST_UPDATE
      description: >-
        This webhook sends notifications about certain status transitions for
        [account closure
        requests](https://docs.solarisgroup.com/guides/compliance/account-closure/#account_closure_status_update).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/account_closure_request'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  account_limit_change:
    post:
      tags:
        - Webhook events
      summary: ACCOUNT_LIMIT_CHANGE
      description: >-
        The limit on a customer's account has changed. This webhook is used in
        the context of the [Decoupled
        Cards](https://docs.solarisgroup.com/guides/cards/decoupled-cards/)
        product.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type: string
                  description: The ID of customer's account whose limit changed.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  account_opening_request:
    post:
      tags:
        - Webhook events
      summary: ACCOUNT_OPENING_REQUEST
      description: >-
        An [account
        opening](https://docs.solarisgroup.com/guides/digital-banking/account-opening/)
        request has been either accepted or rejected.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account_opening_request_id:
                  type: string
                  description: The ID of the account opening request.
                  example: f8d7fbbd587047a0aa449ce69d2d6c08aorq
                customer_id:
                  type: string
                  description: >-
                    The ID (i.e., `person_id` or `business_id`) of the customer
                    for whom you're opening the account.
                  example: b109ee6f66d2a061e006bd31c6455df2cper
                status:
                  allOf:
                    - $ref: '#/components/schemas/account_opening_request_status_enum'
                account_id:
                  type: string
                  description: The ID of the account that was created for the customer.
                  example: c5a0e32369e9372e0fdf490294cecd8dcacc
                updated_at:
                  type: string
                  format: date-time
                  description: The timestamp (date-time) when the AOR was last updated.
                  example: '2021-12-22T15:05:33.634+00:00'
                error:
                  type: object
                  description: >-
                    An object containing information about the reason why an
                    account opening request has failed.
                  nullable: true
                  properties:
                    code:
                      allOf:
                        - $ref: >-
                            #/components/schemas/account_opening_request_error_code_enum
                    detail:
                      allOf:
                        - $ref: >-
                            #/components/schemas/account_opening_request_error_detail_enum
                  example:
                    code: green_person_vetting
                    detail: >-
                      CustomerVettingStatus for person has to be 'green' to open
                      an account.
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  account_snapshot:
    post:
      tags:
        - Webhook events
      summary: ACCOUNT_SNAPSHOT
      description: >-
        The status of an [account
        snapshot](https://docs.solarisgroup.com/api-reference/lending/account-snapshot/#tag/Account-snapshots)
        has changed. This webhook is used in the context of different
        [lending](https://docs.solarisgroup.com/guides/lending/) products.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_uuid:
                  type: string
                  description: Resource unique ID.
                  example: bc9eee989fb84f3aa8089e244bb8dfc1snap
                event_type:
                  type: string
                  description: Webhook event
                  example: ACCOUNT_SNAPSHOT
                payload:
                  type: object
                  description: An object containing the webhook event payload.
                  $ref: >-
                    #/components/schemas/AccountSnapshotWeb.AccountSnapshot.ShowAccountSnapshotResponse
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  acquirer_topup_declined:
    post:
      tags:
        - Webhook events
      summary: ACQUIRER_TOPUP_DECLINED
      description: >-
        A
        [Top-Up](https://docs.solarisgroup.com/guides/digital-banking/instant-topups/)
        transaction was declined by Solaris. The status of the Top Up has
        changed to `DECLINED`.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the Top-Up that was declined.
                  example: b76cdcc321d345618084feedc47bbb1d
                account_id:
                  type: string
                  description: >-
                    ID of the customer account associated with the declined
                    Top-Up transaction.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                amount:
                  description: The amount of the Top-Up.
                  allOf:
                    - $ref: '#/components/schemas/MoneyBase'
                client_secret:
                  type: string
                  description: >-
                    The client secret key provided by the Acquirer's API for use
                    in their frontend SDK.
                  example: pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU
                status:
                  $ref: '#/components/schemas/TopupStatusValues'
                  example: DECLINED
                decline_reason:
                  type: string
                  nullable: true
                  description: >-
                    The reason why the Top-Up was declined. Usually present if
                    the `status` is `DECLINED` due to a technical issue.
                  example: Person has blocked account(s)
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  acquirer_topup_executed:
    post:
      tags:
        - Webhook events
      summary: ACQUIRER_TOPUP_EXECUTED
      description: >-
        Solaris successfully processed a
        [Top-Up](https://docs.solarisgroup.com/guides/digital-banking/instant-topups/)
        via an Acquirer. The funds from the Top Up are cleared to the customer's
        account, and the status of the Top Up has changed to `EXECUTED`.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the Top-Up that was executed.
                  example: b76cdcc321d345618084feedc47bbb1d
                account_id:
                  type: string
                  description: >-
                    ID of the customer account associated with the successful
                    Top-Up transaction.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                amount:
                  description: The amount of the Top-Up.
                  allOf:
                    - $ref: '#/components/schemas/MoneyBase'
                client_secret:
                  type: string
                  description: >-
                    The client secret key provided by the Acquirer's API for use
                    in their frontend SDK.
                  example: pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU
                status:
                  $ref: '#/components/schemas/TopupStatusValues'
                  example: EXECUTED
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  acquirer_topup_payment_failed:
    post:
      tags:
        - Webhook events
      summary: ACQUIRER_TOPUP_PAYMENT_FAILED
      description: >-
        A customer attempted an Instant
        [Top-Up](https://docs.solarisgroup.com/guides/digital-banking/instant-topups/)
        but the payment failed (e.g., because the payment method used did not
        have sufficient funds). The customer may re-attempt the Top-Up with the
        same payment method or use a different one.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the Top-Up that failed.
                  example: b76cdcc321d345618084feedc47bbb1d
                account_id:
                  type: string
                  description: >-
                    ID of the customer account associated with the failed Top-Up
                    transaction.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                amount:
                  description: The amount of the Top-Up.
                  allOf:
                    - $ref: '#/components/schemas/MoneyBase'
                client_secret:
                  type: string
                  description: >-
                    The client secret key provided by the Acquirer's API for use
                    in their frontend SDK.
                  example: pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU
                status:
                  $ref: '#/components/schemas/TopupStatusValues'
                  example: ACCEPTED
                acquirer_error_code:
                  type: string
                  nullable: true
                  description: >-
                    Error code forwarded by the Acquirer's API (in case there
                    was an error on the Acquirer's end).
                  example: card_declined
                acquirer_decline_code:
                  type: string
                  nullable: true
                  description: >-
                    If the Acquirer declines the Top-Up, then this property will
                    contain the decline code forwarded by the Acquirer's API.
                  example: exceeds daily limit
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  batch_transfer_status_changed:
    post:
      tags:
        - Webhook events
      summary: BATCH_TRANSFER_STATUS_CHANGED
      description: >-
        When a batch transfer’s status changes to `IN_PROGRESS`, `REJECTED` or
        `FINISHED`, this webhook will be triggered.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the batch transfer.
                  example: f874b3102718a4d757a6b6e4d5996078sctb
                account_id:
                  type: string
                  description: >-
                    The account ID of the account that the batch transfer is
                    associated with.
                  example: 236f9042a19b65c0867e10c922b93502cacc
                status:
                  type: string
                  description: The status of the batch transfer.
                  example: FINISHED
                  enum:
                    - REJECTED
                    - IN_PROGRESS
                    - FINISHED
                transfer_type:
                  type: string
                  description: The `type` for all transfers of the batch.
                  enum:
                    - SCT
                    - SCT_INSTANT
                  example: SCT_INSTANT
                reference:
                  type: string
                  description: A reference for the batch transfer.
                  example: 12f7ec0b-6762-4578-b49f-c0b1647d0e2d
                description:
                  type: string
                  description: Optional description for the batch.
                  example: Monthly Salary Payments
                total_amount:
                  type: number
                  description: >-
                    The total amount of all **planned** transfers in the batch
                    in cents.
                  example: 1000
                transfers_summary:
                  type: object
                  description: >-
                    Summary of executed and failed transfer counts within the
                    batch.
                  properties:
                    executed:
                      type: number
                      description: >-
                        Number of transfers in the batch which were executed
                        (successfully).
                      example: 9
                    failed:
                      type: number
                      description: >-
                        Number of transfers in the batch which failed (not
                        successful).
                      example: 1
                created_at:
                  type: string
                  description: UTC timestamp when the batch transfer was created.
                  format: date-time
                  example: '2025-04-01T13:59:52+00:00'
                started_at:
                  type: string
                  description: >-
                    UTC timestamp when the batch transfer started the processing
                    of all their transfers.
                  format: date-time
                  example: '2025-04-01T14:01:00+00:00'
                finished_at:
                  type: string
                  description: >-
                    UTC timestamp when all transfers were processed and the
                    status of the batch reached `FINISHED`.
                  format: date-time
                  example: '2025-04-01T14:10:30+00:00'
                updated_at:
                  type: string
                  description: >-
                    UTC timestamp when the batch transfer was updated the last
                    time.
                  format: date-time
                  example: '2025-04-01T14:10:30+00:00'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  beneficial_owner:
    post:
      tags:
        - Webhook events
      summary: BENEFICIAL_OWNER
      description: >-
        A new beneficial owner was linked to a business, or an existing one was
        updated. Solaris will send a notification on this webhook if additional
        beneficial owners are discovered during the business identification
        process. For more information about beneficial owners, check the
        [business onboarding
        guide](https://docs.solarisgroup.com/guides/get-started/digital-banking/onboard-business/).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the beneficial owner relationship.
                  example: a5f454e3f96447d6b3f7ecda46328040
                beneficial_owner_id:
                  type: string
                  description: Person ID of the beneficial owner.
                  example: b9c5661fc7d240b8b51b9059b580cper
                person_id:
                  type: string
                  description: Person ID of the beneficial owner.
                  example: b9c5661fc7d240b8b51b9059b580cper
                valid_until:
                  type: string
                  description: The date when the beneficial owner relationship expires.
                  example: '2022-12-31'
                voting_share:
                  type: integer
                  description: >-
                    The beneficial owner's voting share. Expressed as a
                    double-digit percentile (e.g., 75% would be expressed as
                    `75`).
                  example: 75
                business_id:
                  type: string
                  description: ID of the business to which the beneficial owner is linked.
                  example: e0277fae750a4c849660da873f94cbiz
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  booking:
    post:
      tags:
        - Webhook events
      summary: BOOKING
      description: >-
        A booking was created on the account specified in the webhook payload.
        For more information about bookings, check the [account management
        guide](https://docs.solarisgroup.com/guides/digital-banking/account-management/#bookings).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: '#/components/schemas/Solaris-Resources-Booking'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_changed:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_CHANGED
      description: >-
        One or more attributes of a `business` were changed. This webhook does
        not come with a payload. The notification includes the ID of the
        business that was changed in the header.
      parameters:
        - in: header
          name: Solaris-Entity-Id
          description: ID of the business whose attributes changed.
          schema:
            type: string
            example: 211c5c2f34ac442ff6f93d09fc8fb3edcbiz
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_deleted:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_DELETED
      description: >-
        Solaris has deleted all data related to the given business from its
        system. <br>  **Important:** When you receive a notification of this
        type, you must **immediately delete all data** related to the business
        specified in the webhook header.
      parameters:
        - in: header
          name: Solaris-Entity-Id
          description: ID of the business whose data you must delete.
          schema:
            type: string
            example: cba4289c773b7450482ee88a6e5126e9cbiz
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_direct_debit_profile_block_cancelled:
    post:
      tags:
        - Webhook events
      summary: (Legacy) BUSINESS_DIRECT_DEBIT_PROFILE_BLOCK_CANCELLED
      deprecated: true
      description: A scheduled block on a business' SEPA Direct Debit profile was canceled.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the SEPA Direct Debit profile.
                  example: 3cab044cedf84443841d489547177469
                status:
                  type: string
                  description: >-
                    Indicates whether or not the SEPA Direct Debit profile has
                    been accepted and whether or not it is active.
                  enum:
                    - ACCEPTED
                    - REJECTED
                    - ACTIVE
                    - BLOCKED
                    - EXPIRED
                  example: ACCEPTED
                status_reasons:
                  type: string
                  description: >-
                    Associated reasoning behind `REJECTED` and `BLOCKED`
                    statuses.
                collection_limit:
                  type: object
                  description: The available collection limit for the profile.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-Optional'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_direct_debit_profile_block_scheduled:
    post:
      tags:
        - Webhook events
      summary: (Legacy) BUSINESS_DIRECT_DEBIT_PROFILE_BLOCK_SCHEDULED
      deprecated: true
      description: A block was scheduled on a business' SEPA Direct Debit profile.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the SEPA Direct Debit profile.
                  example: 3cab044cedf84443841d489547177469
                status:
                  type: string
                  description: >-
                    Indicates whether or not the SEPA Direct Debit profile has
                    been accepted and whether or not it is active.
                  enum:
                    - ACCEPTED
                    - REJECTED
                    - ACTIVE
                    - BLOCKED
                    - EXPIRED
                  example: ACCEPTED
                status_reasons:
                  type: string
                  description: >-
                    Associated reasoning behind `REJECTED` and `BLOCKED`
                    statuses.
                collection_limit:
                  type: object
                  description: The available collection limit for the profile.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-Optional'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_fronting_application:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_FRONTING_APPLICATION
      description: The status of a business fronting loan application has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the relevant business fronting loan application.
                  example: 89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla
                status:
                  type: string
                  description: The status of the business fronting loan application.
                  example: approved
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_fronting_loan_payout:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_FRONTING_LOAN_PAYOUT
      description: The status of a fronting loan payout has changed to `payout_issued`.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: '#/components/schemas/FrontingLoansWeb.Business.GetLoanResponse'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_fronting_payout_update:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_FRONTING_PAYOUT_UPDATE
      description: >-
        The status of a partial fronting loan payout has changed to
        `transfers_complete`.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: >-
                #/components/schemas/FrontingLoansWeb.Business.Loans.Payouts.GetResponse
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_fronting_relationship_status_changed:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_FRONTING_RELATIONSHIP_STATUS_CHANGED
      description: >-
        The status of the fronting business relationship with a customer has
        changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: >-
                    The ID of the business resource whose business relationship
                    status has changed.
                  example: 3311ac2c0a6243a8836ab290380918facbiz
                status:
                  type: string
                  description: The status of the business relationship.
                  example: active
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_identification:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_IDENTIFICATION
      description: >-
        A [business
        identification](https://docs.solarisgroup.com/guides/kyc/bkyc/) was
        created, or its status was updated. The primary purpose of this webhook
        is to deliver the URL where the customer must be redirected to complete
        a video identification.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The unique ID of the business identification resource.
                  example: 4c74c804eaea5d2a2d64ef400a27a4d3bid
                method:
                  type: string
                  description: The identification method. Default value is `idnow`.
                  example: idnow
                  enum:
                    - idnow
                    - itm
                    - import
                reference:
                  type: string
                  description: >-
                    The reference of the itm identification request. Empty when
                    the identification method is idnow.
                  nullable: true
                  example: null
                url:
                  type: string
                  description: >-
                    The URL to which you must redirect the business' legal
                    representative(s) and/or authorized person(s) to complete
                    the identification process.
                  example: https://go.test.idnow.de/...
                status:
                  type: string
                  description: The status of the business identification process.
                  example: pending
                  enum:
                    - created
                    - pending
                    - successful
                    - failed
                    - expired
                completed_at:
                  type: string
                  description: >-
                    The date and time when the business identification was
                    completed.
                  nullable: true
                  example: null
                business_id:
                  type: string
                  description: The ID of the business resource.
                  example: 880bbac68a34add190786b9c74f4c82fcbiz
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_seizure_created:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_SEIZURE_CREATED
      description: >-
        Solaris has received a request from the authorities (e.g., court,
        governmental agency) to seize the account(s) of a business.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the seizure resource.
                  example: 211c5c2f34ac442ff6f93d09fc8fb3edseiz
                enactment_date:
                  type: string
                  description: The date when the authority issued the seizure.
                  format: date
                  example: '2019-01-31'
                delivery_date:
                  type: string
                  description: The date when the seizure notice was delivered to Solaris.
                  example: '2019-01-28'
                authority_name:
                  type: string
                  description: The name of the authority that issued the seizure.
                  example: Court
                resolution_case_number:
                  type: string
                  description: >-
                    The seizure's case ID number, generated by the issuing
                    authority.
                  example: Number 212121212
                seizure_type:
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Decorators-SeizureTypeEnum'
                  example: COURT_SEIZURE
                status:
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Decorators-SeizureStatusEnum
                  example: ACTIVE
                amount:
                  type: object
                  description: Object that represents the amount of the debt.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                additional_cost:
                  type: object
                  description: Additional costs of the seizure.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                debtor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    debtor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureDebtor
                creditor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    creditor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditor
                creditor_representative:
                  type: object
                  description: >-
                    Object containing information about a person or an entity
                    that represents the creditor (i.e., a third-party liaison
                    between the debtor and creditor).
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditorRepresentative
                automatic_payout_date:
                  type: string
                  description: The automatic payout date of the seizure amount.
                  example: '2022-01-29'
                insolvency:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there's an insolvency case
                    related to the customer.
                  example: false
                social_benefits:
                  type: boolean
                  description: >-
                    Field to indicate whether or not social benefits are
                    applicable to the customer.
                  example: false
                seizure_protected:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there's a seizure
                    protection related to the customer.
                  example: false
                automated:
                  type: boolean
                  description: >-
                    Field to indicate whether or not the seizure will be
                    processed automatically or manually.
                  example: true
                country:
                  type: string
                  description: The country in which the seizure happened.
                  example: DE
                multiple_drittschuldner:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there are multiple third
                    party debtors related to the customer.
                  example: true
                customer_id:
                  type: string
                  description: >-
                    The person or business ID of the customer whose account has
                    the seizure.
                  example: 880bbac68a34add190786b9c74f4c82fcbiz
                customer_type:
                  type: string
                  description: The type of customer whose account has the seizure.
                  example: Business
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_seizure_deleted:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_SEIZURE_DELETED
      description: >-
        Solaris has removed a seizure for a `business` because it was created by
        mistake.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the seizure resource.
                  example: 211c5c2f34ac442ff6f93d09fc8fb3edseiz
                enactment_date:
                  type: string
                  description: The date when the authority issued the seizure.
                  format: date
                  example: '2019-01-31'
                delivery_date:
                  type: string
                  description: The date when the seizure notice was delivered to Solaris.
                  example: '2019-01-28'
                authority_name:
                  type: string
                  description: The name of the authority that issued the seizure.
                  example: Court
                resolution_case_number:
                  type: string
                  description: >-
                    The seizure's case ID number, generated by the issuing
                    authority.
                  example: Number 212121212
                seizure_type:
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Decorators-SeizureTypeEnum'
                  example: COURT_SEIZURE
                status:
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Decorators-SeizureStatusEnum
                  example: ACTIVE
                amount:
                  type: object
                  description: Object that represents the amount of the debt.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                additional_cost:
                  type: object
                  description: Additional costs of the seizure.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                debtor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    debtor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureDebtor
                creditor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    creditor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditor
                creditor_representative:
                  type: object
                  description: >-
                    Object containing information about a person or an entity
                    that represents the creditor (i.e., a third-party liaison
                    between the debtor and creditor).
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditorRepresentative
                customer_id:
                  type: string
                  description: >-
                    The person or business ID of the customer whose seizure was
                    deleted.
                  example: 880bbac68a34add190786b9c74f4c82fcbiz
                customer_type:
                  type: string
                  description: The type of customer whose account has the seizure.
                  example: Business
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_seizure_fulfilled:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_SEIZURE_FULFILLED
      description: The status of a `seizure` on a `business` has changed to `FULFILLED`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the seizure resource.
                  example: 211c5c2f34ac442ff6f93d09fc8fb3edseiz
                enactment_date:
                  type: string
                  description: The date when the authority issued the seizure.
                  format: date
                  example: '2019-01-31'
                delivery_date:
                  type: string
                  description: The date when the seizure notice was delivered to Solaris.
                  example: '2019-01-28'
                authority_name:
                  type: string
                  description: The name of the authority that issued the seizure.
                  example: Court
                resolution_case_number:
                  type: string
                  description: >-
                    The seizure's case ID number, generated by the issuing
                    authority.
                  example: Number 212121212
                seizure_type:
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Decorators-SeizureTypeEnum'
                  example: COURT_SEIZURE
                status:
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Decorators-SeizureStatusEnum
                  example: FULFILLED
                amount:
                  type: object
                  description: Object that represents the amount of the debt.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                additional_cost:
                  type: object
                  description: Additional costs of the seizure.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                debtor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    debtor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureDebtor
                creditor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    creditor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditor
                creditor_representative:
                  type: object
                  description: >-
                    Object containing information about a person or an entity
                    that represents the creditor (i.e., a third-party liaison
                    between the debtor and creditor).
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditorRepresentative
                customer_id:
                  type: string
                  description: >-
                    The person or business ID of the customer whose seizure was
                    fulfilled.
                  example: 880bbac68a34add190786b9c74f4c82fcbiz
                customer_type:
                  type: string
                  description: The type of customer whose account has the seizure.
                  example: Business
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_seizure_updated:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_SEIZURE_UPDATED
      description: >-
        The processing method for a `seizure` for a business has switched from
        automated to manual.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the seizure resource.
                  example: 211c5c2f34ac442ff6f93d09fc8fb3edseiz
                enactment_date:
                  type: string
                  description: The date when the authority issued the seizure.
                  format: date
                  example: '2019-01-31'
                delivery_date:
                  type: string
                  description: The date when the seizure notice was delivered to Solaris.
                  example: '2019-01-28'
                authority_name:
                  type: string
                  description: The name of the authority that issued the seizure.
                  example: Court
                resolution_case_number:
                  type: string
                  description: >-
                    The seizure's case ID number, generated by the issuing
                    authority.
                  example: Number 212121212
                seizure_type:
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Decorators-SeizureTypeEnum'
                  example: COURT_SEIZURE
                status:
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Decorators-SeizureStatusEnum
                  example: ACTIVE
                amount:
                  type: object
                  description: Object that represents the amount of the debt.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                additional_cost:
                  type: object
                  description: Additional costs of the seizure.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                debtor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    debtor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureDebtor
                creditor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    creditor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditor
                creditor_representative:
                  type: object
                  description: >-
                    Object containing information about a person or an entity
                    that represents the creditor (i.e., a third-party liaison
                    between the debtor and creditor).
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditorRepresentative
                automatic_payout_date:
                  type: string
                  description: The automatic payout date of the seizure amount.
                  example: '2022-01-29'
                insolvency:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there's an insolvency case
                    related to the customer.
                  example: false
                social_benefits:
                  type: boolean
                  description: >-
                    Field to indicate whether or not social benefits are
                    applicable to the customer.
                  example: false
                seizure_protected:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there's a seizure
                    protection related to the customer.
                  example: false
                automated:
                  type: boolean
                  description: >-
                    Field to indicate whether or not the seizure will be
                    processed automatically or manually.
                  example: false
                country:
                  type: string
                  description: The country in which the seizure happened.
                  example: DE
                multiple_drittschuldner:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there are multiple third
                    party debtors related to the customer.
                  example: true
                customer_id:
                  type: string
                  description: >-
                    The person or business ID of the customer whose account has
                    the seizure.
                  example: 880bbac68a34add190786b9c74f4c82fcbiz
                customer_type:
                  type: string
                  description: The type of customer whose account has the seizure.
                  example: Business
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  business_tax_identification_changed:
    post:
      tags:
        - Webhook events
      summary: BUSINESS_TAX_IDENTIFICATION_CHANGED
      description: >-
        The tax identification number of a business was modified. The webhook
        contains the id of the relevant business tax identification in the
        header and the id of the relevant business in the payload.
      parameters:
        - in: header
          name: Solaris-Entity-Id
          description: >-
            ID of the business tax identification that triggered the webhook
            notification.
          schema:
            type: string
            example: cba4289c773b7450482ee88a6e5126e9ctin
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the business whose tax identification has changed.
                  example: e51dac3dfa8bd52f9df1a50b091dcbiz
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  card_authorization:
    post:
      tags:
        - Webhook events
      summary: CARD_AUTHORIZATION
      description: >-
        An authorization was created on a customer's account following a card
        transaction.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the reservation related to the card transaction.
                  example: b814e2213c5c45149945ed53422db0c4cres
                amount:
                  type: object
                  description: >-
                    Amount of the reservation related to the card transaction
                    (in Euro cents).
                  properties:
                    value:
                      type: integer
                      example: 800
                    unit:
                      type: string
                      example: cents
                    currency:
                      type: string
                      example: EUR
                reservation_type:
                  type: string
                  description: The type of reservation.
                  example: CARD_AUTHORIZATION
                  enum:
                    - CARD_AUTHORIZATION
                reference:
                  type: string
                  description: Reference for the transaction.
                  example: ccfd9e66-3f3d-4630-b20c-8c268616b702
                status:
                  type: string
                  description: >-
                    The current status of the reservation. Possible values are
                    `OPEN` and `RESOLVED`.
                  example: OPEN
                  enum:
                    - OPEN
                    - RESOLVED
                meta_info:
                  $ref: '#/components/schemas/Solaris-Resources-MetaInfo-JSON'
                expires_at:
                  type: string
                  description: UTC timestamp when the reservation will expire.
                  example: '2020-03-30T00:00:00Z'
                expired_at:
                  type: string
                  description: >-
                    UTC timestamp from when the authorization expired (`null` if
                    it hasn't expired).
                  nullable: true
                  example: null
                resolved_at:
                  type: string
                  description: UTC timestamp from when the authorization was resolved.
                  nullable: true
                  example: null
                description:
                  type: string
                  description: >-
                    A description of the transaction related to the
                    authorization.
                  example: PAYPAL *RECISIO KAR, 35314369001
                partner_id:
                  type: string
                  description: The unique ID of the partner to whom the customer belongs.
                  example: fa126a6d6f47d2ffc23e9d6a3cd69a6fcpar
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  card_authorization_decline:
    post:
      tags:
        - Webhook events
      summary: (Legacy) CARD_AUTHORIZATION_DECLINE
      deprecated: true
      description: >-
        A customer's card transaction was declined. [Click here to see the full
        list of possible
        reasons](https://docs.solarisgroup.com/guides/cards/creation-and-servicing#appendix-vi-transaction-declined-reasons-legacy-v1).
        <br> **Note:** This webhook event is deprecated. Please use
        [CARD_AUTHORIZATION_DECLINE_V2](https://docs.solarisgroup.com/api-reference/onboarding/webhooks/#tag/Webhook-events/paths/card_authorization_decline_v2/post)
        instead.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                reason:
                  type: string
                  description: The reason why the card authorization was declined.
                  example: AUTHENTICATION_REQUIRED
                  enum:
                    - 3DS_FAILED
                    - ACCOUNT_CLOSED
                    - ACCOUNT_LIMIT_REACHED
                    - AUTHENTICATION_REQUIRED
                    - CARD_BLOCKED
                    - CARD_INACTIVE
                    - CARD_NOT_PRESENT_AMOUNT_LIMIT_REACHED_DAILY
                    - CARD_NOT_PRESENT_AMOUNT_LIMIT_REACHED_MONTHLY
                    - CARD_NOT_PRESENT_USE_LIMIT_REACHED_DAILY
                    - CARD_NOT_PRESENT_USE_LIMIT_REACHED_MONTHLY
                    - CARD_PRESENT_AMOUNT_LIMIT_REACHED_DAILY
                    - CARD_PRESENT_AMOUNT_LIMIT_REACHED_MONTHLY
                    - CARD_PRESENT_USE_LIMIT_REACHED_DAILY
                    - CARD_PRESENT_USE_LIMIT_REACHED_MONTHLY
                    - CASH_ADVANCE_AMOUNT_LIMIT_REACHED_DAILY
                    - CASH_ADVANCE_AMOUNT_LIMIT_REACHED_MONTHLY
                    - CONTACT_BANK
                    - CVV_INCORRECT
                    - DUPLICATE_TRASACTION
                    - EXPIRY_DATE_INVALID
                    - FRAUD_SUSPECTED
                    - INSUFFICIENT_FUNDS
                    - INVALID_PIN_BLOCKED
                    - PIN_ENTRY_TIMEOUT
                    - PIN_INCORRECT
                    - REPLACEMENT_CARD_ACTIVATED
                    - RETRY_WITH_CHIP_AND_PIN
                    - SCA_REQUIRED
                    - TERMINAL_ERROR
                card_transaction:
                  type: object
                  description: >-
                    Object containing information about the declined
                    transaction.
                  properties:
                    card_id:
                      type: string
                      description: ID of the card used in the declined transaction.
                      example: f459e5de647e2909c94a7120c4d03557mcrd
                    type:
                      type: string
                      description: The type of card transaction.
                      example: PURCHASE
                      enum:
                        - PURCHASE
                        - WITHDRAWAL
                        - OCT
                    status:
                      type: string
                      description: Status of the card transaction.
                      example: DECLINED
                      enum:
                        - DECLINED
                    attempted_at:
                      type: string
                      description: UTC timestamp from when the transaction was attempted.
                      example: '2019-04-01T12:23:42+00:00'
                    pos_entry_mode:
                      type: string
                      description: The POS entry mode used for the reservation.
                      example: CHIP
                      enum:
                        - CARD_NOT_PRESENT
                        - CHIP
                        - CONTACTLESS
                        - MAG_STRIPE
                    merchant:
                      type: object
                      description: >-
                        Object containing information about the merchant where
                        the card transaction was conducted.
                      properties:
                        country_code:
                          type: string
                          description: >-
                            The merchant's country (ISO 3166 two-character
                            code).
                          example: DE
                        category_code:
                          type: string
                          description: The merchant's four-digit category code.
                          example: '5999'
                        name:
                          type: string
                          description: The merchant's name.
                          example: Shady Bob
                    amount:
                      description: >-
                        The final amount of the card transaction (including
                        fees).
                      allOf:
                        - $ref: >-
                            #/components/schemas/Solaris-Resources-Money-With-Unit
                      example:
                        amount: 8000
                        unit: cents
                        currency: EUR
                    original_amount:
                      description: >-
                        The original amount of the card transaction (minus
                        fees).
                      allOf:
                        - $ref: >-
                            #/components/schemas/Solaris-Resources-Money-With-Unit
                      example:
                        amount: 7800
                        unit: cents
                        currency: EUR
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  card_authorization_decline_v2:
    post:
      tags:
        - Webhook events
      summary: CARD_AUTHORIZATION_DECLINE_V2
      description: >-
        A customer's card transaction was declined. [Click here to see the full
        list of possible
        reasons.](https://docs.solarisgroup.com/guides/cards/creation-and-servicing#appendix-v-transaction-declined-reasons-v2)
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                reasons:
                  type: array
                  description: >-
                    Array of objects containing information about why the
                    transaction was declined. A transaction may have been
                    declined for multiple reasons.
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                        description: The reason why the transaction was declined.
                        example: INSUFFICIENT_FUNDS
                        enum:
                          - 3DS_FAILED
                          - AUTHENTICATION_REQUIRED
                          - CARD_BLOCKED
                          - CARD_EXPIRED
                          - CARD_INACTIVE
                          - CARD_LOST
                          - CARD_STOLEN
                          - EXPIRY_DATE_INVALID
                          - FRAUD_SUSPECTED
                          - INSUFFICIENT_FUNDS
                          - INVALID_CARD_DETAILS
                          - INVALID_PIN_BLOCKED
                          - LIST_CONTROL
                          - PIN_INCORRECT
                          - SCA_REQUIRED
                          - SPENDING_LIMIT
                          - UNKNOWN
                          - UNSUPPORTED_FUNCTION
                      id:
                        type: string
                        description: >-
                          UUID of the related Solaris resource (e.g., the card
                          spending control limit that was exceeded).
                        nullable: true
                        example: null
                      message:
                        type: string
                        description: >-
                          Additional context around why the transaction was
                          declined.
                        nullable: true
                        example: null
                card_transaction:
                  type: object
                  description: >-
                    Object containing information about the declined
                    transaction.
                  properties:
                    status:
                      type: string
                      description: Status of the card transaction.
                      example: DECLINED
                      enum:
                        - DECLINED
                    amount:
                      description: >-
                        The final amount of the card transaction (including
                        fees).
                      allOf:
                        - $ref: >-
                            #/components/schemas/Solaris-Resources-Money-With-Unit
                      example:
                        amount: 8000
                        unit: cents
                        currency: EUR
                    terminal_id:
                      type: string
                      description: Merchant ID for the terminal used for payment.
                      example: '678656789765'
                    merchant:
                      type: object
                      description: >-
                        Object containing information about the merchant where
                        the card transaction was conducted.
                      properties:
                        country_code:
                          type: string
                          description: >-
                            The merchant's country (ISO 3166 two-character
                            code).
                          example: DE
                        id:
                          type: string
                          description: The ID that the merchant provided to their acquirer.
                          example: '4556397079'
                        town:
                          type: string
                          description: Town where the merchant is located.
                          example: Frankfurt am
                        name:
                          type: string
                          description: The merchant's name.
                          example: Shady Bob
                        category_code:
                          type: string
                          description: The merchant's four-digit category code.
                          example: '5999'
                    pos_entry_mode:
                      type: string
                      description: The POS entry mode used for the reservation.
                      example: CHIP
                      enum:
                        - CARD_NOT_PRESENT
                        - CHIP
                        - CONTACTLESS
                        - MAG_STRIPE
                    attempted_at:
                      type: string
                      description: UTC timestamp from when the transaction was attempted.
                      example: '2019-04-01T12:23:42+00:00'
                    card_id:
                      type: string
                      description: ID of the card used in the declined transaction.
                      example: f459e5de647e2909c94a7120c4d03557mcrd
                    acquirer_id:
                      type: string
                      description: >-
                        An identification code (up to 11 characters) of the
                        acquiring institution.
                      example: '75638395813'
                    type:
                      type: string
                      description: The type of card transaction.
                      example: PURCHASE
                      enum:
                        - PURCHASE
                        - WITHDRAWAL
                        - OCT
                    original_amount:
                      description: >-
                        The original amount of the card transaction (minus
                        fees).
                      allOf:
                        - $ref: >-
                            #/components/schemas/Solaris-Resources-Money-With-Unit
                      example:
                        amount: 7800
                        unit: cents
                        currency: EUR
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  card_authorization_resolved:
    post:
      tags:
        - Webhook events
      summary: CARD_AUTHORIZATION_RESOLUTION
      description: >-
        A reservation for a card transaction was cancelled or booked, or it
        expired. You do not have to send the customer a push notification for
        this webhook.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the reservation.
                  example: b814e2213c5c45149945ed53422db0c4cres
                amount:
                  description: Amount of the reservation (in Euro cents).
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                reservation_type:
                  type: string
                  description: The type of reservation.
                  example: CARD_AUTHORIZATION
                  enum:
                    - CARD_AUTHORIZATION
                reference:
                  type: string
                  description: Unique reference for the authorization.
                  example: 0e30e961-9abd-41a2-bbd6-4730a22f17fd
                status:
                  type: string
                  description: The current status of the reservation.
                  example: RESOLVED
                  enum:
                    - RESOLVED
                meta_info:
                  $ref: '#/components/schemas/Solaris-Resources-MetaInfo'
                expires_at:
                  type: string
                  description: UTC timestamp when the reservation will expire.
                  example: '2020-03-30T00:00:00Z'
                expired_at:
                  type: string
                  description: >-
                    UTC timestamp from when the authorization expired (`null` if
                    it hasn't expired).
                  nullable: true
                  example: null
                resolved_at:
                  type: string
                  description: UTC timestamp from when the authorization was resolved.
                  nullable: true
                  example: '2020-03-30T00:10:00Z'
                description:
                  type: string
                  description: A description of the transaction.
                  example: PAYPAL *RECISIO KAR, 35314369001
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  card_delivery_tracking:
    post:
      tags:
        - Webhook events
      summary: CARD_DELIVERY_TRACKING
      description: New card delivery tracking information is available.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique identifier for the card tracking record.
                  example: 2ba86442-a9a1-4634-9eb8-fef3500322b3
                card_id:
                  type: string
                  description: ID of the card.
                  example: 1fe8caa4bf1f49d87b2d63c14bb565f0mcrd
                shipping_provider:
                  type: string
                  description: The shipping company that shipped the card.
                  example: DHL Express
                date_of_shipment:
                  type: string
                  format: date
                  description: >-
                    Conditional field. If shipment successfully happened, this
                    field is presenting on response and keeps shipment date
                    information. Format: yyyy-MM-dd
                  example: '2020-12-30'
                shipping_tracking_information:
                  type: string
                  description: >-
                    Conditional field. Keeps the tracking code from company. If
                    its present message will be empty
                  example: JD014600009536663804
                message:
                  type: string
                  description: >-
                    Conditional field. Keeps the error message from the
                    provider. If its present shipping_tracking_information will
                    be empty
                  example: a5844f601567db9b59b3531245a58e96cacc
                country_code:
                  type: string
                  description: >-
                    (Conditional field) Country ISO Code to represent countries,
                    dependent territories, and special areas of geographical
                    interest.
                  example: DE
                has_picture:
                  type: boolean
                  description: >-
                    (Conditional field) Flag that shows card has the picture or
                    not.
                  example: true
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  card_fraud_case_pending:
    post:
      tags:
        - Webhook events
      summary: CARD_FRAUD_CASE_PENDING
      description: >-
        A fraud case was recorded on a transaction made by a customer's card,
        and it requires the customer's immediate response (over a prompt
        provided by your frontend). See the [Cards Smart Agent
        guide](https://docs.solarisgroup.com/guides/cards/cards-smart-agent/)
        for more information.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the fraud case.
                  example: 154dca58bb1b5c8701039fa6514ffc66frdcs
                resolution:
                  type: string
                  description: The current status of the fraud case.
                  example: PENDING
                  enum:
                    - CONFIRMED
                    - PENDING
                    - TIMEOUT
                    - WHITELISTED
                respond_until:
                  type: string
                  description: >-
                    Timestamp indicating the deadline for the customer to
                    confirm that the transaction is not fraudulent.
                  example: '2020-05-05T11:54:26Z'
                whitelisted_until:
                  type: string
                  description: >-
                    Timestamp indicating how long transactions will be
                    whitelisted for the given card after confirming that a
                    transaction was not fraudulent (i.e., 10 minutes after
                    making the API call).
                  nullable: true
                  example: null
                card_transaction:
                  type: object
                  description: >-
                    Object containing information about the declined
                    transaction.
                  properties:
                    card_id:
                      type: string
                      description: ID of the card used in the declined transaction.
                      example: f459e5de647e2909c94a7120c4d03557mcrd
                    type:
                      type: string
                      description: The type of card transaction.
                      example: PURCHASE
                      enum:
                        - PURCHASE
                        - WITHDRAWAL
                        - OCT
                    status:
                      type: string
                      description: Status of the card transaction.
                      example: DECLINED
                      enum:
                        - DECLINED
                    attempted_at:
                      type: string
                      description: UTC timestamp from when the transaction was attempted.
                      example: '2019-04-01T12:23:42+00:00'
                    pos_entry_mode:
                      type: string
                      description: The POS entry mode used for the reservation.
                      example: CHIP
                      enum:
                        - CARD_NOT_PRESENT
                        - CHIP
                        - CONTACTLESS
                        - MAG_STRIPE
                    merchant:
                      type: object
                      description: >-
                        Object containing information about the merchant where
                        the card transaction was conducted.
                      properties:
                        country_code:
                          type: string
                          description: >-
                            The merchant's country (ISO 3166 two-character
                            code).
                          example: DE
                        category_code:
                          type: string
                          description: The merchant's four-digit category code.
                          example: '5999'
                        name:
                          type: string
                          description: The merchant's name.
                          example: Shady Bob
                    amount:
                      description: >-
                        The final amount of the card transaction (including
                        fees).
                      allOf:
                        - $ref: >-
                            #/components/schemas/Solaris-Resources-Money-With-Unit
                    original_amount:
                      description: >-
                        The original amount of the card transaction (minus
                        fees).
                      allOf:
                        - $ref: '#/components/schemas/Solaris-Resources-Money'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  card_fraud_case_timeout:
    post:
      tags:
        - Webhook events
      summary: CARD_FRAUD_CASE_TIMEOUT
      description: >-
        A fraud case that was recorded for a transaction with a customer's card
        did not receive a response from the customer within 30 minutes. See the
        [Cards Smart Agent
        guide](https://docs.solarisgroup.com/guides/cards/cards-smart-agent/)
        for more information.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the fraud case.
                  example: 154dca58bb1b5c8701039fa6514ffc66frdcs
                resolution:
                  type: string
                  description: The current status of the fraud case.
                  example: TIMEOUT
                  enum:
                    - CONFIRMED
                    - PENDING
                    - TIMEOUT
                    - WHITELISTED
                respond_until:
                  type: string
                  description: >-
                    Timestamp indicating the deadline for the customer to
                    confirm that the transaction is not fraudulent.
                  example: '2020-05-05T11:54:26Z'
                whitelisted_until:
                  type: string
                  description: >-
                    Timestamp indicating how long transactions will be
                    whitelisted for the given card after confirming that a
                    transaction was not fraudulent (i.e., 10 minutes after
                    making the API call).
                  nullable: true
                  example: null
                card_transaction:
                  type: object
                  description: >-
                    Object containing information about the declined
                    transaction.
                  properties:
                    card_id:
                      type: string
                      description: ID of the card used in the declined transaction.
                      example: f459e5de647e2909c94a7120c4d03557mcrd
                    type:
                      type: string
                      description: The type of card transaction.
                      example: PURCHASE
                      enum:
                        - PURCHASE
                        - WITHDRAWAL
                        - OCT
                    status:
                      type: string
                      description: Status of the card transaction.
                      example: DECLINED
                      enum:
                        - DECLINED
                    attempted_at:
                      type: string
                      description: UTC timestamp from when the transaction was attempted.
                      example: '2019-04-01T12:23:42+00:00'
                    pos_entry_mode:
                      type: string
                      description: The POS entry mode used for the reservation.
                      example: CHIP
                      enum:
                        - CARD_NOT_PRESENT
                        - CHIP
                        - CONTACTLESS
                        - MAG_STRIPE
                    merchant:
                      type: object
                      description: >-
                        Object containing information about the merchant where
                        the card transaction was conducted.
                      properties:
                        country_code:
                          type: string
                          description: >-
                            The merchant's country (ISO 3166 two-character
                            code).
                          example: DE
                        category_code:
                          type: string
                          description: The merchant's four-digit category code.
                          example: '5999'
                        name:
                          type: string
                          description: The merchant's name.
                          example: Shady Bob
                    amount:
                      description: >-
                        The final amount of the card transaction (including
                        fees).
                      allOf:
                        - $ref: >-
                            #/components/schemas/Solaris-Resources-Money-With-Unit
                    original_amount:
                      description: >-
                        The original amount of the card transaction (minus
                        fees).
                      allOf:
                        - $ref: '#/components/schemas/Solaris-Resources-Money'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  card_lifecycle_event:
    post:
      tags:
        - Webhook events
      summary: CARD_LIFECYCLE_EVENT
      description: >-
        The status of a customer's card has changed. You can find the full list
        of available statuses
        [here](https://docs.solarisgroup.com/guides/cards/creation-and-servicing/#appendix-ii-card-status-values).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the card.
                  example: 8febdba4912a747808ccc6f95f82bbb4
                status:
                  example: ACTIVE
                  allOf:
                    - $ref: '#/components/schemas/Solaris_Decorators_CardStatusEnum'
                reference:
                  type: string
                  description: Unique reference number for the card.
                  example: 87285d83-ab15-4906-af87-5763801d9e43
                type:
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Enums-CardType'
                  example: MASTERCARD_DEBIT
                expiration_date:
                  type: string
                  description: The expiration date of the card.
                  example: '2020-12-30'
                person_id:
                  type: string
                  description: ID of the cardholder person resource.
                  example: 5af2ea4271038d5c53e68ccbf4fe43b3cper
                account_id:
                  type: string
                  description: ID of the account to which the card is tied.
                  example: a5844f601567db9b59b3531245a58e96cacc
                business_id:
                  type: string
                  description: >-
                    (For business cards) ID of the business with which the card
                    is associated.
                  example: 52e6a9b8a559d842ed7d8901b0e1bf4bcbiz
                representation:
                  $ref: '#/components/schemas/Solaris_Decorators_PublicPlasticCard'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  card_token_lifecycle:
    post:
      tags:
        - Webhook events
      summary: CARD_TOKEN_LIFECYCLE
      description: >-
        A [push
        provisioning](https://docs.solarisgroup.com/guides/cards/push-provisioning/)
        token has been created or updated for a customer's card.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                card_id:
                  type: string
                  description: The ID of the card associated with the token.
                  example: 8b48d56bdc1c091d9ab5547fe0e9511bmcrd
                token_reference_id:
                  type: string
                  description: The unique reference ID of the token that was created.
                  example: DNITHE382228352676336613
                token_status:
                  type: string
                  enum:
                    - ACTIVE
                    - DEACTIVATED
                    - INACTIVE
                    - SUSPENDED
                  description: The status of the token.
                  example: ACTIVE
                event_type:
                  type: string
                  enum:
                    - TOKEN_CREATED
                    - TOKEN_STATUS_UPDATED
                    - TOKEN_ACTIVATION_STIP
                  description: The event type of the token's lifecycle.
                  example: TOKEN_CREATED
                message_reason:
                  type: string
                  description: >-
                    Token's lifecycle event reason (from VISA's constantly
                    changing message reason codes, e.g., TOKEN_CREATED). 
                  example: TOKEN_CREATED
                  enum:
                    - CALL_CENTER_ACTIVATION
                    - CARDHOLDER_STEPUP_RESULT
                    - DEVICE_PROVISIONING_REPERSONALIZATION_RESULT
                    - DEVICE_PROVISIONING_RESULT
                    - LUK_REPLENISHMENT
                    - MOBILE_BANK_APP_ACTIVATION
                    - OTP_VERIFICATION_RESULT
                    - TOKEN_CREATED
                    - TOKEN_DEACTIVATED
                    - TOKEN_DEVICE_BINDING_REMOVED
                    - TOKEN_DEVICE_BINDING_RESULT
                    - TOKEN_EXPIRY_DATE_UPDATED
                    - TOKEN_RESUME
                    - TOKEN_SUSPEND
                    - TRUSTED_LISTING_ENROLLMENT_RESULT
                client_wallet_account_id:
                  type: string
                  description: >-
                    Unique 24-byte identifier for each instance of a `[Android
                    user, Google account]` pair. Google computes the ID as a
                    keyed hash of the Android user ID and the Google account ID.
                    The key to this hash lives on Google's servers; the wallet
                    ID is created during user setup as an RPC.
                  example: Rwt3tJek_k1JxivcwbPHjKDk
                wallet_type:
                  type: string
                  enum:
                    - APPLE
                    - GOOGLE
                    - SAMSUNG
                  description: The type of the wallet.
                  example: APPLE
                visa_pan_reference_id:
                  deprecated: true
                  type: string
                  description: >-
                    ID of the Primary Account Number (PAN) reference. Only
                    appears in webhook notifications related to VISA cards.
                    **Deprecated** in favor of `pan_reference_id`.
                  example: V-3019278454673935797827
                pan_reference_id:
                  type: string
                  description: ID of the Primary Account Number (PAN) reference.
                  example: V-3019278454673935797827
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  cash_operation_status_changed:
    post:
      tags:
        - Webhook events
      summary: CASH_OPERATION_STATUS_CHANGED
      description: >-
        A customer has paid out/paid in to a [cash
        operation](https://docs.solarisgroup.com/guides/digital-banking/viacash/),
        or the cash operation has expired.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: '#/components/schemas/CashOperation'
              example:
                id: ffb18faf3c004f70a44c83b787488ceeslip
                barcode_ean13: '4053110826660'
                expires_at: '2022-01-04T09:15:59.958864Z'
                status: PAID
                reference_id: f92beb45-b46e-4733-be1a-80c085cbad0d
                person_id: 2231bdf43cf7b9041367d9ed5c6d4c7acper
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  consumer_fronting_application:
    post:
      tags:
        - Webhook events
      summary: CONSUMER_FRONTING_APPLICATION
      description: The status of a consumer loan application has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: '#/components/schemas/FrontingLoansWeb.Consumer.GetLoanResponse'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  consumer_loan_application:
    post:
      tags:
        - Webhook events
      summary: CONSUMER_LOAN_APPLICATION
      description: The status of a consumer loan application has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_uuid:
                  type: string
                  description: Resource unique ID.
                  example: c5fe9ff6a90f47708e2d865d553c24f2clap
                event_type:
                  type: string
                  description: Webhook event
                  example: CONSUMER_LOAN_APPLICATION
                payload:
                  type: object
                  description: An object containing the webhook event payload.
                  $ref: '#/components/schemas/ConsumerLoan.GetApplicationResponse'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  consumer_overdraft:
    post:
      tags:
        - Webhook events
      summary: CONSUMER_OVERDRAFT
      description: The status of a consumer overdraft has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: '#/components/schemas/OverdraftWeb.Consumer.GetOverdraftResponse'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  consumer_overdraft_application:
    post:
      tags:
        - Webhook events
      summary: CONSUMER_OVERDRAFT_APPLICATION
      description: The status of a consumer overdraft application has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: >-
                #/components/schemas/OverdraftWeb.Consumer.GetOverdraftApplicationResponse
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  credit_card_application:
    post:
      tags:
        - Webhook events
      summary: CREDIT_CARD_APPLICATION
      description: The status of a credit card application has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the credit card application.
                  example: 6e6fefdcd553468fb04555499f060b18ccla
                external_customer_id:
                  description: Arbitrary ID provided by you (e.g., membership ID).
                  type: string
                customer_id:
                  type: string
                  description: ID of the person who applied for the credit card.
                  example: 0ba2211cab11af6094d60ead81f2bd9dcper
                account_id:
                  type: string
                  description: ID of the Solaris account associated with the credit card.
                  example: c2a13abed3b0686ab5343aa748d7f2fecacc
                account_iban:
                  type: string
                  description: IBAN of the Solaris account associated with the credit card.
                  example: DE53110101013323159108
                reference_account_id:
                  type: string
                  description: ID of the reference account associated with the credit card.
                  example: d1ed02309ca52b5e636e215ff82b2d52sddm
                status:
                  type: string
                  description: The current status of the credit card.
                  enum:
                    - PENDING
                    - IN_SCORING
                    - PRE_APPROVED
                    - FINALIZING
                    - FINALIZED
                    - DECLINED
                    - TERMINATED
                    - WAITING_FOR_IDENTIFICATION
                    - IN_KNE_SCORING
                  example: PENDING
                product_type:
                  type: string
                  description: Indicates the type of credit card.
                  enum:
                    - CONSUMER_CREDIT_CARD
                    - FREELANCER_CREDIT_CARD
                    - BUSINESS_CREDIT_CARD
                  example: CONSUMER_CREDIT_CARD
                billing_start_date:
                  type: string
                  description: The start date of the current billing cycle.
                  format: date
                  example: '2022-07-01'
                billing_end_date:
                  type: string
                  description: The end date of the current billing cycle.
                  format: date
                  example: '2022-07-28'
                approved_limit:
                  description: The credit card limit approved for the customer by Solaris.
                  allOf:
                    - $ref: '#/components/schemas/amount'
                  example:
                    value: 20000
                    unit: cents
                    currency: EUR
                requested_limit:
                  description: The credit card limit requested by the customer.
                  allOf:
                    - $ref: '#/components/schemas/amount'
                  example:
                    value: 50000
                    unit: cents
                    currency: EUR
                current_limit:
                  description: >-
                    The current limit applied to the credit card. Can be less
                    than or equal to the `approved_limit`.
                  allOf:
                    - $ref: '#/components/schemas/amount'
                  example:
                    value: 15000
                    unit: cents
                    currency: EUR
                decline_reasons:
                  type: array
                  description: >-
                    An array of reasons why the credit card application was
                    declined.
                  items:
                    type: string
                    enum:
                      - DECLINED_BY_SCORING
                repayment_options:
                  description: >-
                    Object containing information about the customer's repayment
                    plan for the credit card.
                  allOf:
                    - $ref: '#/components/schemas/repayment_options'
                scoring_options:
                  description: >-
                    Object containing information about the scoring for the
                    credit card application.
                  oneOf:
                    - $ref: '#/components/schemas/consumer_scoring_options'
                    - $ref: '#/components/schemas/business_scoring_options'
                in_dunning:
                  type: boolean
                  description: >-
                    Boolean value to indicate whether the credit card is
                    currently subject to the dunning process.
                created_at:
                  type: string
                  description: >-
                    The date & time when the credit card application was
                    created.
                  example: '2023-07-26T11:59:52+00:00'
                qes_at:
                  type: string
                  description: The date of QES completion.
                  format: date
                  example: '2022-07-28'
                active_termination_id:
                  type: string
                  description: ID of the termination of the credit card application.
                  example: c7184779-3a57-5c8c-8ef4-c3aec9528531
                repayment_type_switch_available_date:
                  type: string
                  description: The date when switch to another repayment type is possible.
                  format: date
                  example: '2022-07-28'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  credit_card_application_termination:
    post:
      tags:
        - Webhook events
      summary: CREDIT_CARD_APPLICATION_TERMINATION
      description: >-
        A credit card termination was created by Solaris for one of your
        customers' credit cards, or the status of an open termination has
        changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the credit card termination.
                  example: c7184779-3a57-5c8c-8ef4-c3aec9528531
                application_id:
                  type: string
                  description: >-
                    The ID of the credit card application that is being
                    terminated.
                  example: a8cafe0c24e949c78bfbea04cb5b2905ccla
                reason:
                  type: string
                  description: The reason for the termination.
                  enum:
                    - CUSTOMER_WISH
                    - OTHER_IMMEDIATE
                    - OTHER_ORDINARY
                  example: CUSTOMER_WISH
                status:
                  type: string
                  description: The current status of the termination.
                  enum:
                    - INITIATED
                    - IN_PROGRESS
                    - COMPLETED
                    - REVOKED
                  example: IN_PROGRESS
                legally_terminated_at:
                  description: The date when the credit card termination will take effect.
                  type: string
                  format: date
                  example: '2023-08-31'
                revocable_until:
                  description: The date until which the termination can be revoked.
                  type: string
                  format: date
                  example: '2023-08-02'
                created_at:
                  description: UTC timestamp from when the termination was created.
                  type: string
                  format: date-time
                  example: '2023-07-28T14:47:00.000Z'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  credit_card_bill:
    post:
      tags:
        - Webhook events
      summary: CREDIT_CARD_BILL
      description: The status of a credit card bill has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: |
                    UUID of the bill whose status changed.
                  example: aa21dag9d713a066597474a4568fa015bill
                application_id:
                  type: string
                  description: >
                    UUID of the credit card application with which the bill is
                    associated.
                  example: 55906d353e6e4208b8172c165d2b61a1ccla
                status:
                  type: string
                  description: |
                    Status of the credit card bill.
                  enum:
                    - PENDING
                    - PAID
                    - PRELIMINARILY_PAID
                    - IN_DUNNING
                    - CLOSED
                  example: PAID
                start_date:
                  type: string
                  description: The billing cycle start date.
                  format: date
                  example: '2022-04-01'
                end_date:
                  type: string
                  description: The billing cycle end date.
                  format: date
                  example: '2022-04-30'
                statement_date:
                  type: string
                  description: Date when the statement was issued.
                  format: date
                  example: '2022-05-01'
                due_date:
                  type: string
                  description: Date when payment for this bill is due.
                  format: date
                  example: '2022-05-15'
                sdd_collection_date:
                  type: string
                  description: >-
                    Date when the SEPA Direct Debit for collecting the payment
                    will occur.
                  format: date
                  example: '2022-05-16'
                previous_bill_amount:
                  description: The amount of the previous credit card bill.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                total_outstanding_amount:
                  description: The total outstanding amount for the credit card.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                minimum_due_amount:
                  description: >-
                    The minimum payment the customer must make for this credit
                    card bill.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                outstanding_sddr_amount:
                  description: The total amount outstanding for the dunning process.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                outstanding_amount:
                  description: >-
                    The amount remaining to be paid on the current credit card
                    bill (i.e., the `total_outstanding_amount` minus any
                    previous payments).
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                current_bill_amount:
                  description: The amount of the current credit card bill.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                dunning_fees:
                  description: >-
                    The amount of dunning fees applied during this billing
                    cycle.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                other_fees:
                  description: Any other fees applied during this billing cycle.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                repayment_type:
                  type: string
                  description: >-
                    The type of credit card. Possible options are `FULL`
                    (charge) and `PARTIAL` (revolving).
                  enum:
                    - FULL
                    - PARTIAL
                grace_period_in_days:
                  type: integer
                  description: >-
                    Indicates number of days in the grace period for paying off
                    the required amount in each billing cycle.
                  example: 15
                minimum_amount:
                  description: The minimum amount to be repaid each billing cycle.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                minimum_percentage:
                  type: integer
                  description: >-
                    The minimum percentage of the outstanding balance to be
                    repaid each billing cycle.
                  example: 3
                accumulated_interest_amount:
                  description: The total amount of interest accrued.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                postbox_item_id:
                  type: string
                  description: >-
                    ID of the Postbox item that corresponds with the credit card
                    bill.
                  example: c072c6e43f4d486cb553e9cd9fc1bae7pbxi
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  credit_line_application:
    post:
      tags:
        - Webhook events
      summary: CREDIT_LINE_APPLICATION
      description: >-
        The status of a consumer credit line application has changed. Please see
        [here](https://docs.solarisgroup.com/guides/lending/splitpay/consumer-splitpay/#credit-line-webhook-events)
        all the events that trigger this webhook.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status_description:
                  type: string
                  nullable: true
                  description: Additional details about the credit line application status.
                status:
                  type: string
                  example: account_snapshot_pending
                  enum:
                    - initial_scoring_pending
                    - account_snapshot_pending
                    - account_snapshot_verification_pending
                    - identification_pending
                    - offered
                    - esign_pending
                    - esign_complete
                    - esign_failed
                    - credit_line_creation_pending
                    - credit_line_created
                    - expired
                    - deleted
                    - rejected
                    - scoring_pending
                  description: The status of a consumer credit line application.
                signing_id:
                  type: string
                  nullable: true
                  example: 7c63600ddddec4f2668893af39c1b814csig
                  description: >-
                    The ID of the signing resource, created after the customer's
                    identification and e-signing process has been triggered.
                scoring_workflow:
                  description: >-
                    An object containing certain actions required for the
                    scoring process.
                  type: object
                  properties:
                    required_actions:
                      type: array
                      description: Actions you must complete for the scoring process.
                      items:
                        type: object
                        properties:
                          required:
                            type: string
                            nullable: true
                  nullable: true
                recipient_iban:
                  type: string
                  nullable: true
                  example: DE92370601930002130041
                  description: >-
                    The IBAN of the customer's account to use for the account
                    snapshot.
                reason:
                  type: string
                  nullable: true
                  description: The reason(s) for rejecting a credit line application.
                person_id:
                  type: string
                  example: dc1a6812a14f6cc338cd084208535bcdcper
                  description: The person ID of the customer applying for the credit line.
                partner_reference_number:
                  type: string
                  nullable: true
                  description: The partner reference number.
                  example: ABHP244919
                offered_limit:
                  type: object
                  title: SolarisToolkit.Web.Money.Optional
                  nullable: true
                  description: The offered credit line limit.
                  allOf:
                    - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                offered_interest_rate:
                  type: number
                  nullable: true
                  description: The offered interest rate to apply to the credit line.
                  example: 2.5
                net_disposable_income:
                  type: object
                  title: SolarisToolkit.Web.Money.Optional
                  nullable: true
                  description: >-
                    The net disposable income available to the customer after
                    deducting all taxes.
                  allOf:
                    - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                marriage_status:
                  type: string
                  nullable: true
                  enum:
                    - MARRIED
                    - UNMARRIED
                    - DIVORCED
                    - UNKNOWN
                  description: The customer's marital status.
                  example: UNMARRIED
                identification_id:
                  type: string
                  nullable: true
                  example: 9e2e85c62230a652325964282c84559fcidt
                  description: The unique ID of a customer's identification resource.
                id:
                  type: string
                  example: 35eee37033c5436f9cbff6df1f88e097ccla
                  description: The unique ID of a consumer credit line application.
                employment_status:
                  type: string
                  nullable: true
                  enum:
                    - EMPLOYED
                    - UNEMPLOYED
                    - PUBLIC_SECTOR_EMPLOYEE
                    - PROFESSIONAL_SOLDIER
                    - FREELANCER
                    - HOUSEWORK
                    - APPRENTICE
                    - MANAGEMENT
                    - RETIRED
                    - STUDENT
                    - SELF_EMPLOYED
                    - MILITARY_OR_COMMUNITY_SERVICE
                  description: The customer's employment status.
                  example: EMPLOYED
                decision:
                  type: string
                  nullable: true
                  enum:
                    - REJECTED
                    - OFFERED
                  description: Solaris' decision on the credit line application.
                  example: OFFERED
                credit_line_id:
                  type: string
                  nullable: true
                  example: 1908331fb8384edcbfe63067366c4b6accln
                  description: >-
                    The unique ID of a credit line, generated after a credit
                    line is created.
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  credit_line:
    post:
      tags:
        - Webhook events
      summary: CREDIT_LINE
      description: >-
        One or more attributes of a credit line were changed. See
        [here](https://docs.solarisgroup.com/guides/lending/splitpay/consumer-splitpay/#credit-line-webhook-events)
        all the events that trigger this webhook. Please note that webhook
        payload is returned as a JSON-encoded string.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  description: An object containing the webhook payload.
                  properties:
                    event_type:
                      type: string
                      description: The webhook event name.
                      example: CREDIT_LINE
                    entity_uuid:
                      type: string
                      description: The resource ID of the loan.
                      example: 2d685ca48fab499a841d19fd8bcfe314ccln
                    payload:
                      type: object
                      properties:
                        account_id:
                          type: string
                          nullable: true
                          example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                          description: The unique ID of the customer's Solaris account.
                        account_iban:
                          type: string
                          nullable: true
                          example: DE25110101002910133758
                          description: The IBAN of the customer's account.
                        active_loans:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: e0167a47f385443a835050d1d9274b45cloa
                                description: The unique ID of a loan.
                          description: >-
                            An array containing the details of all active loans
                            related to the customer's credit line.     
                        granted_at:
                          type: string
                          format: datetime
                          example: '2022-02-07T11:57:42Z'
                          description: >-
                            The timestamp from when the credit line was granted
                            to a customer.
                        disposable_income:
                          type: object
                          title: SolarisToolkit.Web.Money.Optional
                          nullable: true
                          description: >-
                            The total amount of the customer's disposable
                            income.
                          allOf:
                            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                        created_at:
                          type: string
                          format: datetime
                          example: '2022-02-07T11:57:42'
                          description: The timestamp from when the credit line was created.
                        application_id:
                          type: string
                          example: 35eee37033c5436f9cbff6df1f88e097ccla
                          description: The unique ID of a credit line application.
                        annual_percentage_rate:
                          type: number
                          example: 0.11
                          description: The annual interest rate applied to the credit line.
                        latest_disposable_income:
                          type: object
                          title: SolarisToolkit.Web.Money.Optional
                          nullable: true
                          description: >-
                            The amount of the customer's latest disposable
                            income.
                          allOf:
                            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                        interest_rate:
                          type: number
                          example: 0.11
                          description: >-
                            The interest rate to apply to the credit line. This
                            field is used if there's a specific interest rate to
                            be applied for a partner.
                        id:
                          type: string
                          example: 1908331fb8384edcbfe63067366c4b6accln
                          description: >-
                            The unique ID of a credit line, generated after a
                            credit line is created.
                        person_id:
                          type: string
                          example: dc1a6812a14f6cc338cd084208535bcdcper
                          description: >-
                            The person ID of the customer applying for the
                            credit line.
                        locking_status:
                          type: string
                          example: NO_BLOCK
                          enum:
                            - BLOCK
                            - NO_BLOCK
                          description: >-
                            The locking status, which indicates whether it's
                            possible to create a loan against the credit line or
                            it's blocked.
                        limit:
                          description: The limit of the credit line.
                          allOf:
                            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                        recipient_iban:
                          type: string
                          example: DE92370601930002130041
                          description: >-
                            The IBAN of the customer's account to use for the
                            account snapshot.
                        product_type:
                          type: string
                          example: consumer
                          enum:
                            - freelancer
                            - consumer
                          description: The type of the credit line product.
                        renewal:
                          type: object
                          properties:
                            status_description:
                              type: string
                              description: Additional information about the status.
                            status:
                              type: string
                              description: Status of the credit line renewal.
                              enum:
                                - planned
                                - scoring_pending
                                - scoring_successful
                                - customer_notified
                                - cancelled
                                - renewed
                              example: customer_notified
                            rejection_date:
                              type: string
                              description: The date the renewal was rejected.
                              nullable: true
                              format: date
                              example: '2022-10-31'
                            notification_sent_date:
                              type: string
                              description: >-
                                The date the renewal notification was sent to
                                the customer.
                              nullable: true
                              format: date
                              example: '2021-01-20'
                            id:
                              type: string
                              description: ID of the credit line renewal.
                              example: 0696599d-7f0a-434b-b480-ebe5a1e20cc4
                            effective_until_date:
                              type: string
                              description: >-
                                The date until which the renewal will be
                                effective.
                              format: date
                              example: '2022-04-10'
                            effective_from_date:
                              type: string
                              description: >-
                                The date from which the renewal will be
                                effective.
                              format: date
                              example: '2022-04-10'
                            credit_line_id:
                              type: string
                              description: The ID of the credit line.
                              example: 1908331fb8384edcbfe63067366c4b6accln
                          nullable: true
                        termination_date:
                          type: string
                          nullable: true
                          format: date
                          example: '2022-02-08'
                          description: >-
                            The date when the credit line termination was
                            effective.
                        status:
                          type: string
                          example: mandate_creation_pending
                          enum:
                            - authorization_pending
                            - account_creation_pending
                            - mandate_creation_pending
                            - open
                            - closed
                          description: The status of the credit line.
                        termination_type:
                          type: string
                          nullable: true
                          example: ORDINARY_BY_CUSTOMER
                          enum:
                            - ORDINARY_BY_BANK
                            - ORDINARY_BY_CUSTOMER
                          description: The type of the credit line termination.
                        termination_requested_at:
                          type: string
                          nullable: true
                          format: date
                          example: '2022-02-07'
                          description: >-
                            The date when the credit line termination was
                            requested.
                        utilized_amount:
                          description: The utilized amount of the credit line limit.
                          allOf:
                            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  delegate_sca_cancel:
    post:
      tags:
        - Webhook events
      summary: DELEGATE_SCA_CANCEL
      description: >-
        A customer has declined the authentication process for a 3DS
        transaction. After receiving this webhook notification, you can stop
        showing the authentication screen to the customer. **Note:** This
        webhook event is only relevant for the old 3DS flow, which will be
        deprecated. The new 3DS flow using change request does not make use of
        this webhook.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: object
                  description: The transaction's amount.
                  properties:
                    value:
                      type: integer
                      description: The amount value.
                      example: 1000
                    unit:
                      type: string
                      description: The unit of the given value in cents.
                      example: cents
                    currency:
                      type: string
                      description: >-
                        The currency of the given value. Only EUR is currently
                        supported.
                      example: EUR
                merchant:
                  type: object
                  description: The merchant related to the transaction.
                  properties:
                    name:
                      type: string
                      description: The merchant's name (max 24 characters).
                      example: MCDONALDS 1435
                    country:
                      type: string
                      format: ISO 3166 alpha-2
                      description: The merchant's country (ISO 3166 two-character code).
                      example: DE
                    url:
                      type: string
                      description: The merchant's URL.
                      example: https://mcdonalds.de
                challenged_at:
                  type: string
                  format: datetime
                  description: >-
                    UTC timestamp from when the 3DS challenge was presented to
                    the customer.
                  example: '2022-11-07T13:34:27+00:00'
                expires_at:
                  type: string
                  format: datetime
                  description: UTC timestamp when the 3DS challenge was expired.
                  example: '2022-11-07T13:39:27+00:00'
                person_id:
                  type: string
                  description: >-
                    The person ID of the customer who initiated the 3DS
                    transaction.
                  example: 682a85d7e490c1360f6c2be2f1addd57cper
                card_id:
                  type: string
                  description: The ID of the card that was used for the 3DS transaction.
                  example: 03bafc5569a53a62dd02ad2e5a789b80mcrd
                authenticate_change_request_id:
                  type: string
                  description: The authorization change request ID.
                  example: bbcafe6e9cc66a4aebaa907cea325435csc
                decline_change_request_id:
                  type: string
                  description: The decline change request ID.
                  example: 6fbb54aebc42e2c5d4dc881d5cf566d6csc
                channel:
                  type: string
                  description: The channel that was used for the 3DS transaction.
                  example: browser
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  deposit_account_update:
    post:
      tags:
        - Webhook events
      summary: DEPOSIT_ACCOUNT_UPDATED
      description: >-
        The status of a mapping between a customer's main (current) account and
        a savings account has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: >-
                    ID of the mapping between the main account and the savings
                    account.
                  example: 13bc0b9d-3321-4bac-84ce-1b300a137d88
                status:
                  $ref: '#/components/schemas/DepositStatus'
                deposit_type:
                  $ref: '#/components/schemas/DepositTypes'
                deposit_account_id:
                  type: string
                  description: ID of the savings account.
                  example: e48c29b85992b8772eb7ddd518490920cacc
                main_account_id:
                  $ref: '#/components/schemas/MainAccount'
                main_account_iban:
                  type: string
                  description: >-
                    IBAN of the external or internal main
                    account.</br>`main_account_iban` is conditionally `required`
                    when the main account is external.
                  example: DE17110101000000000042
                secondary_mappings:
                  type: array
                  description: IBAN of the seconday mapped accounts
                  items:
                    type: string
                    example:
                      - DE40010101002231021978
                      - DE40010101002231021979
                updated_at:
                  type: string
                  description: UTC timestamp from when the mapping status was updated.
                  example: '2024-04-06T09:03:05.321+00:00'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  freelancer_credit_line:
    post:
      tags:
        - Webhook events
      summary: FREELANCER_CREDIT_LINE_APPLICATION
      description: The status of a freelancer credit line application has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                credit_line_id:
                  description: The unique ID of a credit line.
                  example: c5f22b00baa845869ceb3a7d90d59bffccln
                  nullable: true
                  type: string
                decision:
                  description: Solaris' decision on the credit line request.
                  enum:
                    - OFFERED
                    - PENDING
                    - REJECTED
                  example: REJECTED
                  type: string
                id:
                  description: The unique ID of a freelancer credit line application.
                  example: 7d903b7483294e3b902b89097d699dbdccla
                  type: string
                identification_id:
                  description: >-
                    The unique identification ID of a freelancer, generated
                    after completing the freelancer identification process.
                  example: 51462340e8653f8e2864801e8ebb4131cidt
                  nullable: true
                  type: string
                mandate_reference_number:
                  description: >-
                    The reference number of the mandate applicable on the credit
                    line.
                  example: LXD3RGLRTP6HHM
                  nullable: true
                  type: string
                net_disposable_income:
                  allOf:
                    - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                  description: >-
                    The net disposable income amount available after deducting
                    taxes and all other expenses.
                  nullable: true
                  title: SolarisToolkit.Web.Money.Optional
                  type: object
                offered_interest_rate:
                  description: Solaris' offered interest rate on the installment loan.
                  example: 0.11
                  nullable: true
                  type: number
                offered_limit:
                  allOf:
                    - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                  description: >-
                    The amount of the credit line limit offered to the
                    freelancer.
                  nullable: true
                  title: SolarisToolkit.Web.Money.Optional
                  type: object
                person_id:
                  description: >-
                    The unique person ID, generated after completing the person
                    onboarding process.
                  example: ad8f5cefdc73035f17973fecb4fa2ebccper
                  type: string
                reason:
                  description: Solaris' decision on the credit line request.
                  nullable: true
                  type: string
                recipient_iban:
                  description: The IBAN of the beneficiary's account.
                  example: DE13110101014386274299
                  nullable: true
                  type: string
                status:
                  description: The status of the credit line application.
                  enum:
                    - credit_record_pending
                    - initial_scoring_pending
                    - account_snapshot_pending
                    - account_snapshot_verification_pending
                    - offered
                    - identification_creation_pending
                    - identification_pending
                    - identification_completed
                    - rejected
                    - expired
                    - credit_line_creation_pending
                    - credit_line_created
                  example: rejected
                  type: string
                status_description:
                  description: The description of the credit line application's status.
                  example: Rejected by Scorer
                  nullable: true
                  type: string
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  incoming_rejected_transaction:
    post:
      tags:
        - Webhook events
      summary: INCOMING_REJECTED_TRANSACTION
      description: >-
        An incoming transaction to an account was rejected. This webhook is
        relevant for [Restricted
        Accounts](https://docs.solarisgroup.com/guides/digital-banking/restricted-accounts),
        [Decoupled
        Cards](https://docs.solarisgroup.com/guides/cards/decoupled-cards/), and
        [Credit
        Cards](https://docs.solarisgroup.com/guides/cards/credit-cards/). The
        webhook payload will differ depending on the product.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/incoming_rejected_transaction_cards'
                - $ref: '#/components/schemas/incoming_rejected_transaction_wallets'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  identification:
    post:
      tags:
        - Webhook events
      summary: IDENTIFICATION
      description: >-
        A person identification was created, or its status was updated. The
        primary purpose of this webhook is to deliver the URL where the customer
        must be redirected to complete a video identification.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the person identification.
                  example: 9dfe2f4edaa67138be0c0c1cd3a7d849cidt
                reference:
                  type: string
                  description: Reference generated by the identification provider.
                  example: TST-ELCCJ
                url:
                  type: string
                  description: >-
                    (IDnow only) Redirect URL used to start the identification
                    process.
                  example: https://go.test.idnow.de/
                status:
                  type: string
                  description: >-
                    The current status of the identification. **Note** The
                    status value depends on the identification method, check the
                    [KYC guides](https://docs.solarisgroup.com/guides/kyc) for
                    more information.
                  example: successful
                  enum:
                    - aborted
                    - authorization_required
                    - confirmation_required
                    - confirmed
                    - created
                    - canceled
                    - expired
                    - failed
                    - identification_data_required
                    - pending
                    - pending_successful
                    - pending_failed
                    - processed
                    - rejected
                    - successful
                    - signed
                    - pre_successful
                    - pending_account_creation
                    - pending_ref_transfer
                completed_at:
                  type: string
                  description: Date and time when the identification was completed.
                  example: '2021-09-14T18:18:28.000Z'
                method:
                  type: string
                  description: The method used for the identification.
                  example: idnow
                  enum:
                    - bank
                    - bank_id
                    - bank_plus
                    - fourthline
                    - idnow
                    - idnow_autoident
                    - manual
                    - postident
                metadata:
                  type: object
                  properties:
                    account_bic:
                      type: string
                      description: (bank_plus only) The BIC to apply to the account.
                      example: SOBKDEB2XXX
                    account_currency:
                      type: string
                      description: (bank_plus only) The currency of the account.
                      example: EUR
                      enum:
                        - CAD
                        - CHF
                        - CNY
                        - DKK
                        - EUR
                        - GBP
                        - HKD
                        - JPY
                        - NOK
                        - SEK
                        - SGD
                        - USD
                        - AED
                        - ALL
                        - AMD
                        - ANG
                        - AOA
                        - ARS
                        - AUD
                        - AZN
                        - BAM
                        - BBD
                        - BDT
                        - BGN
                        - BHD
                        - BMD
                        - BND
                        - BOB
                        - BRL
                        - BTN
                        - BZD
                        - CLP
                        - COP
                        - CRC
                        - CUP
                        - CVE
                        - CZK
                        - DJF
                        - DOP
                        - DZD
                        - ETB
                        - FJD
                        - GEL
                        - GTQ
                        - GYD
                        - HNL
                        - HRK
                        - HTG
                        - HUF
                        - IDR
                        - ILS
                        - INR
                        - JMD
                        - JOD
                        - KES
                        - KRW
                        - KWD
                        - KYD
                        - KZT
                        - LAK
                        - LKR
                        - LRD
                        - LSL
                        - MAD
                        - MDL
                        - MGA
                        - MKD
                        - MOP
                        - MUR
                        - MVR
                        - MWK
                        - MXN
                        - MYR
                        - MZN
                        - NAD
                        - NPR
                        - NZD
                        - OMR
                        - PEN
                        - PGK
                        - PHP
                        - PLN
                        - PYG
                        - QAR
                        - RON
                        - RSD
                        - RUB
                        - RWF
                        - SAR
                        - SCR
                        - SLL
                        - SRD
                        - STN
                        - SVC
                        - SZL
                        - THB
                        - TJS
                        - TRY
                        - TWD
                        - TZS
                        - UAH
                        - UGX
                        - UYU
                        - UZS
                        - VND
                        - XPF
                        - ZAR
                        - ZMW
                        - EMONEY_EUR
                    account_id:
                      type: string
                      description: (bank_plus only) ID of the account.
                    iban:
                      type: string
                      description: (bank_plus only) IBAN of the account.
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  identification_origination:
    post:
      tags:
        - Webhook events
      summary: IDENTIFICATION_ORIGINATION
      description: The status of an identification origination has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: >-
                #/components/schemas/IdentificationOriginationWeb.GetIdentificationOriginationResponse
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  identification_reference_transfer_attempt:
    post:
      tags:
        - Webhook events
      summary: IDENTIFICATION_REFERENCE_TRANSFER_ATTEMPT
      description: >-
        Optional webhook for bank_plus identification. Notifies about the
        remaining number of reference transfer attempts.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the person identification.
                  example: 9dfe2f4edaa67138be0c0c1cd3a7d849cidt
                method:
                  type: string
                  description: The method used for the identification.
                  example: bank_plus
                person_id:
                  type: string
                  description: ID of the person.
                  example: 992de312a545bb24a88ddbf57ae8b1ffcper
                remaining_attempts:
                  type: integer
                  description: Remaining attempts for the reference transfer.
                  example: 2
                Reason:
                  type: string
                  description: Reason for the failure of reference transfer.
                  example: name_not_matched
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  identification_session:
    post:
      tags:
        - Webhook events
      summary: IDENTIFICATION_SESSION
      description: The status of an identification session has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  description: The status of an identification session.
                  example: created
                person_id:
                  type: string
                  description: >-
                    The person ID of the customer associated with the
                    identification session.
                  example: 4f6a8804cb45155c2e544019e47cef22cper
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  instant_sepa_credit_transfer_executed:
    post:
      tags:
        - Webhook events
      summary: INSTANT_SEPA_CREDIT_TRANSFER_EXECUTED
      description: >-
        An outgoing SEPA Instant Credit Transfer was successfully executed and
        booked on the account.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  maxLength: 35
                  description: The ID of the transaction.
                amount:
                  type: object
                  description: The transaction amount.
                  properties:
                    value:
                      type: integer
                      description: The amount value in cents.
                    currency:
                      type: string
                      description: >-
                        The currency of the given value. Only EUR is currently
                        supported.
                creditor_iban:
                  type: string
                  description: >-
                    The IBAN of the creditor account (i.e., the account holder
                    receiving the money). The IBAN must be reachable via SCT
                    Instant!
                creditor_name:
                  type: string
                  description: The name of the creditor (i.e., account holder).
                  maxLength: 70
                description:
                  type: string
                  description: A description for the transaction given by the customer.
                  maxLength: 140
                end_to_end_id:
                  type: string
                  description: Your unique end-to-end ID for the transaction.
                  maxLength: 35
                status:
                  type: string
                  description: >-
                    The status of the Instant SCT. Only possible value is
                    `CLEARED`.
                valuta_date:
                  type: string
                  format: date
                  description: The valuta date of the transaction.
                account_id:
                  type: string
                  description: The ID of the account associated with the instant SCT.
                account_iban:
                  type: string
                  description: The IBAN of the account associated with the instant SCT.
                schedule_id:
                  type: string
                  description: Unique ID of the schedule transfer.
                  example: f874b3102718a4d757a6b6e4d599607csctr
                batch_id:
                  type: string
                  description: Unique ID of the batch.
                  example: f874b3102718a4d757a6b6e4d5996078sctb
              example:
                id: e8308bd66d3472a987d262d05fb5098siot
                amount:
                  value: 3000
                  currency: EUR
                creditor_iban: Lisa Herrmann
                creditor_name: DE02500105170137075030
                description: Geschenk
                end_to_end_id: e2178fc8b9ad4a479e269a47f90b4a43
                initiator_reference: 2603037c-e264-46c4-82e8-0d3ebc23a30f
                idempotency_key: 7352a11b-011d-47a4-a449-17371078e98c
                status: CLEARED
                valuta_date: '2022-04-22'
                account_id: adc123a45d6d7cf8fbfeed537ba919d5cacc
                account_iban: DE87110101001000057123
                schedule_id: f874b3102718a4d757a6b6e4d599607csctr
                batch_id: f874b3102718a4d757a6b6e4d5996078sctb
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  instant_sepa_credit_transfer_failed:
    post:
      tags:
        - Webhook events
      summary: INSTANT_SEPA_CREDIT_TRANSFER_FAILED
      description: >-
        An outgoing SEPA Instant Credit Transfer has failed and has not been
        booked on the account.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  maxLength: 35
                  description: The ID of the transaction.
                amount:
                  type: object
                  description: The transaction amount.
                  properties:
                    value:
                      type: integer
                      description: The amount value in cents.
                    currency:
                      type: string
                      description: >-
                        The currency of the given value. Only EUR is currently
                        supported.
                creditor_iban:
                  type: string
                  description: >-
                    The IBAN of the creditor account (i.e., the account holder
                    receiving the money). The IBAN must be reachable via SCT
                    Instant!
                creditor_name:
                  type: string
                  description: The name of the creditor (i.e., account holder).
                  maxLength: 70
                description:
                  type: string
                  description: A description for the transaction given by the customer.
                  maxLength: 140
                end_to_end_id:
                  type: string
                  description: Your unique end-to-end ID for the transaction.
                  maxLength: 35
                status:
                  type: string
                  description: >-
                    The status of the Instant SCT. Only possible value is
                    `FAILED`.
                valuta_date:
                  type: string
                  format: date
                  description: The valuta date of the transaction.
                account_id:
                  type: string
                  description: The ID of the account associated with the instant SCT.
                account_iban:
                  type: string
                  description: The IBAN of the account associated with the instant SCT.
                rejection_reason:
                  type: string
                  description: Reason why the transaction failed.
                schedule_id:
                  type: string
                  description: Unique ID of the schedule transfer.
                  example: f874b3102718a4d757a6b6e4d599607csctr
                batch_id:
                  type: string
                  description: Unique ID of the batch.
                  example: f874b3102718a4d757a6b6e4d5996078sctb
              example:
                id: e8308bd66d3472a987d262d05fb5098siot
                amount:
                  value: 3000
                  currency: EUR
                creditor_iban: Lisa Herrmann
                creditor_name: DE02500105170137075030
                description: Geschenk
                end_to_end_id: e2178fc8b9ad4a479e269a47f90b4a43
                initiator_reference: 2603037c-e264-46c4-82e8-0d3ebc23a30f
                idempotency_key: 7352a11b-011d-47a4-a449-17371078e98c
                status: FAILED
                valuta_date: '2022-04-22'
                account_id: adc123a45d6d7cf8fbfeed537ba919d5cacc
                account_iban: DE87110101001000057123
                rejection_reason: IBAN not reachable
                schedule_id: f874b3102718a4d757a6b6e4d599607csctr
                batch_id: f874b3102718a4d757a6b6e4d5996078sctb
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  legal_representative:
    post:
      tags:
        - Webhook events
      summary: LEGAL_REPRESENTATIVE
      description: >-
        A legal representative was linked to, or unlinked from, a business.
        Solaris will send notifications on this webhook if more legal
        representatives are discovered during the business identification
        process.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the legal representative relationship.
                  example: a46578f4049f42aba9fe88a2a80fed53
                legal_representative_id:
                  type: string
                  description: >-
                    ID of the person or business with the legal authority to
                    represent the business.
                  example: 33fbdd2c0bb94db1af5b5d2a4426cper
                legal_representative_type:
                  type: string
                  description: >-
                    The type of legal representative that this record
                    represents.
                  enum:
                    - Person
                    - Business
                  example: Person
                valid_until:
                  type: string
                  description: Date when the legal representative relationship expires.
                  example: '2022-12-31'
                business_id:
                  type: string
                  description: >-
                    ID of the business for which the person or business is a
                    legal representative.
                  example: 095cc43012a04ccca02f0f93c145cbiz
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  loan:
    post:
      tags:
        - Webhook events
      summary: LOAN
      description: >-
        The status of a customer's loan has changed. Please note that webhook
        payload is returned as a JSON-encoded string.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
                  description: An object containing the webhook payload.
                  properties:
                    total_loan_expenses:
                      type: object
                      nullable: true
                      description: >-
                        An object representing the loan total expenses (e.g.,
                        costs and expenses the lender incurred during a loan
                        lifecycle).
                      allOf:
                        - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                    term:
                      type: number
                      example: 24
                      description: The number of months over which the loan will be repaid.
                    status_reason:
                      type: string
                      nullable: true
                      enum:
                        - upfront_subsidy_pull_failed_collateral_account_not_set
                        - upfront_subsidy_pull_failed_debit_blocked
                        - upfront_subsidy_pull_failed_insufficient_funds
                      description: Additional context around the loan status.
                    status:
                      type: string
                      example: payout_issued
                      enum:
                        - payout_initiation_pending
                        - payout_initiation_blocked
                        - payout_pending
                        - payout_issued
                        - all_obligations_met
                      description: The loan's status.
                    repayment_plan_updated_at:
                      type: string
                      nullable: true
                      format: datetime
                      example: '2021-04-16T13:52:05Z'
                      description: >-
                        The date when the loan's repayment plan was last
                        updated.
                    repayment_plan_created_at:
                      type: string
                      nullable: true
                      format: datetime
                      example: '2020-04-16T13:52:05Z'
                      description: The date when the loan's repayment plan was created.
                    repayment_begin_date:
                      type: string
                      example: '2020-05-16'
                      description: >-
                        The date when the loan's first monthly installment is
                        due.
                    reference:
                      type: string
                      nullable: true
                      description: A reference for the loan.
                    recipient_iban:
                      type: string
                      example: DE88888881010987654321
                      description: The IBAN to which the loan is paid out.
                    purpose:
                      type: string
                      nullable: true
                      example: Buying a car.
                      description: The purpose of the loan.
                    person_id:
                      type: string
                      example: 547a870b2c8461a3104559369d09265dcper
                      description: The person ID of the customer getting the loan.
                    payout_date:
                      type: string
                      format: date
                      example: '2020-05-16'
                      description: The date when the loan will be paid out.
                    overdue_amount:
                      description: An object representing the loan overdue amount.
                      allOf:
                        - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                    monthly_payment:
                      type: object
                      nullable: true
                      description: >-
                        An object representing the loan monthly installment
                        amount.
                      allOf:
                        - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                    maturity_date:
                      type: string
                      nullable: true
                      example: '2022-05-16'
                      description: The date when the final loan payment is due.
                    loan_account_id:
                      type: string
                      nullable: true
                      example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                      description: The account ID to which the loan is attached.
                    loan_account_iban:
                      type: string
                      nullable: true
                      example: DE72110101014351836685
                      description: The IBAN of the account to which the loan is attached.
                    interest_start_date:
                      type: string
                      format: date
                      example: '2021-06-16'
                      description: The date when the interest starts accruing on a loan.
                    interest_rate:
                      type: number
                      example: 0.0499
                      description: The monthly interest rate applied to a loan.
                    id:
                      type: string
                      example: c13447d659db4cdcb450b977f8f25c57cloa
                      description: The ID of the loan.
                    effective_interest_rate:
                      type: number
                      example: 0.0511
                      description: The annual effective interest rate applied to the loan.
                    created_at:
                      type: string
                      format: datetime
                      example: '2021-06-16T10:22:38'
                      description: The date when the loan was created.
                    billing_account_id:
                      type: string
                      nullable: true
                      example: 1d0e52af0a62b4b44d8c54a87a7fc6a7cacc
                      description: >-
                        The ID of the customer's billing account from which all
                        the loan payments will be debited.
                    billing_account_iban:
                      type: string
                      nullable: true
                      example: DE72110101014351836685
                      description: >-
                        The IBAN of the customer's billing account associated
                        with the loan.
                    annual_percentage_rate:
                      type: number
                      description: >-
                        A percentage that represents the yearly cost of funds
                        over the term of a loan. It includes interest, fees and
                        additional costs associated with a loan.
                    amount:
                      description: The loan amount.
                      allOf:
                        - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                event_type:
                  type: string
                  description: The webhook event name.
                  example: LOAN
                entity_uuid:
                  type: string
                  description: The resource ID of the loan.
                  example: 82d78c39956645ffbd59c51cdb63f7b0cloa
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  message:
    post:
      tags:
        - Webhook events
      summary: MESSAGE
      description: The message to a customer
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type: string
                  description: ID of the account for which the message is being sent.
                  example: c2a13abed3b0686ab5343aa748d7f2fecacc
                channel:
                  type: string
                  description: The notification channel used to send the message.
                  enum:
                    - any
                    - email
                  example: email
                person_id:
                  type: string
                  description: >-
                    ID of the person associated to whom the message is being
                    sent.
                  example: 0ba2211cab11af6094d60ead81f2bd9dcper
                title:
                  type: string
                  description: The title of the message.
                  example: Ihre Samsung Pay Bezahlung
                text:
                  type: string
                  description: The text of the message.
                business_id:
                  type: string
                  description: ID of the business to whom the message is being sent.
                  example: 567eaf2b22fce21a1920e14e11e2bfa3cbiz
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  overdraft:
    post:
      tags:
        - Webhook events
      summary: OVERDRAFT
      description: The status of a freelancer overdraft has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: >-
                #/components/schemas/OverdraftWeb.Freelancer.GetOverdraftResponse
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  overdraft_application:
    post:
      tags:
        - Webhook events
      summary: OVERDRAFT_APPLICATION
      description: The status of a freelancer overdraft application has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: >-
                #/components/schemas/OverdraftWeb.Freelancer.GetOverdraftApplicationResponse
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  overdraft_limit_change:
    post:
      tags:
        - Webhook events
      summary: OVERDRAFT_LIMIT_CHANGE
      description: The overdraft limit on a consumer's account has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the overdraft.
                  example: e26cd100ba0e4ddea88f6e34f0a911aeovlc
                limit_at_creation_time:
                  $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                overdraft_id:
                  type: string
                  description: The ID of the existing consumer overdraft.
                  example: fe906914c27f442ea86711b9a099d75dcovd
                requested_limit:
                  $ref: '#/components/schemas/SolarisToolkit.Web.Money'
                status:
                  type: string
                  description: The status of the limit change request.
                  example: attached
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  person_changed:
    post:
      tags:
        - Webhook events
      summary: PERSON_CHANGED
      description: >-
        One or more attributes of a person were changed. This webhook does not
        come with a payload. The header will contain the ID of the person that
        was changed.
      parameters:
        - in: header
          name: Solaris-Entity-Id
          description: Contains the ID of the person whose data changed.
          schema:
            type: string
            example: c724a8d510c5294affadf8c95a8119b5cper
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  person_deleted:
    post:
      tags:
        - Webhook events
      summary: PERSON_DELETED
      description: >-
        This webhook event occurs when Solaris deletes all personal data related
        to the given person from its system according to GDPR regulations.  <br>
        **Note:** Solaris is legally required to delete records of created
        persons who did not become customers within 90 days of collecting the
        personal data according to GDPR regulations. When you receive a
        notification of this type, you must **immediately delete all data**
        related to the person specified in the webhook notification.
      parameters:
        - in: header
          name: Solaris-Entity-Id
          description: Contains the ID of the person whose data you must delete.
          schema:
            type: string
            example: c724a8d510c5294affadf8c95a8119b5cper
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  person_mobile_number_created:
    post:
      tags:
        - Webhook events
      summary: PERSON_MOBILE_NUMBER_CREATED
      description: >-
        A mobile number was created for a customer, but has not yet been
        verified. This webhook does not contain a payload, but the header will
        contain the id of the person for whom the mobile number was created.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  person_mobile_number_deleted:
    post:
      tags:
        - Webhook events
      summary: PERSON_MOBILE_NUMBER_DELETED
      description: A customer's mobile number was deleted.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the customer's mobile number that was deleted.
                  example: 244de401cf4ddbbbafbbc657312a7ce7cmno
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  person_seizure_created:
    post:
      tags:
        - Webhook events
      summary: PERSON_SEIZURE_CREATED
      description: >-
        Solaris has received a request from the authorities (e.g., court,
        governmental agency) to seize the account(s) of a `person`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the seizure resource.
                  example: 211c5c2f34ac442ff6f93d09fc8fb3edseiz
                enactment_date:
                  type: string
                  description: The date when the authority issued the seizure.
                  format: date
                  example: '2019-01-31'
                delivery_date:
                  type: string
                  description: The date when the seizure notice was delivered to Solaris.
                  example: '2019-01-28'
                authority_name:
                  type: string
                  description: The name of the authority that issued the seizure.
                  example: Court
                resolution_case_number:
                  type: string
                  description: >-
                    The seizure's case ID number, generated by the issuing
                    authority.
                  example: Number 212121212
                seizure_type:
                  type: string
                  description: The type of seizure.
                  example: COURT_SEIZURE
                  enum:
                    - ATTACHMENT
                    - AUTHORITY_SEIZURE
                    - COURT_SEIZURE
                    - PRE_ATTACHMENT
                status:
                  type: string
                  description: The current status of the seizure.
                  example: ACTIVE
                  enum:
                    - ACTIVE
                    - FULFILLED
                    - WAITING_FOR_AUTHORITY
                amount:
                  type: object
                  description: Object that represents the amount of the debt.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                additional_cost:
                  type: object
                  description: Additional costs of the seizure.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                debtor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    debtor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureDebtor
                creditor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    creditor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditor
                creditor_representative:
                  type: object
                  description: >-
                    Object containing information about a person or an entity
                    that represents the creditor (i.e., a third-party liaison
                    between the debtor and creditor).
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditorRepresentative
                automatic_payout_date:
                  type: string
                  description: The automatic payout date of the seizure amount.
                  example: '2022-01-29'
                insolvency:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there's an insolvency case
                    related to the customer.
                  example: false
                social_benefits:
                  type: boolean
                  description: >-
                    Field to indicate whether or not social benefits are
                    applicable to the customer.
                  example: false
                seizure_protected:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there's a seizure
                    protection related to the customer.
                  example: false
                automated:
                  type: boolean
                  description: >-
                    Field to indicate whether or not the seizure will be
                    processed automatically or manually.
                  example: true
                country:
                  type: string
                  description: The country in which the seizure happened.
                  example: DE
                multiple_drittschuldner:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there are multiple third
                    party debtors related to the customer.
                  example: true
                customer_id:
                  type: string
                  description: >-
                    The person or business ID of the customer whose account has
                    the seizure.
                  example: dc1a6812a14f6cc338cd084208535bcdcper
                customer_type:
                  type: string
                  description: The type of customer whose account has the seizure.
                  example: Person
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  person_seizure_deleted:
    post:
      tags:
        - Webhook events
      summary: PERSON_SEIZURE_DELETED
      description: >-
        Solaris has removed a seizure for a `person` because it was created by
        mistake.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the seizure resource.
                  example: 211c5c2f34ac442ff6f93d09fc8fb3edseiz
                enactment_date:
                  type: string
                  description: The date when the authority issued the seizure.
                  format: date
                  example: '2019-01-31'
                delivery_date:
                  type: string
                  description: The date when the seizure notice was delivered to Solaris.
                  example: '2019-01-28'
                authority_name:
                  type: string
                  description: The name of the authority that issued the seizure.
                  example: Court
                resolution_case_number:
                  type: string
                  description: >-
                    The seizure's case ID number, generated by the issuing
                    authority.
                  example: Number 212121212
                seizure_type:
                  type: string
                  description: The type of seizure.
                  example: COURT_SEIZURE
                  enum:
                    - ATTACHMENT
                    - AUTHORITY_SEIZURE
                    - COURT_SEIZURE
                    - PRE_ATTACHMENT
                status:
                  type: string
                  description: The current status of the seizure.
                  example: ACTIVE
                  enum:
                    - ACTIVE
                    - FULFILLED
                    - WAITING_FOR_AUTHORITY
                amount:
                  type: object
                  description: Object that represents the amount of the debt.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                additional_cost:
                  type: object
                  description: Additional costs of the seizure.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                debtor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    debtor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureDebtor
                creditor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    creditor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditor
                creditor_representative:
                  type: object
                  description: >-
                    Object containing information about a person or an entity
                    that represents the creditor (i.e., a third-party liaison
                    between the debtor and creditor).
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditorRepresentative
                customer_id:
                  type: string
                  description: >-
                    The person or business ID of the customer whose seizure was
                    deleted.
                  example: dc1a6812a14f6cc338cd084208535bcdcper
                customer_type:
                  type: string
                  description: The type of customer whose account has the seizure.
                  example: Person
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  person_seizure_fulfilled:
    post:
      tags:
        - Webhook events
      summary: PERSON_SEIZURE_FULFILLED
      description: The status of a `seizure` on a `person` has changed to `FULFILLED`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the seizure resource.
                  example: 211c5c2f34ac442ff6f93d09fc8fb3edseiz
                enactment_date:
                  type: string
                  description: The date when the authority issued the seizure.
                  format: date
                  example: '2019-01-31'
                delivery_date:
                  type: string
                  description: The date when the seizure notice was delivered to Solaris.
                  example: '2019-01-28'
                authority_name:
                  type: string
                  description: The name of the authority that issued the seizure.
                  example: Court
                resolution_case_number:
                  type: string
                  description: >-
                    The seizure's case ID number, generated by the issuing
                    authority.
                  example: Number 212121212
                seizure_type:
                  type: string
                  description: The type of seizure.
                  example: COURT_SEIZURE
                  enum:
                    - ATTACHMENT
                    - AUTHORITY_SEIZURE
                    - COURT_SEIZURE
                    - PRE_ATTACHMENT
                status:
                  type: string
                  description: The current status of the seizure.
                  example: FULFILLED
                  enum:
                    - ACTIVE
                    - FULFILLED
                    - WAITING_FOR_AUTHORITY
                amount:
                  type: object
                  description: Object that represents the amount of the debt.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                additional_cost:
                  type: object
                  description: Additional costs of the seizure.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                debtor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    debtor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureDebtor
                creditor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    creditor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditor
                creditor_representative:
                  type: object
                  description: >-
                    Object containing information about a person or an entity
                    that represents the creditor (i.e., a third-party liaison
                    between the debtor and creditor).
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditorRepresentative
                customer_id:
                  type: string
                  description: >-
                    The person or business ID of the customer whose seizure was
                    fulfilled.
                  example: dc1a6812a14f6cc338cd084208535bcdcper
                customer_type:
                  type: string
                  description: The type of customer whose account has the seizure.
                  example: Person
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  person_seizure_updated:
    post:
      tags:
        - Webhook events
      summary: PERSON_SEIZURE_UPDATED
      description: >-
        The processing method for a `seizure` for a person has switched from
        automated to manual.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the seizure resource.
                  example: 211c5c2f34ac442ff6f93d09fc8fb3edseiz
                enactment_date:
                  type: string
                  description: The date when the authority issued the seizure.
                  format: date
                  example: '2019-01-31'
                delivery_date:
                  type: string
                  description: The date when the seizure notice was delivered to Solaris.
                  example: '2019-01-28'
                authority_name:
                  type: string
                  description: The name of the authority that issued the seizure.
                  example: Court
                resolution_case_number:
                  type: string
                  description: >-
                    The seizure's case ID number, generated by the issuing
                    authority.
                  example: Number 212121212
                seizure_type:
                  type: string
                  description: The type of seizure.
                  example: COURT_SEIZURE
                  enum:
                    - ATTACHMENT
                    - AUTHORITY_SEIZURE
                    - COURT_SEIZURE
                    - PRE_ATTACHMENT
                status:
                  type: string
                  description: The current status of the seizure.
                  example: ACTIVE
                  enum:
                    - ACTIVE
                    - FULFILLED
                    - WAITING_FOR_AUTHORITY
                amount:
                  type: object
                  description: Object that represents the amount of the debt.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                additional_cost:
                  type: object
                  description: Additional costs of the seizure.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                debtor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    debtor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureDebtor
                creditor:
                  type: object
                  description: >-
                    Object that contains the name and address information of the
                    creditor.
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditor
                creditor_representative:
                  type: object
                  description: >-
                    Object containing information about a person or an entity
                    that represents the creditor (i.e., a third-party liaison
                    between the debtor and creditor).
                  allOf:
                    - $ref: >-
                        #/components/schemas/Solaris-Server-Decorators-SeizureCreditorRepresentative
                automatic_payout_date:
                  type: string
                  description: The automatic payout date of the seizure amount.
                  example: '2022-01-29'
                insolvency:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there's an insolvency case
                    related to the customer.
                  example: false
                social_benefits:
                  type: boolean
                  description: >-
                    Field to indicate whether or not social benefits are
                    applicable to the customer.
                  example: false
                seizure_protected:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there's a seizure
                    protection related to the customer.
                  example: false
                automated:
                  type: boolean
                  description: >-
                    Field to indicate whether or not the seizure will be
                    processed automatically or manually.
                  example: false
                country:
                  type: string
                  description: The country in which the seizure happened.
                  example: DE
                multiple_drittschuldner:
                  type: boolean
                  description: >-
                    Field to indicate whether or not there are multiple third
                    party debtors related to the customer.
                  example: true
                customer_id:
                  type: string
                  description: >-
                    The person or business ID of the customer whose account has
                    the seizure.
                  example: dc1a6812a14f6cc338cd084208535bcdcper
                customer_type:
                  type: string
                  description: The type of customer whose account has the seizure.
                  example: Person
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  person_tax_identification_changed:
    post:
      tags:
        - Webhook events
      summary: PERSON_TAX_IDENTIFICATION_CHANGED
      description: >-
        The tax identification number of a person was modified. The webhook
        contains the id of the relevant person tax identification in the header
        and the id of the relevant person in the payload.
      parameters:
        - in: header
          name: Solaris-Entity-Id
          description: >-
            ID of the person tax identification that triggered the webhook
            notification.
          schema:
            type: string
            example: cba4289c773b7450482ee88a6e5126e9ctin
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: >-
                    The person ID of the customer whose tax identification has
                    changed.
                  example: dc1a6812a14f6cc338cd084208535bcdcper
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  postbox_item_created:
    post:
      tags:
        - Webhook events
      summary: "POSTBOX_ITEM_CREATED\_"
      description: >-
        Solaris has published a new item, and it is now available via
        [Postbox](https://docs.solarisgroup.com/guides/compliance/postbox/).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: '#/components/schemas/ItemResponse'
            example:
              id: c072c6e43f4d486cb553e9cd9fc1bae7pbxi
              belongs_to: dc1a6812a14f6cc338cd084208535bcdcper
              owner_type: Person
              created_at: '2021-10-22T05:23:30Z'
              document_date: '2021-06-30'
              document_type: BALANCE_CONFIRMATION
              name: Account statement for June 2021
              description: >-
                This account statement includes all bookings from the given
                period of time
              customer_notification: false
              customer_confirmation: false
              document_size: 66092
              document_content_type: image/jpeg
              document_id: e953cbf8af064839b3e3bf2568d1130fpbxd
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  potential_account_blocking:
    post:
      tags:
        - Webhook events
      summary: POTENTIAL_ACCOUNT_BLOCKING
      description: >-
        The customer's identification document is about to expire. If no valid
        identification document is submitted by the blocking date, the account
        will be blocked.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                blocking_date:
                  type: string
                  description: The date by which the account will be blocked.
                  example: '2022-10-09'
                reason:
                  type: string
                  description: Reason why the account will be blocked.
                  example: IDENTIFICATION_DOCUMENT_EXPIRED
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  questions_require_response:
    post:
      tags:
        - Webhook events
      summary: QUESTIONS_REQUIRE_RESPONSE
      description: >-
        Solaris has created a set of follow-up questions for one of your
        customers. The payload will contain information about the question set
        itself and a list of all the questions in the set.

        For more information, see the [Questions and Answers
        guide](https://docs.solarisgroup.com/guides/compliance/questions-and-answers).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                question_set_id:
                  type: string
                  description: ID of the question set created by Solaris.
                entity_id:
                  type: string
                  description: >-
                    ID of the entity (person or business) to whom the question
                    set is assigned.
                context_id:
                  type: string
                  description: >-
                    The ID of an additional Solaris resource related to the
                    question set (e.g., an identification).
                deadline:
                  type: string
                  format: date-time
                  description: The deadline for answering all questions in the set.
                recipient:
                  type: object
                  description: >-
                    Object containing information about the question set
                    recipient.
                  properties:
                    recipient_id:
                      type: string
                      description: >-
                        ID of the question set recipient. If the `entity_id`
                        corresponds with a business, then the `recipient_id`
                        will correspond with a person associated with the
                        business.
                    recipient_type:
                      description: >-
                        Indicates who should answer the questions (either you or
                        the customer).
                      enum:
                        - CUSTOMER
                        - PARTNER
                questions:
                  type: array
                  description: Array containing all the questions in the question set.
                  items:
                    $ref: '#/components/schemas/Solaris-Server-Decorators-Question'
              example:
                question_set_id: cf860f53574c1ca743232feaf1c81e71cqst
                entity_id: fd950f53574c1ca743232feaf1c81e71cper
                context_id: fd950f53574c1ca743232feaf1c81e71cedd
                deadline: '2022-09-15T11:20:16.840208Z'
                recipient:
                  recipient_id: ea950f53574c1ca743232feeaf1c81e71cper
                  recipient_type: CUSTOMER
                questions:
                  - id: 1f0130f81d84ed3c75b32c428d5d7d93cqst
                    question: Provide your current address.
                    answer_type: TEXT_AND_FILES
                    deadline: '2022-09-15T11:20:16.840208Z'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  reference_account_created:
    post:
      tags:
        - Webhook events
      summary: REFERENCE_ACCOUNT_CREATED
      description: >-
        A customer has registered a new reference account for payouts used with
        restricted accounts.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: >-
                    ID of the customer's restricted account to which the
                    reference account is linked.
                  example: 9876827fc63a639ee829racc
                status:
                  type: string
                  description: Status of the reference account.
                  example: ACTIVE
                iban:
                  type: string
                  description: The IBAN of the reference account.
                  example: DE12345678900122
                account_id:
                  type: string
                  description: ID of the DiBa account connected.
                  example: 4ee59da2-83a4-4910-b771-4de07d41c2e9
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  reference_account_instant_payout_declined:
    post:
      tags:
        - Webhook events
      summary: REFERENCE_ACCOUNT_INSTANT_PAYOUT_DECLINED
      description: >-
        An instant reference account payout was declined, and no booking was
        made on the account.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the payout.
                reference:
                  type: string
                  description: >-
                    A unique reference for the payout. Used as an idempotency
                    key.
                status:
                  type: string
                  description: Current status of the payout.
                end_to_end_id:
                  type: string
                  description: End-to-end ID of the payout.
                description:
                  type: string
                  description: A description for the payout.
                reference_account_id:
                  type: string
                  description: ID of the reference account to which the payout is directed.
                decline_reason:
                  type: string
                  description: >-
                    Contains a reason why the payout was declined if the
                    `status` is `DECLINED`.
                decline_reason_details:
                  type: string
                  description: >-
                    Contains a detailed reason why the payout was declined if
                    the `status` is `DECLINED`.
                amount:
                  description: Amount of the payout.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                instant:
                  type: boolean
                  description: >-
                    A field to indicate whether the transaction is instant or
                    not.
              example:
                id: 4b157d71def54b5c9dac28ef1d04432c
                reference: 9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669
                status: DECLINED
                end_to_end_id: end_to_end_ref
                description: Payout description
                reference_account_id: 78f354e508314bb8ac982a3d7f969dde
                instant: true
                decline_reason: Insufficient funds
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  reference_account_instant_payout_executed:
    post:
      tags:
        - Webhook events
      summary: REFERENCE_ACCOUNT_INSTANT_PAYOUT_EXECUTED
      description: >-
        An instant reference account payout was successful and a booking was
        made on the account.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the payout.
                reference:
                  type: string
                  description: >-
                    A unique reference for the payout. Used as an idempotency
                    key.
                status:
                  type: string
                  description: Current status of the payout.
                end_to_end_id:
                  type: string
                  description: End-to-end ID of the payout.
                description:
                  type: string
                  description: A description for the payout.
                reference_account_id:
                  type: string
                  description: ID of the reference account to which the payout is directed.
                decline_reason:
                  type: string
                  description: >-
                    Contains a technical code for the payout if the `status` is 
                    `DECLINED`. Check `decline_reason_details` for more
                    information.
                decline_reason_details:
                  type: string
                  description: >-
                    Contains a detailed reason why the payout was declined if
                    the `status` is `DECLINED`.
                amount:
                  description: Amount of the payout.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                instant:
                  type: boolean
                  description: >-
                    A field to indicate whether the transaction is instant or
                    not.
              example:
                id: 4b157d71def54b5c9dac28ef1d04432c
                reference: 9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669
                status: EXECUTED
                end_to_end_id: end_to_end_ref
                description: Payout description
                reference_account_id: 78f354e508314bb8ac982a3d7f969dde
                instant: true
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  reservation_created:
    post:
      tags:
        - Webhook events
      summary: RESERVATION_CREATED
      description: >-
        A reservation was created on a customer's account. This webhook event is
        only for seizure-related reservations.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the reservation that was created.
                  example: b814e2213c5c45149945ed53422db0c4cres
                amount:
                  type: object
                  description: Amount of the reservation (in Euro cents).
                  properties:
                    value:
                      type: integer
                      example: 800
                    unit:
                      type: string
                      example: cents
                    currency:
                      type: string
                      example: EUR
                reservation_type:
                  type: string
                  description: The type of reservation.
                  example: SEIZURE
                  enum:
                    - CARD_AUTHORIZATION
                    - CLEARING_TRANSACTION
                    - INTRA_CUSTOMER_TRANSFER
                    - SEIZURE
                    - SEPA_CREDIT_BATCH
                    - SEPA_CREDIT_TRANSFER
                    - ProtectedAccountSeizure
                    - SEPAInstantCreditTransfer
                reference:
                  type: string
                  description: Reference number for the reservation.
                  example: 1234567example
                status:
                  type: string
                  description: >-
                    The current status of the reservation. Possible values are
                    `OPEN` and `RESOLVED`.
                  example: OPEN
                  enum:
                    - OPEN
                    - RESOLVED
                description:
                  type: string
                  description: Seizure-related reservation.
                iban:
                  type: string
                  description: IBAN of the account on which the reservation was created.
                  example: DE87110101001000057123
                account_id:
                  type: string
                  description: ID of the account on which the reservation was created.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                created_at:
                  type: string
                  description: >-
                    UTC timestamp from when the reservation was created on the
                    account.
                  example: '2022-05-19T13:30:30Z'
                resolved_at:
                  type: string
                  description: >-
                    UTC timestamp from when the reservation was resolved on the
                    account.
                meta_info:
                  $ref: '#/components/schemas/Solaris-Resources-MetaInfo'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  reservation_resolved:
    post:
      tags:
        - Webhook events
      summary: RESERVATION_RESOLVED
      description: >-
        A reservation on a customer's account was resolved. This webhook event
        is only for seizure-related reservations.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the reservation that was resolved.
                  example: b814e2213c5c45149945ed53422db0c4cres
                amount:
                  type: object
                  description: Amount of the reservation (in Euro cents).
                  properties:
                    value:
                      type: integer
                      example: 800
                    unit:
                      type: string
                      example: cents
                    currency:
                      type: string
                      example: EUR
                reservation_type:
                  type: string
                  description: The type of reservation.
                  example: SEIZURE
                  enum:
                    - CARD_AUTHORIZATION
                    - CLEARING_TRANSACTION
                    - INTRA_CUSTOMER_TRANSFER
                    - SEIZURE
                    - SEPA_CREDIT_BATCH
                    - SEPA_CREDIT_TRANSFER
                    - ProtectedAccountSeizure
                    - SEPAInstantCreditTransfer
                reference:
                  type: string
                  description: Reference number for the reservation.
                  example: 1234567example
                status:
                  type: string
                  description: >-
                    The current status of the reservation. Possible values are
                    `OPEN` and `RESOLVED`.
                  example: RESOLVED
                  enum:
                    - OPEN
                    - RESOLVED
                description:
                  type: string
                  description: Seizure-related reservation.
                iban:
                  type: string
                  description: IBAN of the account on which the reservation was created.
                  example: DE87110101001000057123
                account_id:
                  type: string
                  description: ID of the account on which the reservation was created.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                created_at:
                  type: string
                  description: >-
                    UTC timestamp from when the reservation was created on the
                    account.
                  example: '2022-05-19T13:30:30Z'
                resolved_at:
                  type: string
                  description: >-
                    UTC timestamp from when the reservation was resolved on the
                    account.
                  example: '2022-08-19T13:30:30Z'
                meta_info:
                  $ref: '#/components/schemas/Solaris-Resources-MetaInfo'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  sca_challenge:
    post:
      tags:
        - Webhook events
      summary: SCA_CHALLENGE
      description: >-
        A customer has made a purchase or performed a card servicing operation
        (e.g., adding a card to a Google or Apple Pay wallet) that requires
        authentication.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: object
                  description: The transaction's amount.
                  properties:
                    value:
                      type: integer
                      description: The amount value.
                      example: 1000
                    unit:
                      type: string
                      description: The unit of the given value in cents.
                      example: cents
                    currency:
                      type: string
                      description: The currency of the given value.
                      example: EUR
                merchant:
                  type: object
                  description: The merchant related to the transaction.
                  properties:
                    name:
                      type: string
                      description: The merchant's name (max 24 characters).
                      example: MCDONALDS 1435
                    country:
                      type: string
                      format: ISO 3166 alpha-2
                      description: The merchant's country (ISO 3166 two-character code).
                      example: DE
                    url:
                      type: string
                      description: The merchant's URL.
                      example: https://mcdonalds.de
                challenged_at:
                  type: string
                  format: datetime
                  description: >-
                    UTC timestamp from when the authentication challenge was
                    presented to the customer.
                  example: '2022-11-07T13:34:27+00:00'
                expires_at:
                  type: string
                  format: datetime
                  description: >-
                    UTC timestamp from when the authentication challenge was
                    expired.
                  example: '2022-11-07T13:39:27+00:00'
                person_id:
                  type: string
                  description: >-
                    The person ID of the customer who initiated the action
                    requiring authentication.
                  example: 682a85d7e490c1360f6c2be2f1addd57cper
                card_id:
                  type: string
                  description: The ID of the card that was used for the transaction.
                  example: 03bafc5569a53a62dd02ad2e5a789b80mcrd
                authenticate_change_request_id:
                  type: string
                  description: The authorization change request ID.
                  example: bbcafe6e9cc66a4aebaa907cea325435csc
                decline_change_request_id:
                  type: string
                  description: The decline change request ID.
                  example: 6fbb54aebc42e2c5d4dc881d5cf566d6csc
                challenge_id:
                  type: string
                  description: >-
                    ID of the SCA challenge. Use this parameter for declining
                    the transaction.
                  example: 8bc7c682cf2b47fbb0da40146h2gscachal
                channel:
                  type: string
                  description: The channel that was used for the transaction.
                  example: browser
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  SDD_COLLECTION_APPLICATION:
    post:
      tags:
        - Webhook events
      summary: SDD_COLLECTION_APPLICATION
      description: >-
        To start receiving updates about application [Decoupled
        Cards](https://docs.solarisgroup.com/guides/cards/decoupled-cards/)
        product.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              properties:
                id:
                  type: string
                  description: ID of the SDD collection application.
                  example: dec2961f594045159195ca66e55fd6ea
                person_id:
                  type: string
                  description: ID of the person who created the SDD collection application.
                  example: ec71f4b0456b424b97cc8be75b2c77d4
                credit_record_id:
                  type: string
                  description: The `credit_record_id` of the SDD collection application.
                  example: 84f468eacc7a4784ba0d4b0b577a9265
                sdd_collection_id:
                  type: string
                  description: ID of the SDD collection.
                  example: c06fbfcc98b04376a9f220c4578932e4
                account_snapshot_id:
                  type: string
                  description: ID of the relevant account snapshot record.
                  example: 973a5f01ed7a416fadfed954c5bce782
                status:
                  type: string
                  description: The current status of the SDD collection application.
                  example: pending
                decision:
                  type: string
                  description: The decision taken on the SDD collection application.
                  example: OFFERED
                  enum:
                    - OFFERED
                    - REJECTED
                rejection_reasons:
                  type: array
                  description: >-
                    An array of reasons why the SDD collection application was
                    rejected.
                  items:
                    type: string
                    example: probability_of_default
                    enum:
                      - not_preferred_alternate_offer
                      - probability_of_default
                created_at:
                  type: string
                  format: date-time
                  description: UTC timestamp from when the application was created.
                  example: '2021-10-20T14:45:54Z'
                limit:
                  type: object
                  properties:
                    value:
                      type: integer
                      description: The amount, in Euro cents.
                      example: 10000
                    unit:
                      type: string
                      description: The unit of the given value.
                      example: cents
                    currency:
                      type: string
                      description: The currency.
                      example: EUR
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  sepa_credit_transaction_declined:
    post:
      tags:
        - Webhook events
      summary: SEPA_CREDIT_TRANSACTION_DECLINED
      description: >-
        A SEPA Credit Transfer conducted by one of your customers was declined.
        The transaction may have initially been accepted, but then something
        changed (e.g., a block was placed on the account, the balance proved to
        be insufficient) and the transaction was declined instead of executed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique ID of the transaction.
                  example: 45bd0881-a79a-4054-9286-f11060d5511f
                status:
                  type: string
                  description: Status of the transaction.
                  example: declined
                reference:
                  type: string
                  description: Optional unique reference. Used as an idempotency key.
                  example: 8880a72c-2675-482d-8d88-70a02c608592
                amount:
                  description: The amount of the transaction.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
                description:
                  type: string
                  description: >-
                    Additional description about the transaction. Please note
                    the [SEPA character
                    restrictions.](https://docs.solarisgroup.com/api-reference/standards/#sepa-characters)
                recipient_iban:
                  type: string
                  description: The recipient's IBAN.
                  example: DE87110101001000057123
                recipient_name:
                  type: string
                  description: >-
                    The recipient's name. Please note the [SEPA character
                    restrictions.](https://docs.solarisgroup.com/api-reference/standards/#sepa-characters)
                  example: Max Mustermann
                recipient_bic:
                  type: string
                  description: The recipient's BIC.
                  example: SOBKDEB2XXX
                end_to_end_id:
                  type: string
                  description: >-
                    SEPA identifier provided by the transaction initiator, which
                    will be routed throughout the whole payment process. Please
                    note the [SEPA character
                    restrictions.](https://docs.solarisgroup.com/api-reference/standards/#sepa-characters)
                  example: END2ENDREJ
                schedule_id:
                  type: string
                  description: Unique ID of the schedule transfer.
                  example: f874b3102718a4d757a6b6e4d599607csctr
                batch_id:
                  type: string
                  description: Unique ID of the batch.
                  example: d6c778822b2d7bd3b778935bcfd0d1d3csc
                created_at:
                  type: string
                  format: date-time
                  description: UTC timestamp from when the transaction was created.
                  example: '2021-01-01T20:37:50Z'
                rejection_reason:
                  type: string
                  description: Reason why the transaction failed.
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  SEPA_DIRECT_DEBIT_TRANSACTION_SCHEDULED:
    post:
      tags:
        - Webhook events
      summary: SEPA_DIRECT_DEBIT_TRANSACTION_SCHEDULED
      description: >-
        A SEPA Direct Debit (SDD) transaction was scheduled on a customer's
        account.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type: string
                  description: >-
                    The ID of the account on which the SDD transaction was
                    scheduled.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
                collection_sequence:
                  type: string
                  description: The collection sequence of the SDD transaction.
                  example: FRST
                  enum:
                    - FRST
                    - RCUR
                    - OOFF
                    - FNAL
                amount:
                  type: object
                  description: The amount of the SDD transaction in Euro cents.
                  properties:
                    value:
                      type: integer
                      example: 800
                    unit:
                      type: string
                      example: cents
                    currency:
                      type: string
                      example: EUR
                valuta_date:
                  type: string
                  format: date
                  description: The date on which the SDD transaction will be executed.
                description:
                  type: string
                  description: Description of the SDD transaction.
                  example: inv:123cust:456
                end_to_end_id:
                  type: string
                  description: End-to-end ID of the SDD transaction.
                  example: REFX123X123X456
                transaction_id:
                  type: string
                  description: >-
                    Unique ID of the transaction. Same as the transaction ID in
                    the booking resource.
                  example: E8B845AC29AD49D294FC833A0342FE5A
                creditor_id:
                  type: string
                  description: Creditor ID of the SDD transaction.
                  example: DE00ZZZ00000000005
                creditor_name:
                  type: string
                  description: The name of the creditor.
                  example: Vodafone GmbH
                creditor_iban:
                  type: string
                  description: The creditor IBAN.
                  example: DE84110101019999999999
                creditor_bic:
                  type: string
                  description: The creditor BIC.
                  example: BANKDEBBXXX
                debtor_name:
                  type: string
                  description: The name of the debtor.
                  example: Bob Mustermann
                debtor_iban:
                  type: string
                  description: The debtor IBAN.
                  example: DE75110101013333333333
                debtor_bic:
                  type: string
                  description: The debtor BIC.
                  example: SOBKDEB2XXX
      responses:
        '200':
          description: Webhook event received successfully.
  sepa_direct_debit_return:
    post:
      tags:
        - Webhook events
      summary: SEPA_DIRECT_DEBIT_RETURN
      description: >-
        A SEPA Direct Debit return notification was created because a SEPA
        Direct Debit collection from a customer's account did not meet the
        payment acceptance criteria, which led to Solaris declining the
        transaction. The payload will contain information about the SDD return,
        including its return code.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: >-
                #/components/schemas/Solaris-Server-Decorators-SepaDirectDebitReturn
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  sepa_scheduled_transaction:
    post:
      tags:
        - Webhook events
      summary: SEPA_SCHEDULED_TRANSACTION
      description: >-
        A standing order was either executed or declined. Use this webhook to
        stay informed about the progression of standing orders and to connect
        each step in the process with its corresponding booking (or absence
        thereof).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the relevant standing order.
                  example: c14ed45ced80f17a1ecc62214db2738ccsto
                account_id:
                  type: string
                  description: The account ID associated with the standing order.
                  example: 008cad63f317721e582ba99eefff219fcacc
                processed_at:
                  type: string
                  description: UTC timestamp from when the transaction was processed.
                  example: '2017-10-21T00:50:00.438Z'
                reference:
                  type: string
                  description: >-
                    Optional reference for the transaction. Will act as an
                    idempotency key.
                  example: Reference-56eb879fae8faa2f6d14f87161cst
                source:
                  type: string
                  description: Transaction source.
                  example: standing_order
                source_id:
                  type: string
                  description: ID of the transaction's source.
                  example: c14ed45ced80f17a1ecc62214db2738ccsto
                status:
                  type: string
                  description: Status of the standing order.
                  example: EXECUTED
                decline_reason:
                  type: array
                  description: >-
                    An array containing the reasons why the standing order was
                    declined.
                transaction_id:
                  type: string
                  description: ID of the transaction.
                  example: 49a57d88276df2e440cdd2e7eec291ctrx
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  sepa_standing_order:
    post:
      tags:
        - Webhook events
      summary: SEPA_STANDING_ORDER
      description: >-
        A standing order has been canceled, either by Solaris (due to account
        closure or insufficient funds) or by the customer.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the standing order that has been canceled.
                  example: 8b5c66882e8ab88369002f5da2659ec5csto
                reference:
                  type: string
                  description: >-
                    The reference ID of the standing order that has been
                    canceled.
                  example: dsf2r3raedfs3fsf342fctrx
                status:
                  type: string
                  description: Status of the standing order.
                  example: CANCELED
                account_id:
                  type: string
                  description: The account ID related to the canceled standing order.
                  example: bb8a31f9fb313e6f8cc3859a2c2ea625cacc
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  sepa_timed_order:
    post:
      tags:
        - Webhook events
      summary: SEPA_TIMED_ORDER
      description: A timed order was executed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the executed timed order.
                  example: 472730af12864d458b2f04b58404fe43ctor
                reference:
                  type: string
                  description: The reference ID of the executed timed order.
                  example: ref00514262
                status:
                  type: string
                  description: Status of the timed order.
                  example: EXECUTED
                account_id:
                  type: string
                  description: The account ID related to the executed timed order.
                  example: 4f14b0bc9d306241d3a0044420dadd4acacc
                processed_at:
                  type: string
                  description: UTC timestamp from when the timed order was executed.
                  example: '2022-04-06T09:03:05.321Z'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  scheduled_transfer_status_changed:
    post:
      tags:
        - Webhook events
      summary: SCHEDULED_TRANSFER_STATUS_CHANGED
      description: >-
        This webhook event is triggered when the status of a scheduled transfer
        changes.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the scheduled_transfer.
                  example: b814e2213c5c45149945ed53422db0c4sctr
                status:
                  type: string
                  description: >-
                    The current status of the scheduled_transfer. Possible
                    values are `ACTIVE`, `CANCELED` and `CONCLUDED`.
                  example: CONCLUDED
                  enum:
                    - ACTIVE
                    - CANCELED
                    - CONCLUDED
                account_id:
                  type: string
                  description: >-
                    ID of the account on which the scheduled_transfer was
                    created.
                  example: adc123a45d6d7cf8fbfeed537ba919d5cacc
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  tax_exemption_update:
    post:
      tags:
        - Webhook events
      summary: TAX_EXEMPTION_UPDATED
      description: The status of a tax exemption request has changed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the tax exemption request.
                  example: 93bc0b9d-3321-4bac-84ce-1b300a137d7e
                deposit_type:
                  $ref: '#/components/schemas/DepositTypes'
                deposit_account_id:
                  type: string
                  description: ID of the savings account.
                  example: e48c29b85992b8772eb7ddd518490920cacc
                main_account_id:
                  type: string
                  description: >-
                    ID of the internal main account.</br>`main_account_id` is
                    conditionally `required` when `main_account_iban` is null or
                    empty.
                  example: 148c29b85992b8772eb7ddd518490110cacc
                main_account_iban:
                  type: string
                  description: >-
                    IBAN of the external main account.</br>`main_account_iban`
                    is conditionally `required` when `main_account_id` is null
                    or empty.
                  example: DE17110101000000000042
                exemption_type:
                  type: string
                  description: Indicates the exemption request type.
                  enum:
                    - CREATE
                    - UPDATE
                    - CLOSE
                    - DELETE
                status:
                  $ref: '#/components/schemas/TaxExemptionStatus'
                failure_reason:
                  $ref: '#/components/schemas/TaxExemptionfailureReason'
                amount:
                  description: The amount to be exempted from tax.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                valid_from_year:
                  type: string
                  example: '2023'
                  description: Year from which the tax exemption order takes effect.
                valid_to_year:
                  type: string
                  example: '2025'
                  description: Year until which the tax exemption order applies.
                updated_at:
                  type: string
                  description: >-
                    UTC timestamp from when the savings account mapping was
                    executed.
                  example: '2024-04-06T09:03:05.321+00:00'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  TAX_EXEMPTION_UTILIZATION:
    post:
      tags:
        - Webhook events
      summary: TAX_EXEMPTION_UTILIZATION
      description: >-
        The utilization details of the tax exemption allowance granted for a
        savings account.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: ID of the tax exemption request.
                  example: 93bc0b9d-3321-4bac-84ce-1b300a137d7e
                deposit_type:
                  description: The account type.
                  type: string
                  enum:
                    - SAVINGS_ACCOUNT
                deposit_account_id:
                  type: string
                  description: ID of the savings account.
                  example: e48c29b85992b8772eb7ddd518490920cacc
                main_account_id:
                  type: string
                  description: ID of the main account.
                  example: 148c29b85992b8772eb7ddd518490110cacc
                request_status:
                  type: string
                  description: The current status of the request.
                  example: SUCCESS
                  enum:
                    - OPENED
                    - SUCCESS
                    - FAILED
                failure_reason:
                  type: string
                  nullable: true
                  description: >-
                    In case the tax exemption request failed, this field will
                    contain the reason.
                  example: ''
                tax_allowance_amount:
                  description: >-
                    The amount of the tax exemption allowance granted for a
                    savings account. This amount will not be taxed.
                  allOf:
                    - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
                tax_allowance_used_amount:
                  description: The used balance from the tax exemption allowance.
                  type: object
                  properties:
                    value:
                      type: integer
                      description: The amount.
                      example: 1000
                    unit:
                      type: string
                      description: Money unit used to represent the amount.
                      example: cents
                    currency:
                      type: string
                      description: The currency in which the amount is represented.
                      example: EUR
                tax_allowance_remaining_amount:
                  description: >-
                    The remaining balance from the tax exemption allowance to be
                    utilized.
                  type: object
                  properties:
                    value:
                      type: integer
                      description: The amount.
                      example: 4000
                    unit:
                      type: string
                      description: Money unit used to represent the amount.
                      example: cents
                    currency:
                      type: string
                      description: The currency in which the amount is represented.
                      example: EUR
                tax_exemption_status:
                  type: string
                  description: The current status of the tax exemption order.
                  example: ACTIVE
                  enum:
                    - ACTIVE
                    - INACTIVE
                    - DELETED
                    - EXPIRED
                    - INVALID
                valid_from_year:
                  type: string
                  example: '2023'
                  description: Year from which the tax exemption order takes effect.
                valid_to_year:
                  type: string
                  example: '2025'
                  description: Year until which the tax exemption order applies.
                updated_at:
                  type: string
                  description: >-
                    UTC timestamp from when the savings account mapping was
                    executed.
                  example: '2024-04-06T09:03:05.321+00:00'
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
  TRUSTED_IBAN_CONFIRMED:
    post:
      tags:
        - Webhook events
      summary: TRUSTED_IBAN_CONFIRMED
      description: >-
        This webhook is triggered when a trusted IBAN is confirmed. The webhook
        contains information about the IBAN that was trusted and who approved
        the action.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: >-
                    The unique identifier of the trusted IBAN. This ID is used
                    to reference the trusted IBAN in other API calls.
                  example: 60d277e8-36dc-4ecb-8842-6b61977cba52
                iban:
                  type: string
                  description: >-
                    The International Bank Account Number (IBAN) that has been
                    trusted. This is the account number that will be used for
                    transactions.
                  example: DE89370400440532013000
                account_id:
                  type: string
                  description: >-
                    The unique identifier of the account associated with the
                    trusted IBAN. This ID is used to reference the account in
                    other API calls.
                  example: 46b3938833cbad04c394e5a08da9ec58cacc
                approved_by:
                  type: string
                  description: >-
                    The unique identifier of the person who approved the trusted
                    IBAN.
                  example: fa74fe785db7e128ddfcc1eec18fbb6ccper
      responses:
        '200':
          description: >-
            Return `200` to indicate that you successfully received the webhook
            notification.
components:
  schemas:
    Solaris-Server-Decorators-Webhook:
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the webhook.
          example: 4c6f93d4c8d427927257e2ce734a5a10
        event_type:
          type: string
          description: Type of webhook event.
          example: IDENTIFICATION
        url:
          type: string
          description: The recipient URL of the event notification.
          example: https://example.com/identification
        secret:
          type: string
          description: >-
            A key phrase used to verify the authenticity of received webhook
            messages.
          example: f82c389fb187274227186b5a58781978
    Error400:
      type: object
      properties:
        id:
          type: string
          example: a95f2aaf-4e0c-4d49-8021-8a16a884ed86
        status:
          type: string
          example: '400'
        code:
          type: string
          example: build_pagination_headers_failure
        title:
          type: string
          example: Failed to build pagination headers.
        detail:
          type: string
          example: Cannot connect to database.
    Error403:
      type: object
      properties:
        id:
          type: string
          example: a95f2aaf-4e0c-4d49-8021-8a16a884ed86
        status:
          type: string
          example: '403'
        code:
          type: string
          example: unauthorized_action
        title:
          type: string
          example: Unauthorized Action
        detail:
          type: string
          example: Unauthorized action is not allowed.
    Error404:
      type: object
      properties:
        id:
          type: string
          example: a95f2aaf-4e0c-4d49-8021-8a16a884ed86
        status:
          type: string
          example: '404'
        code:
          type: string
          example: model_not_found
        title:
          type: string
          example: Model Not Found
        detail:
          type: string
          example: >-
            Couldn't find 'Solaris::Identification' for id
            'bbbcccfff388923eb899a5852df6cidt'.
    Error500:
      type: object
      properties:
        id:
          type: string
          example: e8915041-9d8c-4d96-9dd1-04e8522ecdbf
        status:
          type: string
          example: '500'
        code:
          type: string
          example: generic_error
        title:
          type: string
          example: Generic Error
        detail:
          type: string
          example: There was an error.
    closure_reason_enum:
      type: string
      description: >-
        List of possible reasons for an account closure request initiated by
        Solaris.
      example: COMPLIANCE_IMMEDIATE_INTERNAL
      enum:
        - ACCOUNT_REVOCATION
        - ACCOUNT_REVOCATION_INTERNAL
        - COMPLIANCE_IMMEDIATE_INTERNAL
        - COMPLIANCE_ORDINARY_INTERNAL
        - CUSTOMER_WISH
        - CUSTOMER_WISH_INTERNAL
        - DUNNING_DECOUPLED_CARD_INTERNAL
        - INSOLVENCY_IMMEDIATE_INTERNAL
        - INSOLVENCY_ORDINARY_INTERNAL
        - PARTNER_SERVICE_ACCOUNT_TERMINATED
        - RELATIONSHIP_TERMINATION
        - RELATIONSHIP_TERMINATION_INTERNAL
        - SEIZURES_ORDINARY_INTERNAL
        - TECHNICAL_IMMEDIATE_INTERNAL
    status_enum:
      type: string
      description: Possible status values for an account closure request.
      example: IN_PROGRESS
      enum:
        - INITIATED
        - CONFIRMED
        - IN_PROGRESS
        - COMPLETED
        - FAILED
        - REVOKED
    account_closure_request:
      type: object
      properties:
        id:
          type: string
          description: ID of the account closure request.
          example: f8d7fbbd587047a0aa449ce69d2d6c08acrq
        closure_reason:
          description: The reason for the account closure.
          allOf:
            - $ref: '#/components/schemas/closure_reason_enum'
        status:
          description: Status of the account closure request.
          allOf:
            - $ref: '#/components/schemas/status_enum'
        account_id:
          type: string
          description: ID of the account to be closed.
          example: 5526853938474f3e92b22a03ea57a544cacc
        technical_closure_date:
          type: string
          format: date
          example: '2021-10-11'
          description: The date when the account was removed from the Solaris system.
        legal_closure_date:
          type: string
          format: date
          example: '2021-10-11'
          description: >-
            The date when the contractual relationship underlying the
            product/account ends.
        failure_reason:
          type: object
          description: >-
            An object containing information about the reason why an account
            closure request has failed.
          properties:
            code:
              type: string
              description: Code value describing the failure_reason.
              enum:
                - account_inactive
                - negative_balance
                - positive_balance
                - accrued_interest
                - forced_failure
                - processing_timeout
            detail:
              type: string
              description: >-
                Additional details about the failure_reason. Check the guide for
                the
                [mapping](https://docs.solarisgroup.com/guides/compliance/account-closure/#failure-reasons)
                between the values of the fields `code` and `detail`.
              enum:
                - Account already technically closed.
                - Account balance is negative, can't perform technical closure.
                - Account balance is positive, can't perform technical closure.
                - >-
                  Accrued interest found on the account, can't perform technical
                  closure.
                - >-
                  Account Closure was manually stopped. Please contact Solaris
                  Customer Support for details.
                - >-
                  Account Closure failed. Please contact Solaris Customer
                  Support for details.
          example:
            code: negative_balance
            detail: Account balance is negative, can't perform technical closure.
        payout_allowed:
          type: boolean
          description: >-
            payout_allowed is deciding whether the funds can be paid out in the
            automated process, but it also serves as information for the Partner
            on whether or not the Customer is allowed to pay out funds from the
            account.
          enum:
            - false
            - true
        updated_at:
          type: string
          format: date-time
          description: Updated date and time
          example: '2021-12-22T15:05:33.634Z'
    account_opening_request_status_enum:
      type: string
      description: The status of the account opening request.
      example: COMPLETED
      enum:
        - INITIATED
        - IN_PROGRESS
        - COMPLETED
        - REJECTED
    account_opening_request_error_code_enum:
      type: string
      description: Code value describing the failure_reason.
      enum:
        - existing_customer
        - alltime_accounts_count_below_set_limit
        - active_accounts_count_below_set_limit
    account_opening_request_error_detail_enum:
      type: string
      description: Additional details about the failure_reason.
      enum:
        - The provided customer does not exist or provided identifier is wrong.
        - >-
          A new account cannot be opened when set limits for given account type
          are reached.
        - >-
          A new account cannot be opened when set limits for given active
          account type are reached.
    AccountSnapshotWeb.AccountSnapshot.ShowAccountSnapshotResponse:
      x-struct: >-
        Elixir.AccountSnapshotWeb.V1.AccountSnapshots.ShowOperationView.ShowAccountSnapshotResponse
      type: object
      title: AccountSnapshotWeb.AccountSnapshot.ShowAccountSnapshotResponse
      required:
        - id
        - status
        - provider
      properties:
        wizard_session_key:
          type: string
          description: >-
            The wizard key session. Only relevant if the `source` is
            `FIN_TEC_SYSTEMS`.
          example: wiz04852083740
          nullable: true
        status_description:
          type: string
          description: Additional context around the account snapshot status.
          nullable: true
        status:
          type: string
          description: The status of the account snapshot.
          example: available
          enum:
            - pending
            - available
            - expired
            - failed
        provider:
          type: string
          description: The provider of the account snapshot.
          example: FINREACH
        location:
          type: string
          description: >-
            The URL to which you must redirect the customer to complete the
            account snapshot. Only relevant if `source` is `FINREACH`.
          example: https://ui.solaris-i.prod.finleap.cloud?token=xxxxxx
          nullable: true
        id:
          type: string
          description: The ID of the account snapshot resource.
          example: 6c8f81a234df4052a9cde197577347b7snap
        iban:
          type: string
          description: >-
            The customer's IBAN to be used for the account snapshot. Only
            relevant if the `source` is `FIN_TEC_SYSTEMS` or `FINREACH`.
          example: DE87110101001000057123
          nullable: true
        account_id:
          type: string
          description: >-
            The customer's account ID to be used to initiate a Solarisbank
            account snapshot. Only relevant if the `source` is `SOLARISBANK`.
          example: adc123a45d6d7cf8fbfeed537ba919d5cacc
          nullable: true
    MoneyBase:
      type: object
      properties:
        value:
          type: integer
          description: The amount in Euro cents.
          example: 10000
        currency:
          type: string
          enum:
            - EUR
          description: The currency of the Top-Up.
    TopupStatusValues:
      type: string
      enum:
        - ACCEPTED
        - CONFIRMED
        - EXECUTED
        - DECLINED
        - CANCELLED
      description: The current status of the Top-Up.
    Solaris-Enums-BookingType:
      type: string
      description: >-
        The type of the booking. See the [booking
        documentation](https://docs.solarisgroup.com/guides/digital-banking/account-management/#appendix-i-booking-types)
        for a list of explanations for each booking type.
      enum:
        - CANCELLATION_BOOKING
        - CancellationCardTransaction
        - CANCELLATION_CARD_TRANSACTION_DIRECT
        - CANCELLATION_CHARGE_CARD
        - CANCELLATION_CHARGE_DUNNING
        - CANCELLATION_CHARGE_SEPA_DIRECT_DEBIT_RETURN
        - CANCELLATION_CRYPTO_EXCHANGE
        - CANCELLATION_CURRENCY_EXCHANGE_PARTNER
        - CANCELLATION_DIRECT_DEBIT
        - CANCELLATION_DOUBLE_BOOKING
        - CANCELLATION_INTERNAL_TRANSFER
        - CANCELLATION_INTERNATIONAL_CREDIT_TRANSFER
        - CANCELLATION_INTEREST_ACCRUED
        - CANCELLATION_INTEREST_ANNUITY
        - CANCELLATION_INTEREST_LOAN
        - CANCELLATION_LOAN_PAYOUT
        - CANCELLATION_REBOOKING
        - CANCELLATION_REBOOKING_INTEREST
        - CANCELLATION_SEPA_CREDIT_TRANSFER_RETURN
        - CANCELLATION_SEPA_DIRECT_DEBIT
        - CANCELLATION_SEPA_DIRECT_DEBIT_RETURN
        - CANCELLATION_TRANSFER_ANNUITY
        - CARD_DIRECT_DEBIT
        - CARD_TRANSACTION
        - CARD_TRANSACTION_DIRECT
        - CASH_DEPOSIT_RETAIL
        - CASH_WITHDRAWAL_RETAIL
        - CHARGE_ACCOUNT_MAINTENANCE
        - CHARGE_CARD
        - CHARGE_DUNNING
        - ChargeRecallRequest
        - CHARGE_SEPA_DIRECT_DEBIT_RETURN
        - ClosureBalanceTransfer
        - COMMISSION_OVERDRAFT
        - CREDIT_TRANSFER_CANCELLATION
        - CRYPTO_EXCHANGE
        - CURRENCY_EXCHANGE_PARTNER
        - DIRECT_DEBIT
        - FOREIGN_PAYMENT
        - INTEREST_ACCRUED
        - INTEREST_ANNUITY
        - INTEREST_LOAN
        - INTERNAL_TRANSFER
        - INTERNATIONAL_CREDIT_TRANSFER
        - LOAN_PAYOUT
        - REBOOKING
        - REBOOKING_INTEREST
        - SEPA_CREDIT_TRANSFER
        - SEPA_CREDIT_TRANSFER_RETURN
        - SEPA_DIRECT_DEBIT
        - SEPA_DIRECT_DEBIT_RETURN
        - SEPAInstantCreditTransfer
        - SepaInstantCreditTransferReturn
        - TARGET2_CREDIT_TRANSFER
        - TRANSFER_ANNUITY
        - OTHER
      example: SEPA_CREDIT_TRANSFER
    Solaris-Resources-Money-With-Unit:
      type: object
      properties:
        value:
          type: integer
          description: The amount.
          example: 5000
        unit:
          type: string
          description: Money unit used to represent the amount.
          example: cents
        currency:
          type: string
          description: The currency in which the amount is represented.
          example: EUR
    Solaris-Resources-MetaInfo-JSON:
      type: string
      description: >-
        JSON-serialized supplementary information about the transaction. For
        example, information about the card and the merchant associated with the
        transaction.
      example: >-
        {"cards":{"card_id":"abe6963e8be94364b8c1aa34d1bb5bc3mcrd","merchant":{"id":"123456789101112","country_code":"GB","category_code":"5411","name":"Grocery","town":"London"},"original_amount":{"currency":"GBP","value":50000,"fx_rate":10.0,"fx_markup":7.3165,"issuer_fee":0.0},"pos_entry_mode":"MANUAL_PAN_ENTRY","trace_id":"382621b66280020528d9433d135c2ae418fa53d0","transaction_id":"c158f11c-d6b2-4f8f-9391-ac20c2167f89","transaction_date":"2024-10-18","transaction_time":"2024-10-18T15:22:02+00:00","auth_code":"053630","acquirer_id":"123456","terminal_id":"12345678","transaction_type":"PURCHASE"}}
    Solaris-Resources-Booking:
      type: object
      properties:
        id:
          type: string
          description: ID of the booking.
          example: fe6561bdb526ed8866e9dac00bd1848ecboo
        creation_date:
          type: string
          description: >-
            The date when the booking was created. Do not expose this to the
            account holder(s).
          example: '2022-01-18'
        valuta_date:
          type: string
          description: >-
            The valuta date of the booking (i.e., the date when the booking
            becomes effective).
          example: '2022-01-18'
        booking_date:
          type: string
          description: The date when the booking was posted.
          example: '2022-01-18'
        booking_type:
          $ref: '#/components/schemas/Solaris-Enums-BookingType'
        amount:
          description: The amount of the booking.
          example:
            value: -160
            unit: cents
            currency: EUR
          allOf:
            - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
        description:
          type: string
          description: A description of the booking.
          example: BERLINER VOLKSBANK EG, TXL ABFLUG
        purpose_code:
          type: string
          description: The purpose code of the booking.
          example: 'null'
        recipient_bic:
          type: string
          description: The recipient's BIC.
          example: SOBKDEBBXXX
        recipient_iban:
          type: string
          description: The recipient's IBAN.
          example: DE97110101002242911754
        recipient_name:
          type: string
          description: The recipient's full name.
          example: SURIA LUIS VENTURA VIERA PEREIRA RIBEIRO
        receiver_iban_virtual:
          type: string
          description: (If applicable) The receiver's virtual IBAN.
        sender_bic:
          type: string
          description: The sender's BIC.
          example: SOBKDEBBXXX
        sender_iban:
          type: string
          description: The sender's IBAN.
          example: DE95110101000018501020
        sender_name:
          type: string
          description: The sender's full name.
          example: HANS MUSTERMANN
        end_to_end_id:
          type: string
          description: >-
            SEPA identifier provided by the customer who initiated the SEPA
            transaction, routed through the entire payment process.
          example: END2ENDREJ
        creditor_identifier:
          type: string
          description: >-
            Unique reference that identifies a party collecting payments under
            the SEPA Direct Debit scheme within and across 32 countries. See the
            [Deutsche Bundesbank's definition of creditor
            identifier](https://www.bundesbank.de/en/tasks/payment-systems/services/sepa/creditor-identifier/creditor-identifier-626704)
            for more information.
          example: DE98ZZZ09999999999
        mandate_reference:
          type: string
          description: The reference of the SDD mandate.
          example: '00000000000001'
        transaction_id:
          type: string
          description: The Solaris transaction ID.
          example: d651ee23300b4e7c8fe7b7e2b2e96trx
        return_transaction_id:
          type: string
          description: (If applicable) The Solaris ID of the return transaction.
          example: 758ea4a268974284ae7af17871f3fdc4
        sepa_charges:
          type: object
          description: >-
            (If applicable) Object containing information about the SEPA Direct
            Debit return transaction charges.
          allOf:
            - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
        sepa_return_code:
          type: string
          description: >-
            (If applicable) The SEPA reason code for the return transaction. See
            the [EPC173-14
            guidelines](https://www.europeanpaymentscouncil.eu/sites/default/files/kb/file/2019-05/EPC173-14%20v5.0%20Guidance%20on%20Reason%20Codes%20for%20SDD%20R-transactions.pdfttps://www.europeanpaymentscouncil.eu/document-library/guidance-documents/epc-guidance-reason-codes-sepa-direct-debit-r-transactions)
            for more information.
          nullable: true
          enum:
            - AC01
            - AC03
            - AC04
            - AC06
            - AC13
            - AC14
            - AG01
            - AG02
            - AM01
            - AM02
            - AM03
            - AM04
            - AM05
            - AM06
            - AM07
            - AM09
            - AM10
            - ARDT
            - BE01
            - BE04
            - BE05
            - BE06
            - BE07
            - BE08
            - CNOR
            - CURR
            - CUST
            - DNOR
            - DS28
            - DT01
            - ED01
            - ED03
            - ED05
            - EMVL
            - FF05
            - FOCR
            - FR01
            - FRTR
            - MD01
            - MD02
            - MD06
            - MD07
            - MS02
            - MS03
            - NARR
            - NOAS
            - NOOR
            - PINL
            - RC01
            - RC07
            - RF01
            - RR01
            - RR02
            - RR03
            - RR04
            - RUTA
            - SL01
            - SL02
            - SL11
            - SL12
            - SL13
            - SL14
            - SVNR
            - TM01
            - TRAC
            - UPAY
        sepa_return_reason:
          type: string
          description: >-
            (If applicable) The SEPA return reason text as defined by [ISO
            20022](https://en.wikipedia.org/wiki/ISO_20022).
        sepa_return_reason_definition:
          type: string
          description: >-
            (If applicable) Explanation of the SEPA return reason code as
            defined by [ISO 20022](https://en.wikipedia.org/wiki/ISO_20022).
        meta_info:
          type: object
          allOf:
            - $ref: '#/components/schemas/Solaris-Resources-MetaInfo-JSON'
          nullable: true
        recorded_at:
          type: string
          description: UTC timestamp from when the booking was recorded.
          example: '2022-01-24T00:41:57.634Z'
        reconciliation_id:
          type: string
          description: >-
            (If applicable) Unique ID of the related clearing transaction
            initiated by Solaris.
          example: 87271dda6e454393036b4ec2b64b2221itrx
        initiator_reference:
          type: string
          description: Unique reference for the transaction's initiator.
        charge_details:
          type: string
          description: >-
            Transaction charge details. Only relevant for bookings with the type
            `TARGET2_CREDIT_TRANSFER`.
          enum:
            - DEBT
            - SHAR
            - CRED
          example: CRED
    Solaris-Resources-Money-Optional:
      allOf:
        - $ref: '#/components/schemas/Solaris-Resources-Money-With-Unit'
      nullable: true
      title: SolarisToolkit.Web.Money.Optional
      type: object
    SolarisToolkit.Web.Money:
      type: object
      title: SolarisToolkit.Web.Money
      required:
        - value
        - currency
        - unit
      properties:
        value:
          type: integer
          description: The amount value
        unit:
          type: string
          enum:
            - cents
          description: The unit of the given value.
        currency:
          type: string
          description: The currency of the given value. Only EURO is currently supported.
      example:
        value: 1000
        unit: cents
        currency: EUR
    FrontingLoansWeb.Business.GetLoanResponse:
      properties:
        agio:
          description: The credit commission amount.
          example: 0
          format: float
          type: number
        amount:
          allOf:
            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
          description: The loan amount.
        application_id:
          description: The unique ID of the business fronting loan application.
          example: 89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla
          type: string
        collateral_account_iban:
          description: >-
            Your Solaris prefund account from which the full loan amount (agio +
            net loan amount) must be transferred to Solaris' settlement account.
          example: DE85110101014480677574
          type: string
        collection_account_iban:
          description: Your account to which the agio is transferred.
          example: DE87110101001000057123
          type: string
        duration:
          description: The number of months over which the loan will be repaid.
          example: 24
          type: integer
        effective_interest_rate:
          description: The effective annual interest rate applied to the loan.
          example: 0.309
          format: float
          type: number
        id:
          description: The unique ID of a business fronting loan.
          example: 13651d2f3a274e768ec6d45b036e0f14bflo
          type: string
        nominal_interest_rate:
          description: The nominal interest rate applied to the loan.
          example: 0.299
          format: float
          type: number
        recipient_iban:
          description: >-
            The IBAN of the loan's recipient, to which the loan will be paid
            out.
          example: DE92370601930002130041
          type: string
        recipient_name:
          description: The name of the loan recipient.
          example: Max Mustermann
          type: string
        settlement_account_iban:
          description: >-
            The Solaris settlement account from which the loan amount is
            transferred to the business's account.
          example: DE07110101014503906016
          type: string
        status:
          description: The status of the business fronting loan.
          enum:
            - payout_pending
            - payout_issued
          example: payout_issued
          nullable: false
          type: string
        status_reason:
          description: The status reason of the business fronting loan.
          enum:
            - closed
            - terminated
          example: closed
          nullable: true
          type: string
      required:
        - id
        - application_id
        - agio
        - duration
        - recipient_iban
        - recipient_name
        - effective_interest_rate
        - nominal_interest_rate
        - amount
        - collateral_account_iban
        - collection_account_iban
        - settlement_account_iban
        - status
      title: FrontingLoansWeb.Business.GetLoanResponse
      type: object
    FrontingLoansWeb.Business.Loans.Payouts.GetResponse:
      properties:
        amount:
          allOf:
            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
          description: The amount of the loan payout.
        id:
          description: The unique ID of a business fronting loan's payout.
          example: 963347398e47416c9df216a63ef035c2bflp
          type: string
        loan_id:
          description: The unique ID of the business fronting loan.
          example: 29e1a05906954ce082ec779d81de8c1ebflo
          type: string
        recipient_iban:
          description: The IBAN of the loan payout's recipient.
          example: DE92370601930002130041
          type: string
        recipient_name:
          description: The name of the loan payout's recipient.
          example: Max Mustermann
          type: string
        status:
          description: The status of the business fronting loan's payout.
          enum:
            - transfers_pending
            - transfers_complete
          example: transfers_pending
          type: string
        tag:
          description: The tag of the business fronting loan's payout.
          enum:
            - INITIAL_PAYOUT
            - RETENTION_FEE
            - FACTORING_INTEREST
          example: INITIAL_PAYOUT
          type: string
        transaction_description:
          description: >-
            The transaction reference, which the recipient will see. Only use
            characters allowed by SEPA in this field.
          nullable: true
          type: string
          example: Example transaction.
        transaction_end_to_end_id:
          description: >-
            SEPA identifier (provided by the end customer who initiated the SEPA
            transaction), routed through the whole payment process. (Max 35
            characters without whitespace)
          nullable: true
          type: string
          example: DDHHDHG333243
      required:
        - id
        - loan_id
        - recipient_iban
        - recipient_name
        - tag
        - status
        - amount
      title: FrontingLoansWeb.Business.Loans.Payouts.GetResponse
      type: object
    Solaris-Decorators-SeizureTypeEnum:
      type: string
      description: The type of seizure.
      enum:
        - ATTACHMENT
        - AUTHORITY_SEIZURE
        - COURT_SEIZURE
        - PRE_ATTACHMENT
    Solaris-Decorators-SeizureStatusEnum:
      type: string
      description: The current status of the seizure.
      enum:
        - ACTIVE
        - FULFILLED
        - WAITING_FOR_AUTHORITY
    Solaris-Server-Decorators-Money:
      type: object
      properties:
        value:
          type: integer
          description: The amount value.
          example: 1000
        unit:
          type: string
          description: The unit of the given value in cents.
          example: cents
        currency:
          type: string
          description: The currency of the given value. Only EUR is currently supported.
          example: EUR
    Solaris-Server-Decorators-CountryEnum:
      type: string
      enum:
        - AD
        - AE
        - AF
        - AG
        - AI
        - AL
        - AM
        - AO
        - AQ
        - AR
        - AS
        - AT
        - AU
        - AW
        - AX
        - AZ
        - BA
        - BB
        - BD
        - BE
        - BF
        - BG
        - BH
        - BI
        - BJ
        - BL
        - BM
        - BN
        - BO
        - BQ
        - BR
        - BS
        - BT
        - BV
        - BW
        - BY
        - BZ
        - CA
        - CC
        - CD
        - CF
        - CG
        - CH
        - CI
        - CK
        - CL
        - CM
        - CN
        - CO
        - CR
        - CU
        - CV
        - CW
        - CX
        - CY
        - CZ
        - DE
        - DJ
        - DK
        - DM
        - DO
        - DZ
        - EC
        - EE
        - EG
        - EH
        - ER
        - ES
        - ET
        - FI
        - FJ
        - FK
        - FM
        - FO
        - FR
        - GA
        - GB
        - GD
        - GE
        - GF
        - GG
        - GH
        - GI
        - GL
        - GM
        - GN
        - GP
        - GQ
        - GR
        - GS
        - GT
        - GU
        - GW
        - GY
        - HK
        - HM
        - HN
        - HR
        - HT
        - HU
        - ID
        - IE
        - IL
        - IM
        - IN
        - IO
        - IQ
        - IR
        - IS
        - IT
        - JE
        - JM
        - JO
        - JP
        - KE
        - KG
        - KH
        - KI
        - KM
        - KN
        - KP
        - KR
        - KW
        - KY
        - KZ
        - LA
        - LB
        - LC
        - LI
        - LK
        - LR
        - LS
        - LT
        - LU
        - LV
        - LY
        - MA
        - MC
        - MD
        - ME
        - MF
        - MG
        - MH
        - MK
        - ML
        - MM
        - MN
        - MO
        - MP
        - MQ
        - MR
        - MS
        - MT
        - MU
        - MV
        - MW
        - MX
        - MY
        - MZ
        - NA
        - NC
        - NE
        - NF
        - NG
        - NI
        - NL
        - 'NO'
        - NP
        - NR
        - NU
        - NZ
        - OM
        - PA
        - PE
        - PF
        - PG
        - PH
        - PK
        - PL
        - PM
        - PN
        - PR
        - PS
        - PT
        - PW
        - PY
        - QA
        - RE
        - RO
        - RS
        - RU
        - RW
        - SA
        - SB
        - SC
        - SD
        - SE
        - SG
        - SH
        - SI
        - SJ
        - SK
        - SL
        - SM
        - SN
        - SO
        - SR
        - SS
        - ST
        - SV
        - SX
        - SY
        - SZ
        - TC
        - TD
        - TF
        - TG
        - TH
        - TJ
        - TK
        - TL
        - TM
        - TN
        - TO
        - TR
        - TT
        - TV
        - TW
        - TZ
        - UA
        - UG
        - UM
        - US
        - UY
        - UZ
        - VA
        - VC
        - VE
        - VG
        - VI
        - VN
        - VU
        - WF
        - WS
        - XK
        - YE
        - YT
        - ZA
        - ZM
        - ZW
    Solaris-Server-Decorators-SeizureDebtor:
      type: object
      properties:
        name:
          type: string
          description: Debtor's name.
        address:
          type: string
          description: Debtor's street address.
        postal_code:
          type: string
          description: Debtor's postal code.
        city:
          type: string
          description: Debtor's city of residence.
        country:
          description: Debtor's country of residence.
          allOf:
            - $ref: '#/components/schemas/Solaris-Server-Decorators-CountryEnum'
        state:
          type: string
          description: (For German addresses) State/Bundesland
          enum:
            - BE
            - BB
            - BW
            - BY
            - HB
            - HE
            - HH
            - MV
            - NI
            - NW
            - RP
            - SH
            - SL
            - SN
            - ST
            - TH
          example: BE
    Solaris-Server-Decorators-SeizureCreditor:
      type: object
      properties:
        name:
          type: string
          description: Creditor name.
          example: Betflix LLC
        address:
          type: string
          description: Creditor's street address.
          example: Bethousestrasse 43
        postal_code:
          type: string
          description: Creditor's postal code.
          example: '10409'
        city:
          type: string
          description: Creditor's city of residence.
          example: Berlin
        country:
          description: Creditor's country of residence.
          example: DE
          allOf:
            - $ref: '#/components/schemas/Solaris-Server-Decorators-CountryEnum'
        state:
          type: string
          description: (For German addresses) State/Bundesland
          enum:
            - BE
            - BB
            - BW
            - BY
            - HB
            - HE
            - HH
            - MV
            - NI
            - NW
            - RP
            - SH
            - SL
            - SN
            - ST
            - TH
          example: BE
        iban:
          type: string
          description: Creditor's IBAN.
          example: DE72110101001000014344
    Solaris-Server-Decorators-SeizureCreditorRepresentative:
      type: object
      properties:
        name:
          type: string
          description: Creditor representative's name.
          example: Lawyer LLC
        address:
          type: string
          description: Creditor representative's street address.
          example: Gunsterstrasse 22
        postal_code:
          type: string
          description: Creditor representative's postal code.
          example: '10409'
        city:
          type: string
          description: Creditor representative's city of residence.
          example: Berlin
        country:
          description: Creditor representative's country of residence.
          example: DE
          allOf:
            - $ref: '#/components/schemas/Solaris-Server-Decorators-CountryEnum'
        state:
          type: string
          description: (For German addresses) State/Bundesland
          enum:
            - BE
            - BB
            - BW
            - BY
            - HB
            - HE
            - HH
            - MV
            - NI
            - NW
            - RP
            - SH
            - SL
            - SN
            - ST
            - TH
          example: BE
        case_number:
          type: string
          description: Creditor representative's case number.
          example: 42ABC-2
        iban:
          type: string
          description: Creditor representative's IBAN.
          example: DE87110101001000057123
    Solaris-Resources-MetaInfo:
      type: object
      description: An object containing all meta information related to the reservation.
      properties:
        cards:
          type: object
          description: >-
            Object containing all metadata related to the card used to make the
            reservation.
          properties:
            card_id:
              type: string
              description: Solaris ID of the card used to create the reservation.
            merchant:
              type: object
              description: >-
                Object containing all metadata related to the merchant with whom
                the transaction was conducted.
              properties:
                id:
                  type: string
                  description: The ID that the merchant provided to their acquirer.
                country_code:
                  type: string
                  description: Two-letter code of the country where the merchant is based.
                  example: DE
                category_code:
                  type: string
                  description: >-
                    The [Merchant Category Code
                    (MCC)](https://www.citibank.com/tts/solutions/commercial-cards/assets/docs/govt/Merchant-Category-Codes.pdf)
                    of the merchant.
                  example: '6011'
                post_code:
                  type: string
                  description: Postal code where the merchant is based.
                state:
                  type: string
                  description: State where the merchant is based.
                street_address:
                  type: string
                  description: Street address of the merchant.
                name:
                  type: string
                  description: The name of the merchant.
                  example: BERLINER VOLKSBANK EG
                town:
                  type: string
                  description: Town where the merchant is based.
                  example: TXL ABFLUG
            original_amount:
              type: object
              description: >-
                The amount of the reservation (in Euro cents) combined with the
                foreign exchange rate.
              properties:
                currency:
                  type: string
                  example: EUR
                value:
                  type: integer
                  example: 10
                fx_rate:
                  type: integer
                  example: 1
                fx_markup:
                  type: integer
                  example: 7.3165
                issuer_fee:
                  type: integer
                  example: 0
            pos_entry_mode:
              type: string
              description: The POS entry mode used for the reservation.
              example: CHIP
              enum:
                - ECOMMERCE
                - CREDENTIAL_ON_FILE
                - MANUAL_PAN_ENTRY
                - UNKNOWN
                - CHIP
                - CONTACTLESS
                - MAG_STRIPE
            trace_id:
              type: string
              description: >-
                ID used to link the authorization and the settlement. Note that
                Solaris cannot guarantee that this will always match.
              example: 651afb5beea67124d57be6dee27a2c5b7a241e58
            transaction_date:
              type: string
              description: Date when the transaction occurred.
              example: '2021-10-11'
            transaction_time:
              type: string
              description: Date and time when the transaction occurred (UTC format).
              example: '2021-10-11T22:33:26Z'
            transaction_type:
              type: string
              description: The type of the credit card transaction.
              example: PURCHASE
              enum:
                - PURCHASE
                - ATM_WITHDRAWAL
            auth_code:
              type: string
              description: >-
                Code generated by Solaris to confirm the authorization of a
                settlement.
            terminal_id:
              type: string
              description: (Legacy) Merchant ID for the terminal used for payment.
            acquirer_id:
              type: string
              description: >-
                An identification code (up to 11 characters) of the acquiring
                institution.
            wallet_type:
              type: string
              description: >-
                Name of a digital wallet. `UNKNOWN` if the internal ID doesn't
                match known to Solaris. Empty string (`""`) if the transaction
                does not come from a wallet.
              example: GOOGLE
              enum:
                - APPLE
                - GOOGLE
                - SAMSUNG
            device_pan:
              type: string
              description: Reference to the device's token in that wallet
              example: '4537920000006141'
    Solaris-Resources-Money:
      type: object
      properties:
        value:
          type: integer
          description: The amount.
          example: 5000
        currency:
          type: string
          description: The currency in which the amount is represented.
          example: EUR
    Solaris_Decorators_CardStatusEnum:
      type: string
      description: The current status of the card.
      enum:
        - ACTIVE
        - ACTIVATION_BLOCKED_BY_SOLARIS
        - BLOCKED
        - BLOCKED_BY_SOLARIS
        - CLOSED
        - CLOSED_BY_SOLARIS
        - COUNTERFEIT_CARD
        - FRAUD
        - INACTIVE
        - LOST
        - NEVER_RECEIVED
        - PROCESSING
        - STOLEN
    Solaris-Enums-CardType:
      type: string
      description: >-
        The type of the card. **Note** The following enum list is not exhaustive
        but only indicative of some possible values.
      enum:
        - MASTERCARD_DEBIT
        - MASTERCARD_BUSINESS_DEBIT
        - VIRTUAL_MASTERCARD_DEBIT
        - VIRTUAL_MASTERCARD_BUSINESS_DEBIT
        - VIRTUAL_MASTERCARD_FREELANCE_DEBIT
        - VISA_DEBIT
        - VISA_BUSINESS_DEBIT
        - VIRTUAL_VISA_DEBIT
        - VIRTUAL_VISA_BUSINESS_DEBIT
        - VIRTUAL_VISA_FREELANCE_DEBIT
        - VISA_CREDIT
        - VIRTUAL_VISA_CREDIT
        - VISA_BUSINESS_CREDIT
        - VIRTUAL_VISA_BUSINESS_CREDIT
    Solaris_Decorators_PublicPlasticCard:
      type: object
      description: >-
        Object containing information about the cardholder, the card's masked
        PAN, and the formatted expiration date.
      properties:
        line_1:
          type: string
          description: The cardholder's first and last name.
          example: SLY STALLONE
        line_2:
          type: string
          description: >-
            The supplementary personalized info like business name or membership
            number.
          example: BUSINESS NAME
        masked_pan:
          type: string
          description: The first six and last four digits of the card.
          example: 537458******4567
        formatted_expiration_date:
          type: string
          description: The card's expiration date in MM/YY format.
          example: 09/22
    CashOperation:
      type: object
      properties:
        id:
          type: string
          description: ID of the cash operation.
        barcode_ean_13:
          type: string
          description: >-
            The EAN-13 barcode that your solution must generate so that the
            customer can present it at the merchant POS to complete the cash
            operation.
        expires_at:
          type: string
          format: date-time
          description: The date and time when the cash operation barcode expires.
        status:
          type: string
          description: The current status of the cash operation.
          enum:
            - PENDING
            - CREATED
            - PAID
            - EXPIRED
            - CANCELLED
        reference_id:
          type: string
          description: End-to-end reference for the customer.
        person_id:
          type: string
          description: ID of the person who initiated the cash operation.
    FrontingLoansWeb.Consumer.GetLoanResponse:
      properties:
        agio:
          description: The credit commission amount.
          example: 0
          format: float
          type: number
        amount:
          allOf:
            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
          description: The loan amount.
        application_id:
          description: The unique ID of a consumer fronting loan application.
          example: 504f3c3659e14079a6941fe5b7a75eaacfla
          type: string
        collateral_account_iban:
          description: >-
            Your Solaris prefund account from which the full loan amount (agio +
            net loan amount) must be transferred to Solaris' settlement account.
          example: DE85110101014480677574
          type: string
        collection_account_iban:
          description: Your account to which the agio is transferred.
          example: DE87110101001000057123
          type: string
        duration:
          description: The number of months over which the loan will be repaid.
          example: 12
          type: integer
        id:
          description: >-
            The unique ID of the fronting loan, generated after a loan is
            created for the customer.
          example: 620b95f7987243d398c2621c889a2039cflo
          type: string
        recipient_iban:
          description: The IBAN of the loan's recipient to which the loan will be paid out.
          example: DE92370601930002130041
          type: string
        recipient_name:
          description: The name of the loan recipient.
          example: Max Mustermann
          type: string
        requested_interest_rate:
          description: The interest rate to apply to the fronting loan.
          example: 0.04
          format: float
          type: number
        settlement_account_iban:
          description: >-
            The Solaris settlement account from which the loan amount is
            transferred to the customer's account.
          example: DE07110101014503906016
          type: string
        status:
          description: The status of the consumer fronting loan.
          enum:
            - payout_issued
            - payout_pending
          example: payout_issued
          type: string
      required:
        - id
        - application_id
        - agio
        - duration
        - recipient_iban
        - recipient_name
        - requested_interest_rate
        - amount
        - collateral_account_iban
        - collection_account_iban
        - settlement_account_iban
        - status
      title: FrontingLoansWeb.Consumer.GetLoanResponse
      type: object
    ConsumerLoan.GetApplicationResponse:
      type: object
      title: ConsumerLoan.GetApplicationResponse
      required:
        - id
        - status
      properties:
        status_description:
          type: string
          nullable: true
          description: Additional details about the consumer loan application status.
        status:
          type: string
          example: esign_pending
          enum:
            - offered
            - account_snapshot_verification
            - approved
            - esign_pending
            - screening_pending
            - esign_failed
            - loan_creation_pending
            - loan_created
            - rejected
            - deleted
            - expired
          description: The status of a consumer loan application.
        skip_account_snapshot:
          type: boolean
          nullable: false
        signing_id:
          type: string
          nullable: true
          example: 7c63600ddddec4f2668893af39c1b814csig
          description: >-
            The ID of the signing resource, created after the customer's
            identification and e-signing process has been triggered.
        seller:
          type: string
          nullable: true
          description: The name of the seller of the financed good.
        payout_description:
          type: string
          nullable: true
          description: Additional details around the loan payout.
        loan_id:
          type: string
          nullable: true
          description: The unique ID of a loan.
        id:
          type: string
          example: 108787ede6b743dcbe0c3398bc4a6ce8clap
          description: The unique ID of a customer's consumer loan application.
        financed_good:
          type: string
          nullable: true
          description: The financed good that was purchased using the loan.
        delayed_payout_strategy:
          type: string
          enum:
            - none
            - after_revocation
          description: >-
            Field to indicate the payout strategy to be applied to the loan. If
            set to `none`, then the loan payout will happen automatically.
        cash_price:
          type: object
          nullable: true
          description: >-
            The cash price of the financed good (i.e., net price without
            financing fees, interest).
          allOf:
            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
        approximate_total_loan_expenses:
          type: object
          nullable: true
          description: >-
            An approximate amount of the loan total expenses (e.g., costs and
            expenses the lender incurred during a loan lifecycle)
          allOf:
            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
    SolarisToolkit.Web.Money.Optional:
      type: object
      title: SolarisToolkit.Web.Money.Optional
      nullable: true
      allOf:
        - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
    OverdraftWeb.Consumer.GetOverdraftResponse:
      type: object
      title: OverdraftWeb.Consumer.GetOverdraftResponse
      required:
        - id
        - person_id
        - consumer_application_id
        - account_iban
        - status
        - interest_accrual_rate
        - overdraft_rate
        - created_at
        - negative_since
        - interest_accrued
      properties:
        status:
          type: string
          example: created
          enum:
            - created
            - conditions_pending
            - limit_pending
            - attached
            - defaulted_pending
            - conditions_termination_pending
            - termination_pending
            - terminated
          description: The status of an overdraft offered to a consumer.
        person_id:
          type: string
          example: dc1a6812a14f6cc338cd084208535bcdcper
          description: >-
            The unique person ID, generated after completing the person
            onboarding
                  process.
        overdraft_rate:
          type: number
          format: float
          example: 9
          description: The interest rate applicable to the overdraft.
        negative_since:
          type: string
          nullable: true
          format: datetime
          example: '2021-08-03T18:01:48Z'
          description: The date and time when overdraft went negative.
        limit:
          $ref: '#/components/schemas/SolarisToolkit.Web.Money.Optional'
        interest_accrued:
          oneOf:
            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
          description: The daily interest accrued by an person account.
        interest_accrual_rate:
          type: number
          format: float
          example: 3
          description: >-
            The daily rate at which interest is accrued on the used amount of an
            overdraft.
        id:
          type: string
          example: 00556cd181f2409aaa6c2a033cce3a8fcovd
          description: >-
            The unique ID of a consumer overdraft, generated after an overdraft
            is offered.
        created_at:
          type: string
          format: datetime
          example: '2021-08-03T18:01:48.000Z'
          description: The date and time the overdraft was created.
        consumer_application_id:
          type: string
          example: b83z264de98741018419b53648e20ca9coap
          description: The unique ID of a consumer overdraft application.
        account_iban:
          type: string
          example: DE87110101001000057123
          description: The IBAN of a person account.
    OverdraftWeb.Consumer.GetOverdraftApplicationResponse:
      type: object
      title: OverdraftWeb.Consumer.GetOverdraftApplicationResponse
      required:
        - id
        - partner_id
        - person_id
        - identification_id
        - account_iban
        - status
        - created_at
      properties:
        status_description:
          type: string
          nullable: true
          example: The overdraft is approved and offered to the customer.
          description: The description of the consumer overdraft application status.
        status:
          type: string
          example: offered
          enum:
            - scoring_pending
            - offered
            - overdraft_created
            - rejected
            - deleted
          description: The status of a consumer overdraft application.
        person_id:
          type: string
          example: dc1a6812a14f6cc338cd084208535bcdcper
          description: >-
            The unique person ID, generated after completing the person
            onboarding process.
        partner_risk_class:
          type: string
          nullable: true
          example: d
          description: The risk class assigned to a customer by the partner.
        partner_requested_limit:
          $ref: '#/components/schemas/SolarisToolkit.Web.Money.Optional'
        partner_reference_number:
          type: string
          nullable: true
          example: a123456
          description: The partner's reference number.
        partner_id:
          type: string
          example: 6ee8e4c8bdc2f9b15870c989706aa9cccpar
          description: The unique partner ID, generated after creating a partner.
        partner_contact_number:
          type: string
          nullable: true
          example: '+491565904345'
          description: The number of the partner's contact person.
        partner_contact_name:
          type: string
          nullable: true
          example: Peter Mustermann
          description: The name of the partner's contact person.
        overdraft_id:
          type: string
          nullable: true
          example: 00556cd181f2409aaa6c2a033cce3a8fcovd
          description: >-
            The unique ID of a consumer overdraft, generated after an overdraft
            is offered.
        net_income_amount:
          $ref: '#/components/schemas/SolarisToolkit.Web.Money'
        minimum_credit_risk_criteria:
          type: object
          nullable: true
          description: Minimum credit risk criteria fields for scorer
          additionalProperties: true
        limit:
          $ref: '#/components/schemas/SolarisToolkit.Web.Money.Optional'
        interest_accrual_rate:
          type: number
          nullable: true
          format: float
          description: Scorer rate for risk based pricing
        identification_id:
          type: string
          example: 176a96d1ecf7459d659d1b7f0108a3f2cidt
          description: >-
            The unique identification ID of a person, generated after completing
            the person identification process.
        id:
          type: string
          example: b83z264de98741018419b53648e20ca9coap
          description: The unique ID of a consumer overdraft application.
        employment_status:
          type: string
          nullable: true
          example: EMPLOYED
          enum:
            - EMPLOYED
            - UNEMPLOYED
            - PUBLIC_SECTOR_EMPLOYEE
            - PROFESSIONAL_SOLDIER
            - FREELANCER
            - HOUSEWORK
            - APPRENTICE
            - MANAGEMENT
            - RETIRED
            - STUDENT
            - SELF_EMPLOYED
            - MILITARY_OR_COMMUNITY_SERVICE
          description: >-
            The consumer's employment status, mentioned in the signed
            self-declaration form.
        credit_record_id:
          type: string
          nullable: true
          example: fbb7d15fa4c54ba0b077592665ef04a4ccrd
          description: >-
            The unique ID of a credit record, generated after creating a
            consumer credit record.
        created_at:
          type: string
          format: datetime
          example: '2021-08-03T18:01:48.000Z'
          description: The date and time the consumer overdraft application was created.
        account_iban:
          type: string
          example: DE87110101001000057123
          description: The IBAN of a person account.
    amount:
      type: object
      properties:
        value:
          type: integer
          description: The amount (in Euro cents).
          example: 100
        unit:
          type: string
          example: cents
          description: The unit.
        currency:
          type: string
          example: EUR
          description: The currency.
    modifiable_repayment_options:
      type: object
      properties:
        upcoming_type:
          type: string
          description: >-
            Allows you to change the type of credit card as of the next billing
            cycle. Options are `FULL` (charge) and `PARTIAL` (revolving).
          enum:
            - FULL
            - PARTIAL
          example: FULL
        minimum_amount:
          description: >-
            Minimum amount of the used limit to be repaid at the end of each
            billing cycle. Only relevant if `upcoming_type` is set to `PARTIAL`.
          allOf:
            - $ref: '#/components/schemas/amount'
        minimum_percentage:
          type: integer
          description: >-
            Minimum percentage of the used limit to be repaid at the end of each
            billing cycle. Only relevant if `upcoming_type` is set to `PARTIAL`.
          example: 3
    repayment_options:
      allOf:
        - $ref: '#/components/schemas/modifiable_repayment_options'
        - properties:
            current_type:
              type: string
              description: >-
                Indicates the type of the credit card. Possible values are
                `FULL` (charge) and `PARTIAL` (revolving).
              enum:
                - FULL
                - PARTIAL
              example: PARTIAL
            upcoming_type:
              type: string
              description: >-
                Indicates the type of the credit card which will be from next
                billing cycle.
              enum:
                - FULL
                - PARTIAL
              example: PARTIAL
            upcoming_billing_cycle:
              type: string
              description: Indicates the next billing interval for the card.
              enum:
                - WEEKLY
                - BIWEEKLY
                - MONTHLY
                - BIMONTHLY
                - QUARTERLY
              example: MONTHLY
            current_billing_cycle:
              type: string
              description: Indicates the current billing interval for the credit card.
              enum:
                - WEEKLY
                - BIWEEKLY
                - MONTHLY
                - BIMONTHLY
                - QUARTERLY
              example: MONTHLY
            grace_period_in_days:
              type: integer
              description: >-
                Indicates number of days in the grace period for paying off the
                required amount in each billing cycle.
              example: 15
            minimum_amount_lower_threshold:
              description: >-
                The lower threshold for the minimum payment amount that can be
                applied to the credit card. Solaris will set this value.
              allOf:
                - $ref: '#/components/schemas/amount'
            minimum_amount_upper_threshold:
              description: >-
                The upper threshold for the minimum payment amount that can be
                applied to the credit card. Solaris will set this value.
              allOf:
                - $ref: '#/components/schemas/amount'
            minimum_percentage_lower_threshold:
              type: integer
              description: >-
                The lower threshold for the minimum percentage of the balance
                that you may require customers to pay in each billing cycle.
              example: 3
            minimum_percentage_upper_threshold:
              type: integer
              description: >-
                The upper threshold for the minimum percentage of the balance
                that you may require customers to pay in each billing cycle.
              example: 20
            minimum_percentage:
              type: integer
              description: Credit card application's repayment minimum percentage
              example: 2
            minimum_amount:
              description: The minimum amount to be repaid each billing cycle
              allOf:
                - $ref: '#/components/schemas/amount'
    consumer_scoring_options:
      type: object
      properties:
        customer_desired_limit:
          description: >-
            The credit card limit requested by the customer, subject to the
            scorer's decision.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 50000
            unit: cents
            currency: EUR
        number_of_dependents:
          type: integer
          description: >-
            The number of dependents (e.g., children or spouse) who depend on
            the customer's income.
          example: 1
        marital_status:
          type: string
          description: The customer's marital status.
          enum:
            - SINGLE
            - MARRIED
            - DIVORCED
            - WIDOWED
            - UNKNOWN
          example: MARRIED
        living_situation:
          type: string
          description: The customer's living situation.
          enum:
            - LIVING_WITH_PARENTS
            - LIVING_IN_OWN_HOUSE
            - LIVING_IN_RENTED_HOUSE
          example: LIVING_WITH_PARENTS
        living_situation_expenses:
          description: >-
            The customer's living monthly expenses (e.g., rent or mortgage,
            utilities, health insurance, etc.)
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 20000
            unit: cents
            currency: EUR
        net_income:
          description: The customer's net income amount (i.e., after tax), in Euro.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 30000
            unit: cents
            currency: EUR
        credit_repayment_excluding_mortgage:
          description: >-
            A field containing information about the customer's existing debt
            repayments (in EUR), excluding mortgage payments.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 10000
            unit: cents
            currency: EUR
        other_credit_card_limit:
          description: >-
            If the customer has existing credit cards, include the granted limit
            in this field.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 100000
            unit: cents
            currency: EUR
        employment_since:
          type: string
          description: The date from which the customer has held their current job.
          format: date
          example: '2019-08-24'
        annual_turnover:
          description: (Freelancers only) The customer's expected annual turnover.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 500000
            unit: cents
            currency: EUR
        monthly_business_costs:
          description: (Freelancers only) The customer's monthly business costs.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 25000
            unit: cents
            currency: EUR
        total_clients_12_months:
          type: integer
          description: >-
            (Freelancers only) The total number of clients that the customer has
            had in the last 12 months.
          example: 10
        has_credit_card:
          type: boolean
          description: Does customer already possess a credit card account.
        reference_account_created_year:
          type: string
          description: Year since when does reference bank account exist.
          example: '2019'
        member_since:
          type: string
          format: date
          description: Date of ADAC membership started.
          example: '2019-08-24'
        provision_code:
          type: string
          description: ADAC provision code.
        reference_account_iban:
          type: string
          description: Reference account
    business_scoring_options:
      type: object
      properties:
        customer_desired_limit:
          description: >-
            The credit card limit requested by the customer, subject to the
            scorer's decision.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 100000
            unit: cents
            currency: EUR
        other_credit_card_limit:
          description: >-
            If the customer already has credit cards, include the granted limit
            in this field.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 30000
            unit: cents
            currency: EUR
        total_assets:
          description: The business' total assets.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: null
            unit: cents
            currency: EUR
        total_equity:
          description: The business' total equity.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: null
            unit: cents
            currency: EUR
        annual_turnover:
          description: The business' annual turnover amount.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 5000000
            unit: cents
            currency: EUR
        partner_recommended_limit:
          description: >-
            Your recommended limit for the credit card based on your own
            criteria.
          allOf:
            - $ref: '#/components/schemas/amount'
          example:
            value: 90000
            unit: cents
            currency: EUR
        partner_pd_rate:
          description: Your calculated probability of default (PD) rate for the business.
          type: number
          format: float
          example: 0.1
        partner_score:
          description: Your calculated score for the business.
          type: integer
          example: 1
    DepositStatus:
      type: string
      description: The current status of the savings account.
      enum:
        - OPENED
        - TAX_REGISTERED
        - ACTIVE
        - INACTIVE
        - FAILED
    DepositTypes:
      description: The account type.
      type: string
      enum:
        - SAVINGS_ACCOUNT
    MainAccount:
      type: string
      description: ID of the main account.
      example: 148c29b85992b8772eb7ddd518490110cacc
    incoming_rejected_transaction_cards:
      type: object
      description: Webhook payload for Decoupled and Credit Cards.
      properties:
        status:
          type: string
          description: The current status of the transaction.
          example: RETURNED
        status_reason:
          type: string
          description: The reason why the transaction was rejected.
          example: The debtor name is not matching
        sender_name:
          type: string
          description: The name of the person who sent the funds.
          example: John Mustermann
        sender_iban:
          type: string
          description: IBAN of the account from which the funds were sent.
          example: DE32110101001000000029
        person_id:
          type: string
          description: ID of the person who owns the restricted account.
          example: c77044e6a8e35e3a4deaf7c9a4cc2476cper
        business_id:
          type: string
          description: ID of the business who owns the restricted account.
          example: 567eaf2b22fce21a1920e14e11e2bfa3cbiz
        account_id:
          type: string
          description: ID of the restricted account.
          example: c61ca1f2fbf12830517ae2fce6e2cd79cacc
    incoming_rejected_transaction_wallets:
      type: object
      description: Webhook payload for Restricted Accounts.
      properties:
        sender_name:
          type: string
          description: The name of the person who sent the funds.
          example: John Mustermann
        sender_iban:
          type: string
          description: IBAN of the account from which the funds were sent.
          example: DE32110101001000000029
        status:
          type: string
          description: The current status of the transaction.
          example: REJECTED
        status_reason:
          type: string
          description: The reason why the transaction was rejected.
          example: The debtor name is not matching.
        person_id:
          type: string
          description: ID of the person who owns the restricted account.
          example: c77044e6a8e35e3a4deaf7c9a4cc2476cper
        account_id:
          type: string
          description: ID of the restricted account.
          example: adc123a45d6d7cf8fbfeed537ba919d5cacc
    IdentificationOriginationWeb.GetIdentificationOriginationResponse:
      x-struct: >-
        Elixir.IdentificationOriginationWeb.V1.IdentificationOrigination.ShowOperationView.GetIdentificationOriginationResponse
      type: object
      title: IdentificationOriginationWeb.GetIdentificationOriginationResponse
      required:
        - identification_origination_id
        - status
      properties:
        status_description:
          type: string
          nullable: true
          example: Waiting for signing process to finish
          description: The description of the identification status
        status:
          type: string
          example: esign_pending
          enum:
            - identification_trigger_pending
            - esign_pending
            - identification_completion_pending
            - screening_pending
            - failed
            - completed
            - expired
          description: The status of the identification origination.
        identification_origination_id:
          type: string
          example: 589e12da53154010ad180894acbe07ebio
          description: >-
            The unique ID of an identification origination resource assigned to
            a specific customer.
        identification_id:
          type: string
          nullable: true
          example: 17905779039e75dce7bf8d68f3184942cidt
          description: >-
            The unique ID of the identification resource assigned to a specific
            customer.
        esigning_id:
          type: string
          nullable: true
          example: 5ade4e499b299c299be2987ad597c42ecsig
          description: The unique ID of the e-signing resource.
    OverdraftWeb.Freelancer.GetOverdraftResponse:
      type: object
      title: OverdraftWeb.Freelancer.GetOverdraftResponse
      required:
        - id
        - person_id
        - status
        - created_at
        - interest_accrued
      properties:
        status:
          type: string
          example: created
          enum:
            - created
            - interest_conditions_set
            - limit_set
            - terminated
          description: The status of an overdraft offered to a freelancer.
        person_id:
          type: string
          example: dc1a6812a14f6cc338cd084208535bcdcper
          description: >-
            The unique person ID, generated after completing the person
            onboarding process.
        overdraft_rate:
          type: number
          example: 9
          description: The interest rate applicable to the overdraft.
        limit:
          $ref: '#/components/schemas/SolarisToolkit.Web.Money.Optional'
        interest_conditions_enabled:
          type: boolean
        interest_accrued:
          oneOf:
            - $ref: '#/components/schemas/SolarisToolkit.Web.Money'
          description: The daily interest accrued by a freelancer account.
        interest_accrual_rate:
          type: number
          example: 3
          description: >-
            The daily rate at which interest is accrued on the used amount of an
            overdraft.
        id:
          type: string
          example: 00556cd181f2409aaa6c2a033cce3a8fcovd
          description: >-
            The unique ID of a freelancer overdraft, generated after an
            overdraft is offered.
        created_at:
          type: string
          format: datetime
          example: '2021-08-03T18:01:48.000Z'
          description: The date and time the overdraft was created.
        account_id:
          type: string
          nullable: true
          example: 575189c6eb825b10b9d0392fcb3bf61dcacc
          description: The unique ID of a customer's bank account.
    OverdraftWeb.Freelancer.GetOverdraftApplicationResponse:
      type: object
      title: OverdraftWeb.Freelancer.GetOverdraftApplicationResponse
      required:
        - id
        - person_id
        - status
        - created_at
      properties:
        status:
          type: string
          example: offered
          enum:
            - initial_scoring_pending
            - account_snapshot_pending
            - account_snapshot_verification_pending
            - offered
            - rejected
            - expired
            - deleted
            - overdraft_created
          description: The status of a freelancer overdraft application.
        rejection_reasons:
          type: array
          nullable: true
          items:
            type: string
          description: The reason(s) for rejecting an overdraft application.
        person_id:
          type: string
          example: dc1a6812a14f6cc338cd084208535bcdcper
          description: >-
            The unique person ID, generated after completing the person
            onboarding process.
        partner_risk_class:
          type: string
          nullable: true
          example: d
          description: The risk class assigned to a freelancer by the partner.
        partner_reference_number:
          type: string
          nullable: true
          example: a123456
          description: The partner's reference number.
        partner_contact_number:
          type: string
          nullable: true
          example: '+491565904345'
          description: The number of the partner's contact person.
        partner_contact_name:
          type: string
          nullable: true
          example: Peter Mustermann
          description: The name of the partner's contact person.
        overdraft_rate:
          type: number
          example: 9
          description: The interest rate applicable to the overdraft.
        overdraft_id:
          type: string
          nullable: true
          example: 00556cd181f2409aaa6c2a033cce3a8fcovd
          description: >-
            The unique ID of a freelancer overdraft, generated after an
            overdraft is offered.
        limit:
          $ref: '#/components/schemas/SolarisToolkit.Web.Money.Optional'
        interest_conditions_enabled:
          type: boolean
        interest_accrual_rate:
          type: number
          example: 3
          description: >-
            The daily rate at which interest is accrued on the used amount of an
            overdraft.
        id:
          type: string
          example: b83z264de98741018419b53648e20ca9coap
          description: The unique ID of a freelancer overdraft application.
        decision:
          type: string
          nullable: true
          example: OFFERED
          enum:
            - REJECTED
            - OFFERED
          description: Solaris' decision on the overdraft application.
        credit_record_id:
          type: string
          nullable: true
          example: fbb7d15fa4c54ba0b077592665ef04a4ccrd
          description: >-
            The unique ID of a credit record, generated after creating a
            freelancer credit record.
        created_at:
          type: string
          format: datetime
          example: '2021-08-03T18:01:48.000Z'
          description: The date and time the freelancer overdraft application was created.
        account_snapshot_id:
          type: string
          nullable: true
          description: The unique ID of an account snapshot of a specific person account.
    ItemResponse:
      type: object
      properties:
        id:
          type: string
          description: ID of the Postbox item.
        belongs_to:
          type: string
          description: >-
            ID of the person or business with whom the Postbox item is
            associated.
        owner_type:
          type: string
          description: Indicates whether the Postbox item is owned by a person or business.
          enum:
            - Person
            - Business
        created_at:
          type: string
          description: UTC timestamp from when the Postbox item was created.
        document_date:
          type: string
          description: The date of the document associated with the Postbox item.
        document_type:
          type: string
          description: The type of document associated with the Postbox item.
          enum:
            - ACCOUNT_STATEMENT
            - BALANCE_CONFIRMATION
            - CUSTOMER_INFORMATION
            - DUNNING_INFORMATION
            - LOAN_SCHEDULE
            - SECURITIES_INVOICE
            - SECURITIES_EVENT
            - SECURITIES_EVENT_NOTIFICATION
            - DEPOT_STATEMENT_MIFID
            - EX_POST_COST_INFORMATION
            - DEPOT_STATEMENT
            - ASSETS_ACQUISITION
            - ASSETS_ACQUISITION_COSTS
            - PROFIT_TAX_STATEMENT
            - YEARLY_TAX_STATEMENT
            - TAX_SETTLEMENT_CALCULATION
            - CREDIT_CARD_STATEMENT
            - RELATIONSHIP_TERMINATION
            - CREDIT_CARD_SECCI
            - CREDIT_CARD_CONTRACT
            - CREDIT_CARD_CONTRACT_SIGNED
            - FEE_SUMMARY_STATEMENT
            - SINGLE_FEE_STATEMENT
            - SINGLE_TRANSACTION_STATEMENT
        name:
          type: string
          description: The name of the Postbox item.
        description:
          type: string
          description: A description for the Postbox item.
        customer_notification:
          type: boolean
          description: >-
            Boolean value to indicate whether or not customers should receive a
            notification when the Postbox item is created. 
        customer_confirmation:
          type: boolean
          description: >-
            Boolean value to indicate whether or not customers must confirm the
            Postbox item. 
        document_size:
          type: integer
          format: int64
          description: The file size of the associated document.
        document_content_type:
          type: string
          description: The content type of the associated document.
        document_id:
          type: string
          description: The ID of the associated document.
        has_been_read:
          type: boolean
          description: The item was marked as read via patch endpoint.
        has_been_confirmed:
          type: boolean
          description: The item has at least 1 confirmation.
        reference_id:
          type: string
          description: >-
            Reference of original source of a document, e.g. bill_id for credit
            card statement
    Solaris-Enums-DocumentType:
      type: string
      description: The type of document.
      enum:
        - ACCOUNT_SNAPSHOT.FINTECSYSTEMS
        - ACCOUNT_STATEMENT
        - AML_POLICY
        - ANNUAL_FINANCIAL_STATEMENT
        - B2B_MANDATE
        - BALANCE_REPORT
        - BANK_REFERENCE
        - BUSINESS_ASSESSMENT
        - BUSINESS_FINANCIALS_XBRL
        - CREDIT_AGENCY_REPORT
        - CREDIT_RECORD.SCHUFA
        - CUSTOMER_COMMUNICATION
        - FATCA_SELF_DECLARATION
        - FOUNDATION_DOCUMENT
        - ID_DOCUMENT
        - INVOICE
        - KYC_BENEFICIAL_OWNER
        - KYC_CORPORATE_DOCUMENT
        - KYC_FORM
        - KYC_LEGAL_REPRESENTATIVE
        - KYC_RELIABILITY_CHECK
        - KYC_REPORT
        - LOAN_MANDATE_CONTRACT
        - OTHER
        - PAYMENT_CONFIRMATION
        - PICTURE
        - POWER_OF_ATTORNEY
        - PROOF_OF_ADDRESS
        - PROOF_OF_PHONE_CHANGE
        - PROOF_OF_PROFESSION
        - PROOF_OF_SALARY
        - PROOF_OF_TAX_ID
        - REFERENCE_LETTER
        - REGISTER_APPLICATION
        - REGISTER_EXTRACT
        - SALARY_INFORMATION
        - SCHUFA_COMPACT_REPORT
        - SCHUFA_FULL_REPORT
        - SCHUFA_GWG_REPORT
        - SCHUFA_SHORT_REPORT
        - SCORE_CARD.SOLARIS
        - SCREENING_REPORT
        - SHAREHOLDERS_LIST
        - SHARE_HOLDERS_AGREEMENT
        - SIGNATURE
        - SIGNED_CONTRACT
        - SIGNED_LOAN_MANDATE_CONTRACT
        - TRADING_LICENSE
        - TRANSACTIONAL_DOCUMENT
        - TRANSFER_CANCELLATION
        - VAT_CERTIFICATE
        - VIDEO
    Solaris-Server-Decorators-Question:
      type: object
      properties:
        id:
          type: string
          description: ID of the question.
        deadline:
          type: string
          format: date-time
          description: UTC timestamp indicating the deadline for answering the question.
        question:
          type: string
          description: The question.
        answer_type:
          type: string
          description: The type of answer required from the recipient.
          enum:
            - TEXT_ONLY
            - TEXT_AND_FILES
        allowed_document_types:
          type: array
          description: Indicates array of allowed_document_types.
          items:
            $ref: '#/components/schemas/Solaris-Enums-DocumentType'
      example:
        id: 1f0130f81d84ed3c75b32c428d5d7d93cqst
        question: Provide your current address.
        answer_type: TEXT_AND_FILES
        deadline: '2022-09-15T11:20:16.840208Z'
        allowed_document_types:
          - KYC_REPORT
    Solaris-Server-Decorators-SepaDirectDebitReturn:
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the SEPA Direct Debit return.
          example: 257eb92c4656691fd02d3de1fa88b9f5csdr
        creditor_iban:
          type: string
          description: The creditor's IBAN.
          example: DE32110101001000000029
        creditor_name:
          type: string
          description: The creditor's name.
          example: Peter Mustermann
        creditor_identifier:
          type: string
          description: >-
            Unique reference that identifies a party collecting payments under
            the SEPA Direct Debit scheme within and across 32 countries. See the
            [Deutsche Bundesbank's definition of creditor
            identifier](https://www.bundesbank.de/en/tasks/payment-systems/services/sepa/creditor-identifier/creditor-identifier-626704)
            for more information.
          example: DE98ZZZ09999999999
        mandate_reference:
          type: string
          description: >-
            Reference of the mandate. Must be unique for the creditor
            identifier.
          example: SOBKTEST
        amount:
          type: object
          description: The amount of the booking.
          allOf:
            - $ref: '#/components/schemas/Solaris-Server-Decorators-Money'
        end_to_end_id:
          type: string
          description: >-
            SEPA identifier provided by the transaction initiator, which will be
            routed throughout the whole payment process.
          example: DD-12-28.05.2018
        sepa_return_code:
          type: string
          description: SEPA return code.
          example: MD01
        description:
          type: string
          description: Additional details about the booking.
        recorded_at:
          type: string
          description: The timestamp from when the return was recorded.
          example: '2018-08-12T13:58:58.000Z'
        customer_id:
          type: string
          description: The customer's ID.
          example: 74c586d116e7dcd138af3dd5d754f2abcper
        customer_type:
          type: string
          description: Specifies whether the customer is a Person or Business.
          example: Person
          enum:
            - Person
            - Business
        account_id:
          type: string
          description: The customer's Solaris account ID.
          example: 3eb274b98be7afb13d91acb8ae53901ecacc
    TaxExemptionStatus:
      type: string
      description: The current status of the tax exemption order.
      enum:
        - OPENED
        - SUCCESS
        - FAILED
    TaxExemptionfailureReason:
      type: string
      nullable: true
      description: >-
        In case the tax exemption request failed, this field will contain the
        reason.<br> 
          Note that the tax exemption request failed if any of the following criteria are met:
          <br> 
          <ul>
          <li>Invalid processing year</li>
          <li>Invalid Amount: Exemption amount submitted higher than maximum permissible value</li>
          <li>Invalid amount: Exemption amount submitted smaller than utilization already completed</li>
          <li>The date on which the tax benefit was withdrawn (renounceDate) is invalid</li>
          <li>Date on which tax concession is legally terminated is invalid</li>
          <li>Valid_from_date of the tax concession is invalid</li>
          <li>The validity period of the NV certificate is invalid - longer than 3 years</li>
          <li>Invalid serial number</li>
          <li>Technical Error</li>
          <li>Invalid period: Invalid valid_to date</li>
          <li>Invalid period: the valid_from date is greater than the valid_to date.</li>
          <li>Invalid action: Cannot change termination date</li>
          <li>Invalid amount: The submitted amount must not be negative</li>
          <li>Invalid amount: Amount submitted must be > 0</li>
          <li>The current tax status cannot be changed due to existing tax transactions</li>
          <li>Invalid new TaxStatus</li>
          <li>Invalid action</li>
          <li>Invalid Customer</li>
          <li>Internal Error</li>
        </ul> <br>
