openapi: 3.0.1
info:
  title: payments_integration API
  description: Merged OpenAPI spec for payments_integration domain
  version: 1.0.0
servers:
- url: https://api.uat.btx.fr.banqup.com/payments/integration
paths:
  /v1/spaces/{spaceId}/payments:
    get:
      deprecated: true
      description: Retrieves the details of all payments associated to a space
      operationId: getPaymentsV1
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - description: The payment currency
        in: query
        name: currency
        required: false
        schema:
          type: string
      - description: The payment end to end identifier
        in: query
        name: endToEndId
        required: false
        schema:
          type: string
          description: The payment end to end identifier
      - description: The store account id from which the payment originated
        in: query
        name: accountId
        required: false
        schema:
          type: string
          format: uuid
          description: The store account id from which the payment originated
      - description: The payment status
        in: query
        name: status
        required: false
        schema:
          type: string
          description: The payment status
          enum:
          - RECEIVED
          - OPEN
          - IN_TRANSIT
          - SUCCESSFUL
          - FAILED
          - CANCELED
          - UNKNOWN
          - PLANNED
      - description: The counterparty account identifier
        in: query
        name: reference
        required: false
        schema:
          type: string
          description: The counterparty account identifier
      - description: The payment reference
        in: query
        name: counterpartyPaymentAccountIdentifier
        required: false
        schema:
          type: string
          description: The payment reference
      - description: The minimum of the amount range
        in: query
        name: minAmount
        required: false
        schema:
          type: number
          description: The minimum of the amount range
      - description: The maximum of the amount range
        in: query
        name: maxAmount
        required: false
        schema:
          type: number
          description: The maximum of the amount range
      - description: Page index
        example: 1
        in: query
        name: page
        required: false
        schema:
          type: integer
          format: int64
          default: 0
          description: Page index
          example: 1
          minimum: 0
      - description: Number of objects in a page
        example: 20
        in: query
        name: size
        required: false
        schema:
          type: integer
          format: int32
          default: 30
          description: Number of objects in a page
          example: 20
          maximum: 100
          minimum: 1
      - in: query
        name: sortBy
        required: false
        schema:
          type: string
          default: createdAt.desc
          description: Specifies how the results are sorted
          enum:
          - createdAt.asc
          - createdAt.desc
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentsV1Response'
          description: Payments Details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      summary: ⚠️Get all payments of a given space
      tags:
      - Payments V1
    post:
      deprecated: true
      description: Initiate a payment process
      operationId: initiatePaymentV1
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationV1Request'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentInitiationResponse'
          description: Payment initiated
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: Initiate a payment
      tags:
      - Payments V1
  /v1/spaces/{spaceId}/payments/collect/consents:
    get:
      description: 'Get all payment collect consents <br/> Scope: space_read'
      operationId: listPaymentCollectConsents
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - description: Include only consents acquired for the specified method
        in: query
        name: method
        required: false
        schema:
          type: string
          description: Include only consents acquired for the specified method
          enum:
          - DIRECT_DEBIT
          - OPENBANKING
          - IDEAL
          - BANCONTACT
          - CARDS
      - description: Include only consents with the specified status
        in: query
        name: status
        required: false
        schema:
          type: string
          description: Include only consents with the specified status
          enum:
          - ACTIVE
          - SUSPENDED
          - ENDED
      - description: Include only consents given by the specified connection
        in: query
        name: connectionId
        required: false
        schema:
          type: string
          format: uuid
          description: Include only consents given by the specified connection
      - description: Page index
        example: 1
        in: query
        name: page
        required: false
        schema:
          type: integer
          format: int64
          default: 0
          description: Page index
          example: 1
          minimum: 0
      - description: Number of objects in a page
        example: 20
        in: query
        name: size
        required: false
        schema:
          type: integer
          format: int32
          default: 30
          description: Number of objects in a page
          example: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentCollectConsentResponse'
          description: Retrieved collect consents
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: List collect consents
      tags:
      - Payment Collect Consents
    post:
      description: 'Create a payment collect consent request <br/> Scope: space_read'
      operationId: createPaymentCollectConsentRequest
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentCollectConsentRequestInitiation'
        required: true
      responses:
        '204':
          description: No content
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: Create collect consent
      tags:
      - Payment Collect Consents
  /v1/spaces/{spaceId}/payments/collect/consents/{consentId}:
    get:
      description: 'Get details of a payment collect consent given by id <br/> Scope:
        space_read'
      operationId: getPaymentCollectConsentDetails
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: consentId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentCollectConsent'
          description: Retrieved collect consent
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: Get collect consent
      tags:
      - Payment Collect Consents
  /v1/spaces/{spaceId}/payments/collect/consents/{consentId}:cancel:
    post:
      description: 'Cancel a payment collect consent given by id <br/> Scope: space_read'
      operationId: cancelPaymentCollectConsent
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: consentId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationReason'
      responses:
        '204':
          description: Cancel submitted
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: Cancel collect consent
      tags:
      - Payment Collect Consents
  /v1/spaces/{spaceId}/payments/collect/consents/{consentId}:resume:
    post:
      description: 'Resume a payment collect consent given by id <br/> Scope: space_read'
      operationId: resumePaymentCollectConsent
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: consentId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationReason'
      responses:
        '204':
          description: Resume request submitted
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: Resume collect consent
      tags:
      - Payment Collect Consents
  /v1/spaces/{spaceId}/payments/collect/consents/{consentId}:suspend:
    post:
      description: 'Suspend a payment collect consent given by id <br/> Scope: space_read'
      operationId: suspendPaymentCollectConsent
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: consentId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationReason'
      responses:
        '204':
          description: Suspend request submitted
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: Suspend collect consent
      tags:
      - Payment Collect Consents
  /v1/spaces/{spaceId}/payments/transfers:
    post:
      deprecated: true
      description: Initiate a SEPA payment to a known connection account given by
        ID
      operationId: initiateTransferV1
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferInitiationV1Request'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentInitiationResponse'
          description: Payment initiated
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: ⚠️Initiate a transfer
      tags:
      - Payments V1
  /v1/spaces/{spaceId}/payments/{paymentId}:
    get:
      deprecated: true
      description: Retrieves the details about a payment from Data Store
      operationId: getPaymentV1
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: paymentId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentV1'
          description: Payment Details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: ⚠️Get the payment details
      tags:
      - Payments V1
  /v1/spaces/{spaceId}/payments/{paymentId}:cancel:
    post:
      description: 'Cancels the payment, if possible. Depending on the payment type,
        the operation can be async <br/> Scope: space_read, space_write'
      operationId: cancelPayment
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: paymentId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RedirectRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RedirectUrlResponse'
          description: OK
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
      summary: Cancel the payment
      tags:
      - Payments V1
  /v2/spaces/{spaceId}/payments:
    get:
      deprecated: true
      description: Retrieves the details of all payments associated to a space
      operationId: listPaymentsV2
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - description: The payment currency
        in: query
        name: currency
        required: false
        schema:
          type: string
      - description: The payment end to end identifier
        in: query
        name: endToEndId
        required: false
        schema:
          type: string
          description: The payment end to end identifier
      - description: The store account id from which the payment originated
        in: query
        name: accountId
        required: false
        schema:
          type: string
          format: uuid
          description: The store account id from which the payment originated
      - description: The payment status
        in: query
        name: status
        required: false
        schema:
          type: string
          description: The payment status
          enum:
          - RECEIVED
          - OPEN
          - IN_TRANSIT
          - SUCCESSFUL
          - FAILED
          - CANCELED
          - UNKNOWN
          - PLANNED
      - description: The counterparty account identifier
        in: query
        name: counterpartyPaymentAccountIdentifier
        required: false
        schema:
          type: string
          description: The counterparty account identifier
      - description: The payment reference
        in: query
        name: reference
        required: false
        schema:
          type: string
          description: The payment reference
      - description: The minimum of the amount range
        in: query
        name: minAmount
        required: false
        schema:
          type: number
          description: The minimum of the amount range
      - description: The maximum of the amount range
        in: query
        name: maxAmount
        required: false
        schema:
          type: number
          description: The maximum of the amount range
      - description: Page index
        example: 1
        in: query
        name: page
        required: false
        schema:
          type: integer
          format: int64
          default: 0
          description: Page index
          example: 1
          minimum: 0
      - description: Number of objects in a page
        example: 20
        in: query
        name: size
        required: false
        schema:
          type: integer
          format: int32
          default: 30
          description: Number of objects in a page
          example: 20
          maximum: 100
          minimum: 1
      - in: query
        name: sortBy
        required: false
        schema:
          type: string
          default: createdAt.desc
          description: Specifies how the results are sorted
          enum:
          - createdAt.asc
          - createdAt.desc
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentsV2Response'
          description: Payments Details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      summary: ⚠️Get all payments of a given space
      tags:
      - Payments V2
    post:
      deprecated: true
      description: Initiate a SEPA payment request
      operationId: initiatePaymentRequestV2
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationRequestV2'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentInitiationResponse'
          description: Payment initiated
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: Initiate a payment request
      tags:
      - Payments V2
  /v2/spaces/{spaceId}/payments/bulkGet:
    post:
      deprecated: true
      description: Retrieves, at once, the details of a list of payments
      operationId: getPaymentsV2InBulk
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                format: uuid
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPaymentsV2Response'
          description: Payments Details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: ⚠️Get details of multiple payments
      tags:
      - Payments V2
  /v2/spaces/{spaceId}/payments/context/fees:
    post:
      deprecated: true
      description: Obtain a fee corresponding to the provided payment initiation request
      operationId: calculatePaymentV2Fee
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationEvaluationRequestV2'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentFee'
          description: Payment fee details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: ⚠️Calculate payment fee
      tags:
      - Payments V2
  /v2/spaces/{spaceId}/payments/context/fees/{feeId}:
    get:
      description: 'Obtain details about a payment fee <br/> Scope: space_read, space_write,
        account_write'
      operationId: getFee
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: feeId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentFee'
          description: Payment fee details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: Get fee details
      tags:
      - Payments V2
  /v2/spaces/{spaceId}/payments/context:validate:
    post:
      deprecated: true
      description: Validate a payment initiation request in the context of its external
        PIS provider
      operationId: validatePaymentV2Initiation
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationEvaluationRequestV2'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentInitiationValidationResponse'
          description: Validation result
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_read
      summary: ⚠️Validate a payment initiation request
      tags:
      - Payments V2
  /v2/spaces/{spaceId}/payments/transfers:
    post:
      description: 'Initiate a SEPA payment request to a known connection account
        given by ID <br/> Scope: space_read, space_write, account_write'
      operationId: initiateTransfer
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferInitiationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentInitiationResponse'
          description: Payment initiated
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: Initiate a transfer
      tags:
      - Payments V2
  /v2/spaces/{spaceId}/payments/transfers/context/fees:
    post:
      description: 'Obtain a fee corresponding to the provided transfer initiation
        request <br/> Scope: space_read, space_write, account_write'
      operationId: calculateTransferFee
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferInitiationEvaluationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentFee'
          description: Payment fee details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: Calculate transfer fee
      tags:
      - Payments V2
  /v2/spaces/{spaceId}/payments/transfers/context:validate:
    post:
      description: 'Validate a transfer initiation request in the context of its PIS
        provider <br/> Scope: space_read, space_write, account_write'
      operationId: validateTransferInitiation
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferInitiationEvaluationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentInitiationValidationResponse'
          description: Validation result
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: Validate a transfer initiation request
      tags:
      - Payments V2
  /v2/spaces/{spaceId}/payments/{paymentId}:
    get:
      deprecated: true
      description: Retrieves the details about a payment
      operationId: getPaymentV2
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: paymentId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentV2'
          description: Payment Details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: ⚠️Get the payment details
      tags:
      - Payments V2
  /v3/spaces/{spaceId}/payments:
    get:
      description: 'Retrieves the details of all payments associated to a space <br/>
        Scope: []'
      operationId: getPayments
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - description: The payment currency
        in: query
        name: currency
        required: false
        schema:
          type: string
      - description: The payment end to end identifier
        in: query
        name: endToEndId
        required: false
        schema:
          type: string
          description: The payment end to end identifier
      - description: The store account id from which the payment originated
        in: query
        name: accountId
        required: false
        schema:
          type: string
          format: uuid
          description: The store account id from which the payment originated
      - description: The payment status
        in: query
        name: status
        required: false
        schema:
          type: string
          description: The payment status
          enum:
          - RECEIVED
          - OPEN
          - IN_TRANSIT
          - SUCCESSFUL
          - FAILED
          - CANCELED
          - UNKNOWN
          - PLANNED
      - description: The counterparty account identifier
        in: query
        name: counterpartyPaymentAccountIdentifier
        required: false
        schema:
          type: string
          description: The counterparty account identifier
      - description: The payment reference
        in: query
        name: reference
        required: false
        schema:
          type: string
          description: The payment reference
      - description: The minimum of the amount range
        in: query
        name: minAmount
        required: false
        schema:
          type: number
          description: The minimum of the amount range
      - description: The maximum of the amount range
        in: query
        name: maxAmount
        required: false
        schema:
          type: number
          description: The maximum of the amount range
      - description: Page index
        example: 1
        in: query
        name: page
        required: false
        schema:
          type: integer
          format: int64
          default: 0
          description: Page index
          example: 1
          minimum: 0
      - description: Number of objects in a page
        example: 20
        in: query
        name: size
        required: false
        schema:
          type: integer
          format: int32
          default: 30
          description: Number of objects in a page
          example: 20
          maximum: 100
          minimum: 1
      - in: query
        name: sortBy
        required: false
        schema:
          type: string
          default: createdAt.desc
          description: Specifies how the results are sorted
          enum:
          - createdAt.asc
          - createdAt.desc
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentsResponse'
          description: Payments Details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      summary: Get all payments of a given space
      tags:
      - Payments
    post:
      description: 'Initiate a payment process <br/> Scope: space_read, space_write,
        account_write'
      operationId: initiatePayment
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentInitiationResponse'
          description: Payment initiated
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: Initiate a payment
      tags:
      - Payments
  /v3/spaces/{spaceId}/payments/bulkGet:
    post:
      description: 'Retrieves the details of a list of payments from Data Store <br/>
        Scope: space_read'
      operationId: getPaymentsInBulk
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                format: uuid
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPaymentsResponse'
          description: Payments Details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: Get details of multiple payments
      tags:
      - Payments
  /v3/spaces/{spaceId}/payments/context/fees:
    post:
      description: 'Obtain a fee corresponding to the provided payment initiation
        request <br/> Scope: space_read, space_write, account_write'
      operationId: calculatePaymentFee
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationEvaluationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentFee'
          description: Payment fee details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_write
      summary: Calculate payment fee
      tags:
      - Payments
  /v3/spaces/{spaceId}/payments/context:validate:
    post:
      description: 'Validate a payment initiation request in the context of its external
        PIS provider <br/> Scope: space_read, space_write, account_read'
      operationId: validatePaymentInitiation
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationEvaluationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentInitiationValidationResponse'
          description: Validation result
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
        - space_write
        - account_read
      summary: Validate a payment initiation request
      tags:
      - Payments
  /v3/spaces/{spaceId}/payments/{paymentId}:
    get:
      description: 'Retrieves the details about a payment from Data Store <br/> Scope:
        space_read'
      operationId: getPayment
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: paymentId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
          description: Payment Details
        '400':
          content:
            application/json:
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: BAD REQUEST
        '401':
          content:
            application/json:
              example:
                status: 401
                error: UNAUTHENTICATED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Unauthorized
                detail: Access to the requested resource lacks valid authentication
                  credentials.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: UNAUTHORIZED
        '403':
          content:
            application/json:
              example:
                status: 403
                error: PERMISSION_DENIED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Forbidden
                detail: Access to the requested resource was denied.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: FORBIDDEN
        '404':
          content:
            application/json:
              example:
                status: 404
                error: NOT FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: Requested resource was not found.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: NOT FOUND
        '503':
          content:
            application/json:
              example:
                status: 503
                error: UNAVAILABLE
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Service Unavailable
                detail: Service is unavailable. Please try again later.
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
          description: SERVICE UNAVAILABLE
      security:
      - oauth2:
        - space_read
      summary: Get the payment details
      tags:
      - Payments
components:
  schemas:
    AccountIdentifier:
      type: object
      description: The account information of the party
      properties:
        bank:
          $ref: '#/components/schemas/BankIdentifier'
        country:
          type: string
          example: BE
          pattern: ^[a-zA-Z]{2}
        currency:
          type: string
          description: International code ISO 4217 of the currency used
          example: EUR
          pattern: '[A-Z]{3}'
        identifier:
          type: string
          description: Account Identifier
          example: BE83504010119715
          minLength: 1
        parent:
          $ref: '#/components/schemas/AccountIdentifier'
        scheme:
          type: string
          description: Account Scheme
          example: IBAN
      required:
      - currency
      - identifier
      - scheme
    AmountDto:
      type: object
      description: 'Amount expressed in the currency of the originating party account.

        Can be omitted if counter party amount is present and both parties use the
        same currency'
      properties:
        currency:
          type: string
          description: International code of the currency used
          example: EUR
          pattern: '[A-Z]{3}'
        value:
          type: string
          description: Amount value with a maximum of 14 integer digits and 2 fractional
            digits
          example: '10.05'
      required:
      - currency
      - value
    ApiErrorProblemDetail:
      type: object
      properties:
        detail:
          type: string
        error:
          type: string
        instance:
          type: string
          format: uri
        problems:
          type: array
          items:
            $ref: '#/components/schemas/NestedProblem'
        properties:
          type: object
          additionalProperties:
            type: object
        requestId:
          type: string
        status:
          type: integer
          format: int32
        timestamp:
          type: string
          format: date-time
        title:
          type: string
        type:
          type: string
          format: uri
      required:
      - error
      - requestId
      - timestamp
    BankIdentifier:
      type: object
      description: Information about the issuer of the account
      properties:
        identifier:
          type: string
          description: Bank Identifier
          example: PANXBEB1XXX
          minLength: 1
        scheme:
          type: string
          description: Bank Identifier Scheme
          enum:
          - BIC
          - CODE
          - ABA
          - CLABE
          - THIRD_PARTY
          example: BIC
      required:
      - identifier
      - scheme
    BulkPaymentsResponse:
      type: object
      properties:
        payments:
          type: array
          description: The retrieved list of payments
          items:
            $ref: '#/components/schemas/Payment'
      required:
      - payments
    BulkPaymentsV2Response:
      type: object
      properties:
        payments:
          type: array
          description: The retrieved list of payments
          items:
            $ref: '#/components/schemas/PaymentV2'
      required:
      - payments
    Iso20022StructuredAddress:
      type: object
      description: Information that locates and identifies a specific address, as
        defined by postal services
      externalDocs:
        description: More about EPC Interbank Structured Address Structure; see also
          PostalAddress27 type in https://www.iso20022.org/message/22905/download
        url: https://www.europeanpaymentscouncil.eu/sites/default/files/kb/file/2022-10/EPC153-22%20EPC%20guidance%20document%20-%20Use%20of%20Structured%20Address%20under%20the%20SEPA%20Payment%20Schemes%20as%20of%20Nov%202025.pdf
      properties:
        addressType:
          type: string
          description: Identifies the nature of the postal address.
          enum:
          - ADDR
          - PBOX
          - HOME
          - BIZZ
          - MLTO
          - DLVY
          example: ADDR
        buildingName:
          type: string
          description: Name of the building or house.
          example: Empire State Building
          maxLength: 140
          minLength: 0
        buildingNumber:
          type: string
          description: A unique number assigned to the building in the street or area
            //Number that identifies the position of a building on a street.
          example: '40'
          maxLength: 16
          minLength: 0
        careOf:
          type: string
          description: Identifies an addressee that is accepting the correspondence
            for the intended recipient. Using care of ensures the correspondence reaches
            the right recipient rather than getting returned to the sender.
          example: Finance
          maxLength: 140
          minLength: 0
        country:
          type: string
          description: Nation with its own government, expressed as a two letter ISO
            3166 code (alpha-2) of the country. The country code is written in upper
            case.
          example: BE
          maxLength: 2
          minLength: 0
        countrySubDivision:
          type: string
          description: Identifies a subdivision of a country such as state (USA),
            Bundesland (DE), region, province,....
          example: Florida, Bayern, Wallonia, Hainaut
          maxLength: 35
          minLength: 0
        department:
          type: string
          description: Identification of a division of a large organisation or building.
          example: Finance
          maxLength: 70
          minLength: 0
        districtName:
          type: string
          description: Identifies a subdivision within a country sub-division eg County
            (USA), Landkreis (DE).
          example: Miami-Dade, Coburg
          maxLength: 140
          minLength: 0
        floor:
          type: string
          description: Floor or storey within a building.
          example: ground
          maxLength: 70
          minLength: 0
        postBox:
          type: string
          description: Numbered box in a post office, assigned to a person or organisation,
            where letters are kept until called for.
          example: '1003'
          maxLength: 16
          minLength: 0
        postCode:
          type: string
          description: Identifier consisting of a group of letters and/or numbers
            that is added to a postal address to assist the sorting of mail.
          example: '1310'
          maxLength: 16
          minLength: 0
        room:
          type: string
          description: Building room number.
          example: '2.22'
          maxLength: 70
          minLength: 0
        streetName:
          type: string
          description: Name of a street or thoroughfare.
          example: Avenue Reine Astrid
          maxLength: 140
          minLength: 0
        subDepartment:
          type: string
          description: Identification of a sub-division of a large organisation or
            building.
          example: Accounting
          maxLength: 70
          minLength: 0
        townLocationName:
          type: string
          description: Specific location name within the town. eg Borough (USA), Village
            (GB).
          example: Miami Beach
          maxLength: 140
          minLength: 0
        townName:
          type: string
          description: Name of a built-up area, with defined boundaries, and a local
            government.
          example: La Hulpe
          maxLength: 140
          minLength: 0
        unitNumber:
          type: string
          description: Identifies a flat or dwelling within the building.
          example: '2'
          maxLength: 16
          minLength: 0
      required:
      - country
    ListPaymentCollectConsentResponse:
      type: object
      properties:
        consents:
          type: array
          description: The retrieved list of consents
          items:
            $ref: '#/components/schemas/PaymentCollectConsent'
        currentPage:
          type: integer
          format: int64
          description: Current page
          example: 21
        pageCount:
          type: integer
          format: int64
          description: Number of pages returned by your search
          example: 20
        pageSize:
          type: integer
          format: int64
          description: Number of items included in each page
          example: 20
        totalElements:
          type: integer
          format: int64
          description: Number of items returned by your search
          example: 20
      required:
      - consents
    ListPaymentsResponse:
      type: object
      properties:
        currentPage:
          type: integer
          format: int64
          description: Current page
          example: 21
        pageCount:
          type: integer
          format: int64
          description: Number of pages returned by your search
          example: 20
        pageSize:
          type: integer
          format: int64
          description: Number of items included in each page
          example: 20
        paymentDetails:
          type: array
          description: The retrieved list of payments
          items:
            $ref: '#/components/schemas/Payment'
        totalElements:
          type: integer
          format: int64
          description: Number of items returned by your search
          example: 20
      required:
      - paymentDetails
    ListPaymentsV1Response:
      type: object
      properties:
        currentPage:
          type: integer
          format: int64
          description: Current page
          example: 21
        pageCount:
          type: integer
          format: int64
          description: Number of pages returned by your search
          example: 20
        pageSize:
          type: integer
          format: int64
          description: Number of items included in each page
          example: 20
        paymentDetails:
          type: array
          description: The retrieved list of payments
          items:
            $ref: '#/components/schemas/PaymentV1'
        totalElements:
          type: integer
          format: int64
          description: Number of items returned by your search
          example: 20
      required:
      - paymentDetails
    ListPaymentsV2Response:
      type: object
      properties:
        currentPage:
          type: integer
          format: int64
          description: Current page
          example: 21
        pageCount:
          type: integer
          format: int64
          description: Number of pages returned by your search
          example: 20
        pageSize:
          type: integer
          format: int64
          description: Number of items included in each page
          example: 20
        paymentDetails:
          type: array
          description: The retrieved list of payments
          items:
            $ref: '#/components/schemas/PaymentV2'
        totalElements:
          type: integer
          format: int64
          description: Number of items returned by your search
          example: 20
      required:
      - paymentDetails
    NestedProblem:
      type: object
      properties:
        detail:
          type: string
        error:
          type: string
        title:
          type: string
        type:
          type: string
          format: uri
      required:
      - detail
      - error
      - title
    OperationReason:
      type: object
      description: Reason why the SDD consent will be canceled
      example: Contract suspended
      properties:
        reason:
          type: string
          minLength: 1
      required:
      - reason
    Payment:
      type: object
      description: The retrieved list of payments
      properties:
        availableOperations:
          type: array
          description: Set of available operations for the current payment
          items:
            type: string
            description: Set of available operations for the current payment
            enum:
            - RETRIEVE_DETAILS
            - CANCEL
          uniqueItems: true
        children:
          type: array
          description: The child payments
          items:
            $ref: '#/components/schemas/Payment'
        counterParty:
          $ref: '#/components/schemas/PaymentCounterParty'
        counterPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        createdAt:
          type: string
          format: date
          description: The creation date
          example: 2024-10-10
        endToEndId:
          type: string
          description: The payment end to end id
        feeAmount:
          $ref: '#/components/schemas/AmountDto'
        id:
          type: string
          format: uuid
          description: The payment id
          example: 95717d5f-43d8-4b01-9d53-330af1a39f17
        originatingAccount:
          $ref: '#/components/schemas/AccountIdentifier'
        originatingPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        reference:
          $ref: '#/components/schemas/PaymentReference'
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
        status:
          type: string
          description: The payment status
          enum:
          - RECEIVED
          - OPEN
          - IN_TRANSIT
          - SUCCESSFUL
          - FAILED
          - CANCELED
          - UNKNOWN
          - PLANNED
          example: SUCCESSFUL
        statusReason:
          type: array
          description: The list of description codes for the status reasons
          items:
            type: string
            description: The list of description codes for the status reasons
            enum:
            - ABORTED_CLEARING_ERROR
            - ABORTED_CLEARING_TIMEOUT
            - ABORTED_SETTLEMENT_ERROR
            - ABORTED_SETTLEMENT_TIMEOUT
            - ACCESS_RIGHTS_INVALID
            - ACCOUNT_BLOCKED
            - ACCOUNT_CURRENCY_INVALID
            - ACCOUNT_DETAILS_CHANGED
            - ACCOUNT_NOT_ALLOWED
            - ACCOUNT_NUMBER_CLOSED
            - ACCOUNT_NUMBER_INVALID
            - ACCOUNT_PROXY_INVALID
            - ACCOUNT_TYPE_INVALID
            - AGENT_COUNTRY_INVALID
            - AGENT_INCORRECT
            - AGENT_OFFLINE
            - AGENT_REASON_NOT_SPECIFIED
            - AGENT_SUSPENDED
            - AMOUNT_BELOW_CLEARING_SYSTEM_MIN
            - AMOUNT_BLOCKED
            - AMOUNT_EXCEEDS_AGREED_LIMIT
            - AMOUNT_EXCEEDS_CLEARING_SYSTEM_LIMIT
            - AMOUNT_EXCEEDS_SETTLEMENT_LIMIT
            - AMOUNT_INVALID
            - AMOUNT_NOT_ALLOWED
            - AMOUNT_TOO_LOW
            - AMOUNT_WRONG
            - AMOUNT_ZERO
            - ATTACHMENT_NOT_SUPPORTED
            - AUTH_CANCELLED
            - BALANCE_INFO_REQUEST
            - BANK_CORRESPONDENT_NOT_POSSIBLE
            - BANK_IDENTIFIER_INCORRECT
            - BANK_IDENTIFIER_INVALID
            - BANK_OPERATION_CODE_INVALID
            - BANK_PROCESSING_ERROR
            - BIC_INVALID
            - BOOK_TRANSFER_NOT_ALLOWED
            - BRANCH_CODE_INVALID
            - CANCELLATION_DELIVERY_ACKNOWLEDGED
            - CANCELLATION_ACKNOWLEDGED
            - CANCELLATION_REQUEST_FORWARDED
            - CANCELLATION_REQUEST_NOT_FOUND
            - CANCELLATION_REQUEST_PENDING
            - CARD_NUMBER_INVALID
            - CATEGORY_PURPOSE_CODE_INVALID
            - CHARACTER_SET_INVALID
            - CHARGE_BEARER_CODE_INVALID
            - CHECK_ERI
            - CHEQUE_NUMBER_INVALID
            - CHEQUE_SETTLED_ON_CREDITOR_ACCOUNT
            - CLEARING_REQUEST_ABORTED
            - CLEARING_SYSTEM_IDENTIFIER_INVALID
            - CLEARING_SYSTEM_SERVICE
            - COLLECTION_NOT_DUE
            - CONTACT_DETAILS_INVALID
            - CONTROL_SUM_INVALID
            - CORE_AND_B2B_CONFLICT
            - COUNTRY_INVALID
            - COUNTRY_OF_RESIDENCE_INVALID
            - CREATION_DATE_INVALID
            - CREDITOR_ACCOUNT_INVALID_CURRENCY
            - CREDITOR_ACCOUNT_NUMBER_CLOSED
            - CREDITOR_ACCOUNT_NUMBER_INVALID
            - CREDITOR_ACCOUNT_TYPE_INVALID
            - CREDITOR_ADDRESS_MISSING
            - CREDITOR_AGENT_COUNTRY_INVALID
            - CREDITOR_AGENT_ERROR
            - CREDITOR_AGENT_OFFLINE
            - CREDITOR_AGENT_SPECIFIC_SERVICE
            - CREDITOR_AGENT_SUSPENDED
            - CREDITOR_AGENT_TIMEOUT
            - CREDITOR_BANK_IDENTIFIER_INVALID
            - CREDITOR_BANK_NOT_REGISTERED
            - CREDITOR_BIC_INVALID
            - CREDITOR_BLACKLISTED_BY_DEBTOR
            - CREDITOR_CLEARING_SYSTEM_IDENTIFIER_INVALID
            - CREDITOR_COUNTRY_INVALID
            - CREDITOR_COUNTRY_OF_RESIDENCE_INVALID
            - CREDITOR_IDENTIFICATION_CODE_INVALID
            - CREDITOR_IDENTIFIER_AMBIGUOUS
            - CREDITOR_IDENTIFIER_INCORRECT
            - CREDITOR_NAME_ADDRESS_MISSING
            - CREDITOR_NAME_FORMAT_ERROR
            - CREDITOR_NAME_MISSING
            - CREDITOR_NOT_WHITELISTED_BY_DEBTOR
            - CREDITOR_SCHEME_ID_INVALID
            - CREDITOR_UNKNOWN
            - CREDIT_DEBIT_NOT_CONFIRMED
            - CREDIT_PENDING_DOCUMENTS
            - CREDIT_PENDING_FUNDS
            - CURRENCY_INCOMPATIBLE_DECIMAL_POINT
            - CURRENCY_INCORRECT
            - CURRENCY_NOT_ALLOWED
            - CUSTOMER_DECEASED
            - CUSTOMER_NO_ANSWER
            - CUSTOMER_REASON_NOT_SPECIFIED
            - CUSTOMER_UNKNOWN
            - CUTOFF_DATE_INVALID
            - CUTOFF_TIME_INVALID
            - DAILY_LIMIT_EXCEEDED
            - DATA_SIGN_REQUESTED
            - DATE_INVALID
            - DATE_INVALID_NON_PROCESSING
            - DEBTOR_ACCOUNT_IDENTIFIER_MISSING
            - DEBTOR_ACCOUNT_INVALID_CURRENCY
            - DEBTOR_ACCOUNT_NOT_TO_BE_USED
            - DEBTOR_ACCOUNT_NUMBER_CLOSED
            - DEBTOR_ACCOUNT_NUMBER_INVALID
            - DEBTOR_ACCOUNT_TYPE_INVALID
            - DEBTOR_ADDRESS_MISSING
            - DEBTOR_AGENT_COUNTRY_INVALID
            - DEBTOR_AGENT_NOT_TO_BE_USED
            - DEBTOR_AGENT_SERVICE_ID_INVALID
            - DEBTOR_AGENT_SPECIFIC_SERVICE
            - DEBTOR_AGENT_TIMEOUT
            - DEBTOR_BANK_IDENTIFIER_INVALID
            - DEBTOR_BANK_NOT_REGISTERED
            - DEBTOR_BIC_INVALID
            - DEBTOR_CLEARING_SYSTEM_IDENTIFIER_INVALID
            - DEBTOR_COUNTRY_INVALID
            - DEBTOR_COUNTRY_OF_RESIDENCE_INVALID
            - DEBTOR_IDENTIFICATION_CODE_INVALID
            - DEBTOR_NAME_ADDRESS_MISSING
            - DEBTOR_NAME_FORMAT_ERROR
            - DEBTOR_NAME_MISSING
            - DECOMPRESSION_ERROR
            - DECRYPTION_ERROR
            - DELIVERED_WITHOUT_SERVICE_LEVEL
            - DELIVERED_WITH_SERVICE_LEVEL
            - DIRECT_DEBIT_AMOUNT_LIMIT_EXCEEDED
            - DIRECT_DEBIT_COUNT_LIMIT_EXCEEDED
            - DIRECT_DEBIT_UNSUCCESSFUL
            - DUPLICATION
            - ELECTRONIC_SIGNATURE_CORRECT
            - ELEMENT_CONTENT_INCORRECT
            - ELEMENT_CONTENT_TOO_LONG
            - ELEMENT_NOT_ALLOWED
            - ELEMENT_NOT_USED_AT_B
            - END_TO_END_ID_DUPLICATE
            - END_TO_END_ID_INVALID
            - ERI_MISSING
            - ERI_NOT_SUPPORTED
            - EXECUTION_DATE_CHANGED
            - EXPIRATION_DATETIME_INVALID
            - EXPIRATION_DATETIME_REACHED
            - EXPIRATION_DATETIME_TOO_FAR
            - FILE_FORMAT_INVALID
            - FILE_NON_READABLE
            - FILE_STRUCTURE_INCORRECT
            - FLAGGED_FOR_CANCELLATION
            - FRAUD
            - FRAUDULENT_ORIGIN
            - FUTURE_DATE_NOT_SUPPORTED
            - IDENTIFICATION_CODE_INVALID
            - INCONSISTENT_WITH_END_CUSTOMER
            - INITIATING_PARTY_UNRECOGNISED
            - INSTRUCTED_AGENT
            - INSTRUCTED_AGENT_TIMEOUT
            - INSTRUCTION_ID_DUPLICATE
            - INSUFFICIENT_FUNDS
            - INTERMEDIARY_AGENT_INVALID
            - LIMIT_EXCEEDED
            - LOCAL_INSTRUMENT_CODE_INVALID
            - MANDATE_CHANGES_NOT_ALLOWED
            - MANDATE_INFORMATION_MISSING
            - MANDATE_MISSING_INFORMATION
            - MANDATORY_ELEMENT_MISSING
            - MESSAGE_ID_DUPLICATE
            - MISSING_NAME
            - MONTHLY_LIMIT_EXCEEDED
            - NAME_LENGTH_INVALID
            - NARRATIVE
            - NOT_COMPLIANT
            - NO_DATA_AVAILABLE
            - NO_MANDATE
            - ORDER_CANCELLED
            - ORDER_FILE_DELETED
            - ORDER_FORWARDED_FOR_POSTPROCESSING
            - ORDER_NOT_CANCELLED
            - ORDER_REJECTED
            - ORIGINAL_FILE_NOT_SENT
            - PARTY_ID_INVALID
            - PAYER_NOT_REACHABLE
            - PAYMENT_DUPLICATE
            - PAYMENT_ID_DUPLICATE
            - PAYMENT_INSTR_TYPE_UNSUPPORTED
            - PAYMENT_NOT_ALLOWED
            - PAYMENT_NOT_RECEIVED
            - PAYMENT_NO_GUARANTEE
            - PAYMENT_TRANSFERRED_AND_TRACKED
            - PAYMENT_TRANSFERRED_NOT_TRACKED
            - PAYMENT_TYPE_INFO_INVALID
            - PAYMENT_UNDUE
            - PROCESSING_OK
            - PUBLIC_KEY_VERSION_INCORRECT
            - PURPOSE_INVALID
            - RECEIVER_CUSTOMER_INFORMATION
            - RECEIVER_TOKEN_NOT_FOUND
            - REFUND_REQUEST_BY_CUSTOMER
            - REGULATORY_INFORMATION_INVALID
            - REGULATORY_REASON
            - REJECTED_BY_ASPSP
            - REMEDIATION_NOT_POSSIBLE
            - REMITTANCE_INFORMATION_INVALID
            - REMITTANCE_INFORMATION_TRUNCATED
            - REPEAT_ORDER
            - REQUESTED_BY_CUSTOMER
            - REQUESTED_EXECUTION_DATE_TOO_FAR_IN_FUTUER
            - REQUESTED_EXECUTION_DATE_TOO_FAR_IN_PAST
            - RETURN_PAYMENT_FORBIDDEN
            - RTP_ALREADY_ACCEPTED
            - RTP_ALREADY_EXPIRED
            - RTP_ALREADY_REFUSED
            - RTP_ALREADY_REJECTED
            - RTP_DEBTOR_NOT_SUPPORTED
            - RTP_NEVER_RECEIVER
            - RTP_NOT_AGREED
            - RTP_RECEIVED
            - RTP_SP_IDENTIFIER_INCORRECT
            - R_MESSAGE_CONFLICT
            - SAME_DEBTOR_AND_CREDITOR_ACCOUNT
            - SENDER_TOKEN_NOT_FOUND
            - SERVICE_LEVEL_CODE_INVALID
            - SERVICE_UNAVAILABLE
            - SETTLEMENT_FAILED
            - SETTLEMENT_NOT_RECEIVED
            - SETTLEMENT_SYSTEM_NOT_AVAILABLE
            - SIGNATURE_ALREADY_SENT
            - SIGNATURE_INSUFFICIENT_RIGHTS
            - SIGNATURE_ORDER_DATA_MISMATCH
            - SIGNER_1_CA_INVALID
            - SIGNER_1_CERTIFICATE_INCORRECT
            - SIGNER_1_CERTIFICATE_INVALID
            - SIGNER_1_CERTIFICATE_REVOKED
            - SIGNER_2_CA_INVALID
            - SIGNER_2_CERTIFICATE_INCORRECT
            - SIGNER_2_CERTIFICATE_INVALID
            - SIGNER_2_CERTIFICATE_REVOKED
            - SIGNER_CA_INVALID
            - SIGNER_CERTIFICATE_INCORRECT
            - SIGNER_CERTIFICATE_INVALID
            - SIGNER_CERTIFICATE_REVOKED
            - STRUCTURED_CREDITOR_REFERENCE_INVALID
            - SUM_GROUP_CONTROL_INVALID
            - SUM_PAYMENT_CONTROL_INVALID
            - SYNTAX_ERROR
            - TAX_INFORMATION_INVALID
            - TECHNICAL_ERROR
            - TOKEN_COUNTERPARTY_MISMATCH
            - TOKEN_EXPIRED
            - TOKEN_INVALID
            - TOKEN_MISSING
            - TOKEN_SINGLE_USE
            - TOKEN_SUSPENDED
            - TOKEN_VALUE_LIMIT_EXCEEDED
            - TRANSACTIONS_NUMBER_GROUP_INVALID
            - TRANSACTIONS_NUMBER_INVALID
            - TRANSACTIONS_NUMBER_PAYMENT_INVALID
            - TRANSACTION_CANNOT_BE_RETURNED
            - TRANSACTION_CURRENCY_INVALID
            - TRANSACTION_DUPLICATE
            - TRANSACTION_FORBIDDEN
            - TRANSACTION_NOT_SUPPORTED
            - TRANSACTION_NUMBER_NOT_ALLOWED
            - TRANSACTION_REFERENCE_NOT_UNIQUE
            - TRANSFER_ORDER
            - TRANSFER_TO_SIGN_BY_HAND
            - TRANSMISSION_ABORTED
            - TRANSMISSION_SUCCESSFUL
            - UETR_NETWORK_STOP
            - UNKNOWN_DATA_SIGN_FORMAT
            - USER_DOES_NOT_EXIST
            - USER_NOT_YET_ACTIVATED
            - USER_SIGNED_MULTIPLE_TIMES
            - VALUES_SET_TO_NEXT_DAY
            - WAITING_TIME_EXPIRED
            - ZERO_AMOUNT_NOT_APPLIED
        type:
          type: string
          description: Type of payment
          enum:
          - credit
          - debit
          example: debit
      required:
      - availableOperations
      - counterPartyAmount
      - id
      - originatingPartyAmount
      - status
      - statusReason
      - type
    PaymentCollectConsent:
      type: object
      description: The retrieved list of consents
      properties:
        availableOperations:
          type: array
          description: Available operations on the consent
          items:
            type: string
            description: Available operations on the consent
            enum:
            - CANCEL
            - SUSPEND
            - UNSUSPEND
          uniqueItems: true
        connectionId:
          type: string
          format: uuid
          description: Identifier of the Connection who gave this Consent, as defined
            in the current Space
          example: 2b8049df-572f-4fdf-97c4-c74b18862327
        consentId:
          type: string
          format: uuid
          description: The unique identifier of the Consent
          example: b1af9c96-5109-4fde-aa6d-7488aeac12e1
        currency:
          type: string
          description: Currency of the consent
        dateCreated:
          type: string
          format: date-time
          description: The creation timestamp of this Consent
        description:
          type: string
          description: A short textual description about the consent
        expirationDate:
          type: string
          format: date
          description: The date the Consent will expire
        isDefault:
          type: boolean
          description: "Indicates if the consent captured will be used for this payer\
            \ when the merchant initiates a transaction without specifying a specific\
            \ consent. \nWhen a consent is created or updated with true, all the existing\
            \ consent  are updated to false"
        lastUpdateDate:
          type: string
          format: date-time
          description: The timestamp on which the value of any attribute of the consent
            was changed for the last time
        mandateReference:
          type: string
          description: A distinguishing number by source system (ocs) which must be
            added to the SEPA mandate
        maskedPan:
          type: string
          description: The first 4 and last 2 digits of the cardId. The other digits
            are replaced by an asterix.
        method:
          type: string
          description: The Payment method for which Consent is given
          enum:
          - DIRECT_DEBIT
          - OPENBANKING
          - IDEAL
          - BANCONTACT
          - CARDS
        payerAccount:
          $ref: '#/components/schemas/AccountIdentifier'
        status:
          type: string
          description: Consent status
          enum:
          - ACTIVE
          - SUSPENDED
          - ENDED
      required:
      - availableOperations
      - connectionId
      - consentId
      - currency
      - dateCreated
      - expirationDate
      - isDefault
      - lastUpdateDate
      - method
      - status
    PaymentCollectConsentRequestInitiation:
      type: object
      properties:
        connectionId:
          type: string
          format: uuid
          description: Identifier of the Connection who should give this consent,
            as defined in the current Space
        connectionName:
          type: string
          description: The name of the Connection who should give this consent
        currency:
          type: string
          description: Currency of the consent. If not provided, the currency of the
            collect account will be used
          example: EUR
        description:
          type: string
          description: The description of the consent
          minLength: 1
        emailAddress:
          type: string
          description: Email address to which a notification will be sent with the
            collect consent details
          minLength: 1
        locale:
          type: string
          description: The locale to use on web pages presented to the user
          example: nl, NL, NL-NL, nl-NL, nl-BE, NL-BE
      required:
      - connectionId
      - description
      - emailAddress
    PaymentCounterParty:
      type: object
      description: The creditor information
      properties:
        account:
          $ref: '#/components/schemas/AccountIdentifier'
        address:
          $ref: '#/components/schemas/Iso20022StructuredAddress'
        name:
          type: string
          description: The name of the party
          example: Company XYZ
          minLength: 1
        verificationId:
          type: string
          description: The verification of payee id
      required:
      - account
      - name
    PaymentCounterPartyV1:
      type: object
      description: The creditor information
      properties:
        account:
          $ref: '#/components/schemas/AccountIdentifier'
        address:
          $ref: '#/components/schemas/SepaStructuredAddress'
        name:
          type: string
          description: The name of the party
          example: Company XYZ
          minLength: 1
        verificationId:
          type: string
          description: The verification of payee id
      required:
      - account
      - name
    PaymentCurrencyConversion:
      type: object
      description: Specifies the details of any currency conversion that might be
        required to perform the payment. Null if no conversion is required
      properties:
        buyAmount:
          $ref: '#/components/schemas/AmountDto'
        conversionRate:
          type: number
          description: Specifies the rate used for converting the sell currency to
            the buy currency
        sellAmount:
          $ref: '#/components/schemas/AmountDto'
      required:
      - buyAmount
      - conversionRate
      - sellAmount
    PaymentFee:
      type: object
      properties:
        agreementPolicy:
          type: string
          description: Specifies whether the fee requires explicit user consent or
            not
          enum:
          - IMPLICIT
          - CONSENT_REQUIRED
        counterPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        currencyConversion:
          $ref: '#/components/schemas/PaymentCurrencyConversion'
        expirationTime:
          type: string
          format: date-time
          description: Time until the fee is valid
        feeAmount:
          $ref: '#/components/schemas/AmountDto'
        id:
          type: string
          format: uuid
          description: Payment fee identifier. Used in subsequent requests to provide
            user agreement of surcharge
        originatingPartyAmount:
          $ref: '#/components/schemas/AmountDto'
      required:
      - agreementPolicy
      - counterPartyAmount
      - feeAmount
      - id
      - originatingPartyAmount
    PaymentInformationNormalizationResult:
      type: object
      description: List of results for each attached information object that was changed
        during the normalization process. Can be empty if no change has occured
      properties:
        id:
          type: string
          format: uuid
          description: Identifier of the information object
        result:
          type: string
          description: Result of the normalization applied at information level
          enum:
          - SUCCESSFUL
          - FORWARDED
          - FAILED
          example: FORWARDED
        type:
          type: string
          description: Type of information object
          example: InternalMovement
      required:
      - id
      - result
      - type
    PaymentInitiationEvaluationRequest:
      type: object
      properties:
        acceptedFeeId:
          type: string
          format: uuid
          description: Identifier of the PSU accepted fees for the upcoming payment
            initiation process
        debtorAccountId:
          type: string
          format: uuid
          description: The ID of the payment account to be used as debtor
        payments:
          type: array
          description: The list of payment transactions
          items:
            $ref: '#/components/schemas/PaymentInitiationTransaction'
          minItems: 1
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
      required:
      - debtorAccountId
      - payments
    PaymentInitiationEvaluationRequestV2:
      type: object
      properties:
        acceptedFeeId:
          type: string
          format: uuid
          description: Identifier of the PSU accepted fees for the upcoming payment
            initiation process
        debtorAccountId:
          type: string
          format: uuid
          description: The ID of the payment account to be used as debtor
        payments:
          type: array
          description: The list of payment transactions
          items:
            $ref: '#/components/schemas/PaymentInitiationTransactionV2'
          minItems: 1
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
      required:
      - debtorAccountId
      - payments
    PaymentInitiationRequest:
      type: object
      properties:
        acceptedFeeId:
          type: string
          format: uuid
          description: Identifier of the PSU accepted fees for the upcoming payment
            initiation process
        changeNotificationUrl:
          type: string
          description: A URL that will be called whenever change-events happen
          example: https://app.btx.banqup.com/payments/payment-change-notification
        debtorAccountId:
          type: string
          format: uuid
          description: The ID of the payment account to be used as debtor
        locale:
          type: string
          description: The locale to use on web pages presented to the user
          example: nl, NL, NL-NL, nl-NL, nl-BE, NL-BE
        payments:
          type: array
          description: The list of payment transactions
          items:
            $ref: '#/components/schemas/PaymentInitiationTransaction'
          minItems: 1
        redirectUrl:
          type: string
          description: URL to redirect the PSU to once the payment flow is completed
          example: https://app.btx.banqup.com/payments/payment-feedback
          minLength: 1
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
      required:
      - debtorAccountId
      - payments
      - redirectUrl
    PaymentInitiationRequestV2:
      type: object
      properties:
        acceptedFeeId:
          type: string
          format: uuid
          description: Identifier of the PSU accepted fees for the upcoming payment
            initiation process
        changeNotificationUrl:
          type: string
          description: A URL that will be called whenever change-events happen
          example: https://app.btx.banqup.com/payments/payment-change-notification
        debtorAccountId:
          type: string
          format: uuid
          description: The ID of the payment account to be used as debtor
        locale:
          type: string
          description: The locale to use on web pages presented to the user
          example: nl, NL, NL-NL, nl-NL, nl-BE, NL-BE
        payments:
          type: array
          description: The list of payment transactions
          items:
            $ref: '#/components/schemas/PaymentInitiationTransactionV2'
          minItems: 1
        redirectUrl:
          type: string
          description: URL to redirect the PSU to once the payment flow is completed
          example: https://app.btx.banqup.com/payments/payment-feedback
          minLength: 1
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
      required:
      - debtorAccountId
      - payments
      - redirectUrl
    PaymentInitiationResponse:
      type: object
      properties:
        paymentId:
          type: string
          format: uuid
          description: Identifier of the created payment
        redirectUrl:
          type: string
          description: URL to which the PSU needs to be redirected in order to proceed
            with the payment (confirm/authorize)
          example: http://tpp.pay-nxt.com/public/payments/callback/init?paymentPublicId=c1d00d31-ffac-4c35-afca-0e8645a93f62
      required:
      - redirectUrl
    PaymentInitiationTransaction:
      type: object
      description: The list of payment transactions
      properties:
        counterPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        creditor:
          $ref: '#/components/schemas/PaymentCounterParty'
        endToEndIdentification:
          type: string
          description: Unique end to end identifier that will be stored in Data Store
            and sent to the PSP. Can be used for later reconciliation
          example: BTX71bdfe0f3e084871bf03d008d489c569
          maxLength: 35
          minLength: 0
        originatingPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        reference:
          $ref: '#/components/schemas/PaymentReference'
      required:
      - counterPartyAmount
      - creditor
    PaymentInitiationTransactionV2:
      type: object
      description: The list of payment transactions
      properties:
        counterPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        creditor:
          $ref: '#/components/schemas/PaymentCounterPartyV1'
        endToEndIdentification:
          type: string
          description: Unique end to end identifier that will be stored in Data Store
            and sent to the PSP. Can be used for later reconciliation
          example: BTX71bdfe0f3e084871bf03d008d489c569
          maxLength: 35
          minLength: 0
        originatingPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        reference:
          $ref: '#/components/schemas/PaymentReference'
      required:
      - counterPartyAmount
      - creditor
    PaymentInitiationV1Request:
      type: object
      properties:
        bulk:
          type: boolean
          description: Specify whether the payments should be processed individually
            or together
        changeNotificationUrl:
          type: string
          description: A URL that will be called whenever change-events happen
          example: https://app.btx.banqup.com/payments/payment-change-notification
        debtorAccountId:
          type: string
          format: uuid
          description: The ID of the payment account to be used as debtor
        language:
          type: string
          deprecated: true
          description: This field is deprecated, please use locale instead.
        locale:
          type: string
          description: The locale to use on web pages presented to the user
          example: nl, NL, NL-NL, nl-NL, nl-BE, NL-BE
        payments:
          type: array
          description: The list of payment transactions
          items:
            $ref: '#/components/schemas/PaymentInitiationV1Transaction'
          minItems: 1
        redirectUrl:
          type: string
          description: URL to redirect the PSU to once the payment flow is completed
          example: https://app.btx.banqup.com/payments/payment-feedback
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
      required:
      - debtorAccountId
      - payments
    PaymentInitiationV1Transaction:
      type: object
      description: The list of payment transactions
      properties:
        amount:
          $ref: '#/components/schemas/AmountDto'
        creditor:
          $ref: '#/components/schemas/PaymentCounterPartyV1'
        endToEndIdentification:
          type: string
          description: Unique end to end identifier that will be stored in Data Store
            and sent to the PSP. Can be used for later reconciliation
          example: BTX71bdfe0f3e084871bf03d008d489c569
          maxLength: 35
          minLength: 0
        reference:
          $ref: '#/components/schemas/PaymentReference'
      required:
      - amount
      - creditor
    PaymentInitiationValidationMessage:
      type: object
      description: List of breaking problems with the provided requests. Only provided
        if validationResult is INVALID
      properties:
        errorCode:
          type: string
          enum:
          - BULK_NOT_SUPPORTED_FOR_EXECUTION_METHOD
          - SCHEDULING_NOT_SUPPORTED_FOR_EXECUTION_METHOD
          - RESTRICTED_ZONE
          - RESTRICTED_ZONE_CURRENCY
          - RESTRICTED_CURRENCY
          - UNSUPPORTED_CURRENCY
          - UNSUPPORTED_CURRENCY_EXCHANGE
          - FIELD_REQUIREMENTS_FOR_EXECUTION_METHOD
          - FEE_NOT_ACCEPTED_BY_PSU
          - FEE_INVALID
          - FEE_EXPIRED
          - LARGE_AMOUNT_REQUIRES_SYS_APPROVAL
          - CREDITOR_ACCOUNT_VS_COUNTERPARTY_AMOUNT_MISMATCH
        field:
          type: string
          description: Full json path to the problem field of the payload
          minLength: 1
        message:
          type: string
          description: Short explanation of the problem
          minLength: 1
        parameters:
          type: object
          additionalProperties:
            type: object
            description: Additional parameters
          description: Additional parameters
        testExpression:
          type: string
          description: An expression against which the provided value is tested. This
            is only provided in the case of dynamic PIS provider validation
      required:
      - errorCode
      - field
      - message
    PaymentInitiationValidationResponse:
      type: object
      properties:
        alerts:
          type: array
          description: List of non-breaking problems with the provided requests. Can
            be provided for both VALID and INVALID results.
          items:
            $ref: '#/components/schemas/PaymentInitiationValidationMessage'
          minItems: 1
        errors:
          type: array
          description: List of breaking problems with the provided requests. Only
            provided if validationResult is INVALID
          items:
            $ref: '#/components/schemas/PaymentInitiationValidationMessage'
          minItems: 1
        paymentExecutionMethod:
          type: string
          description: Specifies which execution method would be used to execute the
            received payment
          enum:
          - OPEN_BANKING
          - CAPTURE_AND_FORWARD
          - FOREIGN
          - UNSUPPORTED
        validationResult:
          type: string
          description: Specifies whether the provided payment initiation request can
            be used as is to actually initiate a payment
          enum:
          - VALID
          - INVALID
      required:
      - alerts
      - errors
      - paymentExecutionMethod
      - validationResult
    PaymentNormalizationResponse:
      type: object
      properties:
        informationNormalizationResults:
          type: array
          description: List of results for each attached information object that was
            changed during the normalization process. Can be empty if no change has
            occured
          items:
            $ref: '#/components/schemas/PaymentInformationNormalizationResult'
        paymentId:
          type: string
          format: uuid
          description: Identifier of the normalized payment
        result:
          type: string
          description: Result of the payment normalization process
          enum:
          - SUCCESSFUL
          - FORWARDED
          - FAILED
      required:
      - informationNormalizationResults
      - paymentId
      - result
    PaymentReference:
      type: object
      description: The Payment Reference to use for this payment for later reconciliation
      properties:
        scheme:
          type: string
          enum:
          - OGM_VCS
          - ISO_11649
          - ACCEPT_GIRO
          - STRUCTURED_EE
          - STRUCTURED_SE
          - STRUCTURED_LU
          - STRUCTURED_FI
          - STRUCTURED_NO
          - STRUCTURED_CZ
        type:
          type: string
          enum:
          - STRUCTURED
          - UNSTRUCTURED
        value:
          type: string
          minLength: 1
      required:
      - type
      - value
    PaymentV1:
      type: object
      description: The retrieved list of payments
      properties:
        amount:
          $ref: '#/components/schemas/AmountDto'
        availableOperations:
          type: array
          description: Set of available operations for the current payment
          items:
            type: string
            description: Set of available operations for the current payment
            enum:
            - RETRIEVE_DETAILS
            - CANCEL
          uniqueItems: true
        children:
          type: array
          description: The child payments
          items:
            $ref: '#/components/schemas/PaymentV1'
        counterParty:
          $ref: '#/components/schemas/PaymentCounterPartyV1'
        createdAt:
          type: string
          format: date
          description: The creation date
          example: 2024-10-10
        endToEndId:
          type: string
          description: The payment end to end id
        id:
          type: string
          format: uuid
          description: The payment id
          example: 95717d5f-43d8-4b01-9d53-330af1a39f17
        originatingAccount:
          $ref: '#/components/schemas/AccountIdentifier'
        reference:
          $ref: '#/components/schemas/PaymentReference'
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
        status:
          type: string
          description: The payment status
          enum:
          - RECEIVED
          - OPEN
          - IN_TRANSIT
          - SUCCESSFUL
          - FAILED
          - CANCELED
          - UNKNOWN
          - PLANNED
          example: SUCCESSFUL
        statusReason:
          type: array
          description: The list of description codes for the status reasons
          items:
            type: string
            description: The list of description codes for the status reasons
            enum:
            - ABORTED_CLEARING_ERROR
            - ABORTED_CLEARING_TIMEOUT
            - ABORTED_SETTLEMENT_ERROR
            - ABORTED_SETTLEMENT_TIMEOUT
            - ACCESS_RIGHTS_INVALID
            - ACCOUNT_BLOCKED
            - ACCOUNT_CURRENCY_INVALID
            - ACCOUNT_DETAILS_CHANGED
            - ACCOUNT_NOT_ALLOWED
            - ACCOUNT_NUMBER_CLOSED
            - ACCOUNT_NUMBER_INVALID
            - ACCOUNT_PROXY_INVALID
            - ACCOUNT_TYPE_INVALID
            - AGENT_COUNTRY_INVALID
            - AGENT_INCORRECT
            - AGENT_OFFLINE
            - AGENT_REASON_NOT_SPECIFIED
            - AGENT_SUSPENDED
            - AMOUNT_BELOW_CLEARING_SYSTEM_MIN
            - AMOUNT_BLOCKED
            - AMOUNT_EXCEEDS_AGREED_LIMIT
            - AMOUNT_EXCEEDS_CLEARING_SYSTEM_LIMIT
            - AMOUNT_EXCEEDS_SETTLEMENT_LIMIT
            - AMOUNT_INVALID
            - AMOUNT_NOT_ALLOWED
            - AMOUNT_TOO_LOW
            - AMOUNT_WRONG
            - AMOUNT_ZERO
            - ATTACHMENT_NOT_SUPPORTED
            - AUTH_CANCELLED
            - BALANCE_INFO_REQUEST
            - BANK_CORRESPONDENT_NOT_POSSIBLE
            - BANK_IDENTIFIER_INCORRECT
            - BANK_IDENTIFIER_INVALID
            - BANK_OPERATION_CODE_INVALID
            - BANK_PROCESSING_ERROR
            - BIC_INVALID
            - BOOK_TRANSFER_NOT_ALLOWED
            - BRANCH_CODE_INVALID
            - CANCELLATION_DELIVERY_ACKNOWLEDGED
            - CANCELLATION_ACKNOWLEDGED
            - CANCELLATION_REQUEST_FORWARDED
            - CANCELLATION_REQUEST_NOT_FOUND
            - CANCELLATION_REQUEST_PENDING
            - CARD_NUMBER_INVALID
            - CATEGORY_PURPOSE_CODE_INVALID
            - CHARACTER_SET_INVALID
            - CHARGE_BEARER_CODE_INVALID
            - CHECK_ERI
            - CHEQUE_NUMBER_INVALID
            - CHEQUE_SETTLED_ON_CREDITOR_ACCOUNT
            - CLEARING_REQUEST_ABORTED
            - CLEARING_SYSTEM_IDENTIFIER_INVALID
            - CLEARING_SYSTEM_SERVICE
            - COLLECTION_NOT_DUE
            - CONTACT_DETAILS_INVALID
            - CONTROL_SUM_INVALID
            - CORE_AND_B2B_CONFLICT
            - COUNTRY_INVALID
            - COUNTRY_OF_RESIDENCE_INVALID
            - CREATION_DATE_INVALID
            - CREDITOR_ACCOUNT_INVALID_CURRENCY
            - CREDITOR_ACCOUNT_NUMBER_CLOSED
            - CREDITOR_ACCOUNT_NUMBER_INVALID
            - CREDITOR_ACCOUNT_TYPE_INVALID
            - CREDITOR_ADDRESS_MISSING
            - CREDITOR_AGENT_COUNTRY_INVALID
            - CREDITOR_AGENT_ERROR
            - CREDITOR_AGENT_OFFLINE
            - CREDITOR_AGENT_SPECIFIC_SERVICE
            - CREDITOR_AGENT_SUSPENDED
            - CREDITOR_AGENT_TIMEOUT
            - CREDITOR_BANK_IDENTIFIER_INVALID
            - CREDITOR_BANK_NOT_REGISTERED
            - CREDITOR_BIC_INVALID
            - CREDITOR_BLACKLISTED_BY_DEBTOR
            - CREDITOR_CLEARING_SYSTEM_IDENTIFIER_INVALID
            - CREDITOR_COUNTRY_INVALID
            - CREDITOR_COUNTRY_OF_RESIDENCE_INVALID
            - CREDITOR_IDENTIFICATION_CODE_INVALID
            - CREDITOR_IDENTIFIER_AMBIGUOUS
            - CREDITOR_IDENTIFIER_INCORRECT
            - CREDITOR_NAME_ADDRESS_MISSING
            - CREDITOR_NAME_FORMAT_ERROR
            - CREDITOR_NAME_MISSING
            - CREDITOR_NOT_WHITELISTED_BY_DEBTOR
            - CREDITOR_SCHEME_ID_INVALID
            - CREDITOR_UNKNOWN
            - CREDIT_DEBIT_NOT_CONFIRMED
            - CREDIT_PENDING_DOCUMENTS
            - CREDIT_PENDING_FUNDS
            - CURRENCY_INCOMPATIBLE_DECIMAL_POINT
            - CURRENCY_INCORRECT
            - CURRENCY_NOT_ALLOWED
            - CUSTOMER_DECEASED
            - CUSTOMER_NO_ANSWER
            - CUSTOMER_REASON_NOT_SPECIFIED
            - CUSTOMER_UNKNOWN
            - CUTOFF_DATE_INVALID
            - CUTOFF_TIME_INVALID
            - DAILY_LIMIT_EXCEEDED
            - DATA_SIGN_REQUESTED
            - DATE_INVALID
            - DATE_INVALID_NON_PROCESSING
            - DEBTOR_ACCOUNT_IDENTIFIER_MISSING
            - DEBTOR_ACCOUNT_INVALID_CURRENCY
            - DEBTOR_ACCOUNT_NOT_TO_BE_USED
            - DEBTOR_ACCOUNT_NUMBER_CLOSED
            - DEBTOR_ACCOUNT_NUMBER_INVALID
            - DEBTOR_ACCOUNT_TYPE_INVALID
            - DEBTOR_ADDRESS_MISSING
            - DEBTOR_AGENT_COUNTRY_INVALID
            - DEBTOR_AGENT_NOT_TO_BE_USED
            - DEBTOR_AGENT_SERVICE_ID_INVALID
            - DEBTOR_AGENT_SPECIFIC_SERVICE
            - DEBTOR_AGENT_TIMEOUT
            - DEBTOR_BANK_IDENTIFIER_INVALID
            - DEBTOR_BANK_NOT_REGISTERED
            - DEBTOR_BIC_INVALID
            - DEBTOR_CLEARING_SYSTEM_IDENTIFIER_INVALID
            - DEBTOR_COUNTRY_INVALID
            - DEBTOR_COUNTRY_OF_RESIDENCE_INVALID
            - DEBTOR_IDENTIFICATION_CODE_INVALID
            - DEBTOR_NAME_ADDRESS_MISSING
            - DEBTOR_NAME_FORMAT_ERROR
            - DEBTOR_NAME_MISSING
            - DECOMPRESSION_ERROR
            - DECRYPTION_ERROR
            - DELIVERED_WITHOUT_SERVICE_LEVEL
            - DELIVERED_WITH_SERVICE_LEVEL
            - DIRECT_DEBIT_AMOUNT_LIMIT_EXCEEDED
            - DIRECT_DEBIT_COUNT_LIMIT_EXCEEDED
            - DIRECT_DEBIT_UNSUCCESSFUL
            - DUPLICATION
            - ELECTRONIC_SIGNATURE_CORRECT
            - ELEMENT_CONTENT_INCORRECT
            - ELEMENT_CONTENT_TOO_LONG
            - ELEMENT_NOT_ALLOWED
            - ELEMENT_NOT_USED_AT_B
            - END_TO_END_ID_DUPLICATE
            - END_TO_END_ID_INVALID
            - ERI_MISSING
            - ERI_NOT_SUPPORTED
            - EXECUTION_DATE_CHANGED
            - EXPIRATION_DATETIME_INVALID
            - EXPIRATION_DATETIME_REACHED
            - EXPIRATION_DATETIME_TOO_FAR
            - FILE_FORMAT_INVALID
            - FILE_NON_READABLE
            - FILE_STRUCTURE_INCORRECT
            - FLAGGED_FOR_CANCELLATION
            - FRAUD
            - FRAUDULENT_ORIGIN
            - FUTURE_DATE_NOT_SUPPORTED
            - IDENTIFICATION_CODE_INVALID
            - INCONSISTENT_WITH_END_CUSTOMER
            - INITIATING_PARTY_UNRECOGNISED
            - INSTRUCTED_AGENT
            - INSTRUCTED_AGENT_TIMEOUT
            - INSTRUCTION_ID_DUPLICATE
            - INSUFFICIENT_FUNDS
            - INTERMEDIARY_AGENT_INVALID
            - LIMIT_EXCEEDED
            - LOCAL_INSTRUMENT_CODE_INVALID
            - MANDATE_CHANGES_NOT_ALLOWED
            - MANDATE_INFORMATION_MISSING
            - MANDATE_MISSING_INFORMATION
            - MANDATORY_ELEMENT_MISSING
            - MESSAGE_ID_DUPLICATE
            - MISSING_NAME
            - MONTHLY_LIMIT_EXCEEDED
            - NAME_LENGTH_INVALID
            - NARRATIVE
            - NOT_COMPLIANT
            - NO_DATA_AVAILABLE
            - NO_MANDATE
            - ORDER_CANCELLED
            - ORDER_FILE_DELETED
            - ORDER_FORWARDED_FOR_POSTPROCESSING
            - ORDER_NOT_CANCELLED
            - ORDER_REJECTED
            - ORIGINAL_FILE_NOT_SENT
            - PARTY_ID_INVALID
            - PAYER_NOT_REACHABLE
            - PAYMENT_DUPLICATE
            - PAYMENT_ID_DUPLICATE
            - PAYMENT_INSTR_TYPE_UNSUPPORTED
            - PAYMENT_NOT_ALLOWED
            - PAYMENT_NOT_RECEIVED
            - PAYMENT_NO_GUARANTEE
            - PAYMENT_TRANSFERRED_AND_TRACKED
            - PAYMENT_TRANSFERRED_NOT_TRACKED
            - PAYMENT_TYPE_INFO_INVALID
            - PAYMENT_UNDUE
            - PROCESSING_OK
            - PUBLIC_KEY_VERSION_INCORRECT
            - PURPOSE_INVALID
            - RECEIVER_CUSTOMER_INFORMATION
            - RECEIVER_TOKEN_NOT_FOUND
            - REFUND_REQUEST_BY_CUSTOMER
            - REGULATORY_INFORMATION_INVALID
            - REGULATORY_REASON
            - REJECTED_BY_ASPSP
            - REMEDIATION_NOT_POSSIBLE
            - REMITTANCE_INFORMATION_INVALID
            - REMITTANCE_INFORMATION_TRUNCATED
            - REPEAT_ORDER
            - REQUESTED_BY_CUSTOMER
            - REQUESTED_EXECUTION_DATE_TOO_FAR_IN_FUTUER
            - REQUESTED_EXECUTION_DATE_TOO_FAR_IN_PAST
            - RETURN_PAYMENT_FORBIDDEN
            - RTP_ALREADY_ACCEPTED
            - RTP_ALREADY_EXPIRED
            - RTP_ALREADY_REFUSED
            - RTP_ALREADY_REJECTED
            - RTP_DEBTOR_NOT_SUPPORTED
            - RTP_NEVER_RECEIVER
            - RTP_NOT_AGREED
            - RTP_RECEIVED
            - RTP_SP_IDENTIFIER_INCORRECT
            - R_MESSAGE_CONFLICT
            - SAME_DEBTOR_AND_CREDITOR_ACCOUNT
            - SENDER_TOKEN_NOT_FOUND
            - SERVICE_LEVEL_CODE_INVALID
            - SERVICE_UNAVAILABLE
            - SETTLEMENT_FAILED
            - SETTLEMENT_NOT_RECEIVED
            - SETTLEMENT_SYSTEM_NOT_AVAILABLE
            - SIGNATURE_ALREADY_SENT
            - SIGNATURE_INSUFFICIENT_RIGHTS
            - SIGNATURE_ORDER_DATA_MISMATCH
            - SIGNER_1_CA_INVALID
            - SIGNER_1_CERTIFICATE_INCORRECT
            - SIGNER_1_CERTIFICATE_INVALID
            - SIGNER_1_CERTIFICATE_REVOKED
            - SIGNER_2_CA_INVALID
            - SIGNER_2_CERTIFICATE_INCORRECT
            - SIGNER_2_CERTIFICATE_INVALID
            - SIGNER_2_CERTIFICATE_REVOKED
            - SIGNER_CA_INVALID
            - SIGNER_CERTIFICATE_INCORRECT
            - SIGNER_CERTIFICATE_INVALID
            - SIGNER_CERTIFICATE_REVOKED
            - STRUCTURED_CREDITOR_REFERENCE_INVALID
            - SUM_GROUP_CONTROL_INVALID
            - SUM_PAYMENT_CONTROL_INVALID
            - SYNTAX_ERROR
            - TAX_INFORMATION_INVALID
            - TECHNICAL_ERROR
            - TOKEN_COUNTERPARTY_MISMATCH
            - TOKEN_EXPIRED
            - TOKEN_INVALID
            - TOKEN_MISSING
            - TOKEN_SINGLE_USE
            - TOKEN_SUSPENDED
            - TOKEN_VALUE_LIMIT_EXCEEDED
            - TRANSACTIONS_NUMBER_GROUP_INVALID
            - TRANSACTIONS_NUMBER_INVALID
            - TRANSACTIONS_NUMBER_PAYMENT_INVALID
            - TRANSACTION_CANNOT_BE_RETURNED
            - TRANSACTION_CURRENCY_INVALID
            - TRANSACTION_DUPLICATE
            - TRANSACTION_FORBIDDEN
            - TRANSACTION_NOT_SUPPORTED
            - TRANSACTION_NUMBER_NOT_ALLOWED
            - TRANSACTION_REFERENCE_NOT_UNIQUE
            - TRANSFER_ORDER
            - TRANSFER_TO_SIGN_BY_HAND
            - TRANSMISSION_ABORTED
            - TRANSMISSION_SUCCESSFUL
            - UETR_NETWORK_STOP
            - UNKNOWN_DATA_SIGN_FORMAT
            - USER_DOES_NOT_EXIST
            - USER_NOT_YET_ACTIVATED
            - USER_SIGNED_MULTIPLE_TIMES
            - VALUES_SET_TO_NEXT_DAY
            - WAITING_TIME_EXPIRED
            - ZERO_AMOUNT_NOT_APPLIED
        type:
          type: string
          description: Type of payment
          enum:
          - credit
          - debit
          example: debit
      required:
      - amount
      - availableOperations
      - id
      - status
      - statusReason
      - type
    PaymentV2:
      type: object
      description: The retrieved list of payments
      properties:
        availableOperations:
          type: array
          description: Set of available operations for the current payment
          items:
            type: string
            description: Set of available operations for the current payment
            enum:
            - RETRIEVE_DETAILS
            - CANCEL
          uniqueItems: true
        children:
          type: array
          description: The child payments
          items:
            $ref: '#/components/schemas/PaymentV2'
        counterParty:
          $ref: '#/components/schemas/PaymentCounterPartyV1'
        counterPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        createdAt:
          type: string
          format: date
          description: The creation date
          example: 2024-10-10
        endToEndId:
          type: string
          description: The payment end to end id
        feeAmount:
          $ref: '#/components/schemas/AmountDto'
        id:
          type: string
          format: uuid
          description: The payment id
          example: 95717d5f-43d8-4b01-9d53-330af1a39f17
        originatingAccount:
          $ref: '#/components/schemas/AccountIdentifier'
        originatingPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        reference:
          $ref: '#/components/schemas/PaymentReference'
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
        status:
          type: string
          description: The payment status
          enum:
          - RECEIVED
          - OPEN
          - IN_TRANSIT
          - SUCCESSFUL
          - FAILED
          - CANCELED
          - UNKNOWN
          - PLANNED
          example: SUCCESSFUL
        statusReason:
          type: array
          description: The list of description codes for the status reasons
          items:
            type: string
            description: The list of description codes for the status reasons
            enum:
            - ABORTED_CLEARING_ERROR
            - ABORTED_CLEARING_TIMEOUT
            - ABORTED_SETTLEMENT_ERROR
            - ABORTED_SETTLEMENT_TIMEOUT
            - ACCESS_RIGHTS_INVALID
            - ACCOUNT_BLOCKED
            - ACCOUNT_CURRENCY_INVALID
            - ACCOUNT_DETAILS_CHANGED
            - ACCOUNT_NOT_ALLOWED
            - ACCOUNT_NUMBER_CLOSED
            - ACCOUNT_NUMBER_INVALID
            - ACCOUNT_PROXY_INVALID
            - ACCOUNT_TYPE_INVALID
            - AGENT_COUNTRY_INVALID
            - AGENT_INCORRECT
            - AGENT_OFFLINE
            - AGENT_REASON_NOT_SPECIFIED
            - AGENT_SUSPENDED
            - AMOUNT_BELOW_CLEARING_SYSTEM_MIN
            - AMOUNT_BLOCKED
            - AMOUNT_EXCEEDS_AGREED_LIMIT
            - AMOUNT_EXCEEDS_CLEARING_SYSTEM_LIMIT
            - AMOUNT_EXCEEDS_SETTLEMENT_LIMIT
            - AMOUNT_INVALID
            - AMOUNT_NOT_ALLOWED
            - AMOUNT_TOO_LOW
            - AMOUNT_WRONG
            - AMOUNT_ZERO
            - ATTACHMENT_NOT_SUPPORTED
            - AUTH_CANCELLED
            - BALANCE_INFO_REQUEST
            - BANK_CORRESPONDENT_NOT_POSSIBLE
            - BANK_IDENTIFIER_INCORRECT
            - BANK_IDENTIFIER_INVALID
            - BANK_OPERATION_CODE_INVALID
            - BANK_PROCESSING_ERROR
            - BIC_INVALID
            - BOOK_TRANSFER_NOT_ALLOWED
            - BRANCH_CODE_INVALID
            - CANCELLATION_DELIVERY_ACKNOWLEDGED
            - CANCELLATION_ACKNOWLEDGED
            - CANCELLATION_REQUEST_FORWARDED
            - CANCELLATION_REQUEST_NOT_FOUND
            - CANCELLATION_REQUEST_PENDING
            - CARD_NUMBER_INVALID
            - CATEGORY_PURPOSE_CODE_INVALID
            - CHARACTER_SET_INVALID
            - CHARGE_BEARER_CODE_INVALID
            - CHECK_ERI
            - CHEQUE_NUMBER_INVALID
            - CHEQUE_SETTLED_ON_CREDITOR_ACCOUNT
            - CLEARING_REQUEST_ABORTED
            - CLEARING_SYSTEM_IDENTIFIER_INVALID
            - CLEARING_SYSTEM_SERVICE
            - COLLECTION_NOT_DUE
            - CONTACT_DETAILS_INVALID
            - CONTROL_SUM_INVALID
            - CORE_AND_B2B_CONFLICT
            - COUNTRY_INVALID
            - COUNTRY_OF_RESIDENCE_INVALID
            - CREATION_DATE_INVALID
            - CREDITOR_ACCOUNT_INVALID_CURRENCY
            - CREDITOR_ACCOUNT_NUMBER_CLOSED
            - CREDITOR_ACCOUNT_NUMBER_INVALID
            - CREDITOR_ACCOUNT_TYPE_INVALID
            - CREDITOR_ADDRESS_MISSING
            - CREDITOR_AGENT_COUNTRY_INVALID
            - CREDITOR_AGENT_ERROR
            - CREDITOR_AGENT_OFFLINE
            - CREDITOR_AGENT_SPECIFIC_SERVICE
            - CREDITOR_AGENT_SUSPENDED
            - CREDITOR_AGENT_TIMEOUT
            - CREDITOR_BANK_IDENTIFIER_INVALID
            - CREDITOR_BANK_NOT_REGISTERED
            - CREDITOR_BIC_INVALID
            - CREDITOR_BLACKLISTED_BY_DEBTOR
            - CREDITOR_CLEARING_SYSTEM_IDENTIFIER_INVALID
            - CREDITOR_COUNTRY_INVALID
            - CREDITOR_COUNTRY_OF_RESIDENCE_INVALID
            - CREDITOR_IDENTIFICATION_CODE_INVALID
            - CREDITOR_IDENTIFIER_AMBIGUOUS
            - CREDITOR_IDENTIFIER_INCORRECT
            - CREDITOR_NAME_ADDRESS_MISSING
            - CREDITOR_NAME_FORMAT_ERROR
            - CREDITOR_NAME_MISSING
            - CREDITOR_NOT_WHITELISTED_BY_DEBTOR
            - CREDITOR_SCHEME_ID_INVALID
            - CREDITOR_UNKNOWN
            - CREDIT_DEBIT_NOT_CONFIRMED
            - CREDIT_PENDING_DOCUMENTS
            - CREDIT_PENDING_FUNDS
            - CURRENCY_INCOMPATIBLE_DECIMAL_POINT
            - CURRENCY_INCORRECT
            - CURRENCY_NOT_ALLOWED
            - CUSTOMER_DECEASED
            - CUSTOMER_NO_ANSWER
            - CUSTOMER_REASON_NOT_SPECIFIED
            - CUSTOMER_UNKNOWN
            - CUTOFF_DATE_INVALID
            - CUTOFF_TIME_INVALID
            - DAILY_LIMIT_EXCEEDED
            - DATA_SIGN_REQUESTED
            - DATE_INVALID
            - DATE_INVALID_NON_PROCESSING
            - DEBTOR_ACCOUNT_IDENTIFIER_MISSING
            - DEBTOR_ACCOUNT_INVALID_CURRENCY
            - DEBTOR_ACCOUNT_NOT_TO_BE_USED
            - DEBTOR_ACCOUNT_NUMBER_CLOSED
            - DEBTOR_ACCOUNT_NUMBER_INVALID
            - DEBTOR_ACCOUNT_TYPE_INVALID
            - DEBTOR_ADDRESS_MISSING
            - DEBTOR_AGENT_COUNTRY_INVALID
            - DEBTOR_AGENT_NOT_TO_BE_USED
            - DEBTOR_AGENT_SERVICE_ID_INVALID
            - DEBTOR_AGENT_SPECIFIC_SERVICE
            - DEBTOR_AGENT_TIMEOUT
            - DEBTOR_BANK_IDENTIFIER_INVALID
            - DEBTOR_BANK_NOT_REGISTERED
            - DEBTOR_BIC_INVALID
            - DEBTOR_CLEARING_SYSTEM_IDENTIFIER_INVALID
            - DEBTOR_COUNTRY_INVALID
            - DEBTOR_COUNTRY_OF_RESIDENCE_INVALID
            - DEBTOR_IDENTIFICATION_CODE_INVALID
            - DEBTOR_NAME_ADDRESS_MISSING
            - DEBTOR_NAME_FORMAT_ERROR
            - DEBTOR_NAME_MISSING
            - DECOMPRESSION_ERROR
            - DECRYPTION_ERROR
            - DELIVERED_WITHOUT_SERVICE_LEVEL
            - DELIVERED_WITH_SERVICE_LEVEL
            - DIRECT_DEBIT_AMOUNT_LIMIT_EXCEEDED
            - DIRECT_DEBIT_COUNT_LIMIT_EXCEEDED
            - DIRECT_DEBIT_UNSUCCESSFUL
            - DUPLICATION
            - ELECTRONIC_SIGNATURE_CORRECT
            - ELEMENT_CONTENT_INCORRECT
            - ELEMENT_CONTENT_TOO_LONG
            - ELEMENT_NOT_ALLOWED
            - ELEMENT_NOT_USED_AT_B
            - END_TO_END_ID_DUPLICATE
            - END_TO_END_ID_INVALID
            - ERI_MISSING
            - ERI_NOT_SUPPORTED
            - EXECUTION_DATE_CHANGED
            - EXPIRATION_DATETIME_INVALID
            - EXPIRATION_DATETIME_REACHED
            - EXPIRATION_DATETIME_TOO_FAR
            - FILE_FORMAT_INVALID
            - FILE_NON_READABLE
            - FILE_STRUCTURE_INCORRECT
            - FLAGGED_FOR_CANCELLATION
            - FRAUD
            - FRAUDULENT_ORIGIN
            - FUTURE_DATE_NOT_SUPPORTED
            - IDENTIFICATION_CODE_INVALID
            - INCONSISTENT_WITH_END_CUSTOMER
            - INITIATING_PARTY_UNRECOGNISED
            - INSTRUCTED_AGENT
            - INSTRUCTED_AGENT_TIMEOUT
            - INSTRUCTION_ID_DUPLICATE
            - INSUFFICIENT_FUNDS
            - INTERMEDIARY_AGENT_INVALID
            - LIMIT_EXCEEDED
            - LOCAL_INSTRUMENT_CODE_INVALID
            - MANDATE_CHANGES_NOT_ALLOWED
            - MANDATE_INFORMATION_MISSING
            - MANDATE_MISSING_INFORMATION
            - MANDATORY_ELEMENT_MISSING
            - MESSAGE_ID_DUPLICATE
            - MISSING_NAME
            - MONTHLY_LIMIT_EXCEEDED
            - NAME_LENGTH_INVALID
            - NARRATIVE
            - NOT_COMPLIANT
            - NO_DATA_AVAILABLE
            - NO_MANDATE
            - ORDER_CANCELLED
            - ORDER_FILE_DELETED
            - ORDER_FORWARDED_FOR_POSTPROCESSING
            - ORDER_NOT_CANCELLED
            - ORDER_REJECTED
            - ORIGINAL_FILE_NOT_SENT
            - PARTY_ID_INVALID
            - PAYER_NOT_REACHABLE
            - PAYMENT_DUPLICATE
            - PAYMENT_ID_DUPLICATE
            - PAYMENT_INSTR_TYPE_UNSUPPORTED
            - PAYMENT_NOT_ALLOWED
            - PAYMENT_NOT_RECEIVED
            - PAYMENT_NO_GUARANTEE
            - PAYMENT_TRANSFERRED_AND_TRACKED
            - PAYMENT_TRANSFERRED_NOT_TRACKED
            - PAYMENT_TYPE_INFO_INVALID
            - PAYMENT_UNDUE
            - PROCESSING_OK
            - PUBLIC_KEY_VERSION_INCORRECT
            - PURPOSE_INVALID
            - RECEIVER_CUSTOMER_INFORMATION
            - RECEIVER_TOKEN_NOT_FOUND
            - REFUND_REQUEST_BY_CUSTOMER
            - REGULATORY_INFORMATION_INVALID
            - REGULATORY_REASON
            - REJECTED_BY_ASPSP
            - REMEDIATION_NOT_POSSIBLE
            - REMITTANCE_INFORMATION_INVALID
            - REMITTANCE_INFORMATION_TRUNCATED
            - REPEAT_ORDER
            - REQUESTED_BY_CUSTOMER
            - REQUESTED_EXECUTION_DATE_TOO_FAR_IN_FUTUER
            - REQUESTED_EXECUTION_DATE_TOO_FAR_IN_PAST
            - RETURN_PAYMENT_FORBIDDEN
            - RTP_ALREADY_ACCEPTED
            - RTP_ALREADY_EXPIRED
            - RTP_ALREADY_REFUSED
            - RTP_ALREADY_REJECTED
            - RTP_DEBTOR_NOT_SUPPORTED
            - RTP_NEVER_RECEIVER
            - RTP_NOT_AGREED
            - RTP_RECEIVED
            - RTP_SP_IDENTIFIER_INCORRECT
            - R_MESSAGE_CONFLICT
            - SAME_DEBTOR_AND_CREDITOR_ACCOUNT
            - SENDER_TOKEN_NOT_FOUND
            - SERVICE_LEVEL_CODE_INVALID
            - SERVICE_UNAVAILABLE
            - SETTLEMENT_FAILED
            - SETTLEMENT_NOT_RECEIVED
            - SETTLEMENT_SYSTEM_NOT_AVAILABLE
            - SIGNATURE_ALREADY_SENT
            - SIGNATURE_INSUFFICIENT_RIGHTS
            - SIGNATURE_ORDER_DATA_MISMATCH
            - SIGNER_1_CA_INVALID
            - SIGNER_1_CERTIFICATE_INCORRECT
            - SIGNER_1_CERTIFICATE_INVALID
            - SIGNER_1_CERTIFICATE_REVOKED
            - SIGNER_2_CA_INVALID
            - SIGNER_2_CERTIFICATE_INCORRECT
            - SIGNER_2_CERTIFICATE_INVALID
            - SIGNER_2_CERTIFICATE_REVOKED
            - SIGNER_CA_INVALID
            - SIGNER_CERTIFICATE_INCORRECT
            - SIGNER_CERTIFICATE_INVALID
            - SIGNER_CERTIFICATE_REVOKED
            - STRUCTURED_CREDITOR_REFERENCE_INVALID
            - SUM_GROUP_CONTROL_INVALID
            - SUM_PAYMENT_CONTROL_INVALID
            - SYNTAX_ERROR
            - TAX_INFORMATION_INVALID
            - TECHNICAL_ERROR
            - TOKEN_COUNTERPARTY_MISMATCH
            - TOKEN_EXPIRED
            - TOKEN_INVALID
            - TOKEN_MISSING
            - TOKEN_SINGLE_USE
            - TOKEN_SUSPENDED
            - TOKEN_VALUE_LIMIT_EXCEEDED
            - TRANSACTIONS_NUMBER_GROUP_INVALID
            - TRANSACTIONS_NUMBER_INVALID
            - TRANSACTIONS_NUMBER_PAYMENT_INVALID
            - TRANSACTION_CANNOT_BE_RETURNED
            - TRANSACTION_CURRENCY_INVALID
            - TRANSACTION_DUPLICATE
            - TRANSACTION_FORBIDDEN
            - TRANSACTION_NOT_SUPPORTED
            - TRANSACTION_NUMBER_NOT_ALLOWED
            - TRANSACTION_REFERENCE_NOT_UNIQUE
            - TRANSFER_ORDER
            - TRANSFER_TO_SIGN_BY_HAND
            - TRANSMISSION_ABORTED
            - TRANSMISSION_SUCCESSFUL
            - UETR_NETWORK_STOP
            - UNKNOWN_DATA_SIGN_FORMAT
            - USER_DOES_NOT_EXIST
            - USER_NOT_YET_ACTIVATED
            - USER_SIGNED_MULTIPLE_TIMES
            - VALUES_SET_TO_NEXT_DAY
            - WAITING_TIME_EXPIRED
            - ZERO_AMOUNT_NOT_APPLIED
        type:
          type: string
          description: Type of payment
          enum:
          - credit
          - debit
          example: debit
      required:
      - availableOperations
      - counterPartyAmount
      - id
      - originatingPartyAmount
      - status
      - statusReason
      - type
    RedirectRequest:
      type: object
      properties:
        redirectUrl:
          type: string
          description: Url where the client should be redirected after the operation
            has completed
          example: https://app.client.com/operation/742984792/complete
          minLength: 1
      required:
      - redirectUrl
    RedirectUrlResponse:
      type: object
      properties:
        redirectUrl:
          type: string
          description: URL to access the 'Establish a new consent' page
          example: https://pxg.com/consents/1adffad1-4838-4b3b-87f5-80048a4d556a/init
          minLength: 1
      required:
      - redirectUrl
    SepaStructuredAddress:
      type: object
      description: 'EPC Interbank Structured Address Structure. Structured addresses
        are address information split into several fields instead of one unstructured
        address field.

        From November 2023, all banks and PSPs will have to accept payment messages
        with structured addresses.

        From 2025, banks and PSPs will have to send all their messages with structured
        addresses.

        '
      externalDocs:
        description: More about EPC Interbank Structured Address Structure
        url: https://www.europeanpaymentscouncil.eu/sites/default/files/kb/file/2022-10/EPC153-22%20EPC%20guidance%20document%20-%20Use%20of%20Structured%20Address%20under%20the%20SEPA%20Payment%20Schemes%20as%20of%20Nov%202025.pdf
      properties:
        buildingName:
          type: string
          description: Name of the building or house.
          example: Empire State Building
          maxLength: 35
          minLength: 0
        buildingNumber:
          type: string
          description: A unique number assigned to the building in the street or area
          example: A22
        city:
          type: string
          description: Name of the city
          example: La Hulpe
          minLength: 1
        cityLocationName:
          type: string
          description: Specific location name within the town.
          example: City center
          maxLength: 35
          minLength: 0
        country:
          type: string
          description: Name of the country
          example: Belgium
        countryCode:
          type: string
          description: Two-letter country code defined in ISO 3166
          example: BE
        department:
          type: string
          description: Identification of a division of a large organisation or building.
          example: Finance
          maxLength: 70
          minLength: 0
        district:
          type: string
          description: Identifies a subdivision within a country sub-division
          example: Walloon Brabant
        floor:
          type: string
          description: A unique number or name assigned to the floor within the building
          example: ground
          maxLength: 70
          minLength: 0
        house:
          type: string
        level:
          type: string
        postBox:
          type: string
          description: Numbered box in a post office, assigned to a person or organisation,
            where letters are kept until called for.
          example: '1033'
          maxLength: 16
          minLength: 0
        postalCode:
          type: string
          description: Series of letters or digits or both, included in a postal address
          example: 12345-1A
        postalCodeExtension:
          type: string
        province:
          type: string
        room:
          type: string
          description: Building room number.
          example: '2.22'
          maxLength: 70
          minLength: 0
        state:
          type: string
          description: Name of the state
          example: California
        streetName:
          type: string
          description: Name of the street
          example: Avenue Reine Astrid
        subDepartment:
          type: string
          description: Identification of a sub-division of a large organisation or
            building.
          example: Accounting
          maxLength: 70
          minLength: 0
        subDistrict:
          type: string
          description: Identifies a subdivision of a country such as state, region,
            county.
          example: Wallonia
          maxLength: 35
          minLength: 0
      required:
      - city
    TransferCreditor:
      type: object
      description: The creditor information
      properties:
        accountId:
          type: string
          format: uuid
          description: Identifier of the connection account in which the money will
            be transferred
        connectionId:
          type: string
          format: uuid
          description: Identifier of the connection to which the transfer is intended
        verificationId:
          type: string
          description: The verification of payee id
      required:
      - accountId
      - connectionId
    TransferInitiationEvaluationRequest:
      type: object
      properties:
        acceptedFeeId:
          type: string
          format: uuid
          description: Identifier of the PSU accepted fees for the upcoming payment
        debtorAccountId:
          type: string
          format: uuid
          description: The ID of the payment account to be used as debtor
        payment:
          $ref: '#/components/schemas/TransferInitiationTransaction'
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
      required:
      - debtorAccountId
      - payment
    TransferInitiationRequest:
      type: object
      properties:
        acceptedFeeId:
          type: string
          format: uuid
          description: Identifier of the PSU accepted fees for the upcoming payment
        changeNotificationUrl:
          type: string
          description: A URL that will be called whenever change-events happen
          example: https://app.btx.banqup.com/transfers/transfer-change-notification
        debtorAccountId:
          type: string
          format: uuid
          description: The ID of the payment account to be used as debtor
        locale:
          type: string
          description: The locale to use on web pages presented to the user
          example: nl, NL, NL-NL, nl-NL, nl-BE, NL-BE
        payment:
          $ref: '#/components/schemas/TransferInitiationTransaction'
        redirectUrl:
          type: string
          description: URL to redirect the PSU to once the payment flow is completed
          example: https://app.btx.banqup.com/payments/payment-feedback
          minLength: 1
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
      required:
      - debtorAccountId
      - locale
      - payment
      - redirectUrl
    TransferInitiationTransaction:
      type: object
      description: The details of the payment transaction to be initiated
      properties:
        counterPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        creditor:
          $ref: '#/components/schemas/TransferCreditor'
        endToEndIdentification:
          type: string
          description: Unique end to end identifier that will be stored in Data Store
            and sent to the PSP. Can be used for later reconciliation
          example: BTX71bdfe0f3e084871bf03d008d489c569
          maxLength: 35
          minLength: 0
        originatingPartyAmount:
          $ref: '#/components/schemas/AmountDto'
        reference:
          $ref: '#/components/schemas/PaymentReference'
      required:
      - counterPartyAmount
      - creditor
    TransferInitiationV1Request:
      type: object
      properties:
        changeNotificationUrl:
          type: string
          description: A URL that will be called whenever change-events happen
          example: https://app.btx.banqup.com/transfers/transfer-change-notification
        debtorAccountId:
          type: string
          format: uuid
          description: The ID of the payment account to be used as debtor
        language:
          type: string
          deprecated: true
          description: This field is deprecated, please use locale instead.
        locale:
          type: string
          description: The locale to use on web pages presented to the user
          example: nl, NL, NL-NL, nl-NL, nl-BE, NL-BE
        payment:
          $ref: '#/components/schemas/TransferInitiationV1Transaction'
        redirectUrl:
          type: string
          description: URL to redirect the PSU to once the payment flow is completed
          example: https://app.btx.banqup.com/payments/payment-feedback
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
      required:
      - debtorAccountId
      - locale
      - payment
    TransferInitiationV1Transaction:
      type: object
      description: The details of the payment transaction to be initiated
      properties:
        amount:
          $ref: '#/components/schemas/AmountDto'
        creditor:
          $ref: '#/components/schemas/TransferCreditor'
        endToEndIdentification:
          type: string
          description: Unique end to end identifier that will be stored in Data Store
            and sent to the PSP. Can be used for later reconciliation
          example: BTX71bdfe0f3e084871bf03d008d489c569
          maxLength: 35
          minLength: 0
        reference:
          $ref: '#/components/schemas/PaymentReference'
      required:
      - amount
      - creditor
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.uat.btx.fr.banqup.com/oauth2/client_credential/gettoken
          scopes:
            info: Scopes are endpoint-specific, see each endpoint for required scope.
        authorizationCode:
          authorizationUrl: https://api.uat.btx.fr.banqup.com/oauth2/auth
          tokenUrl: https://api.uat.btx.fr.banqup.com/oauth2/token
          scopes:
            info: Scopes are endpoint-specific, see each endpoint for required scope.
tags:
- description: Payment operations endpoints
  name: Payments V1
- description: Payment operations endpoints
  name: Payments V2
- description: Payment Collect Consents endpoints
  name: Payment Collect Consents
- description: Callbacks defined for supporting PIS flows
  name: Payment Notifications (Internal)
- description: Payment internal operations endpoints
  name: Internal Payments
- description: Payment operations endpoints
  name: Payments
