openapi: 3.0.1
info:
  title: payments_integration API
  description: Merged OpenAPI spec for payments_integration domain
  version: 1.0.0
servers:
- description: ''
  url: https://api.uat.btx.fr.banqup.com/payments/integration
- description: ''
  url: https://api.uat.btx.eu.banqup.com/payments/integration
paths:
  /v1/spaces/{spaceId}/payments:
    post:
      description: 'Initiate a SEPA payment request <br/> Scope: space_read, space_write,
        account_read, 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_read
        - account_write
      summary: Initiate a payment request
      tags:
      - Payments
  /v1/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_read, 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_read
        - account_write
      summary: Initiate a transfer request
      tags:
      - Payments
  /v1/spaces/{spaceId}/payments/{paymentId}:
    get:
      description: 'Retrieves the details about a payment from Data Store <br/> Scope:
        space_read, space_write, account_read, account_write'
      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
        - space_write
        - account_read
        - account_write
      summary: Get the payment details
      tags:
      - Payments
components:
  schemas:
    AccountIdentifier:
      type: object
      description: The account information of the creditor
      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
        scheme:
          type: string
          description: Account Scheme
          enum:
          - IBAN
          - BBAN
          - ANB
          - SE_BANKGIRO
          - SE_PLUSGIRO
          example: IBAN
      required:
      - currency
      - identifier
      - scheme
    AmountDto:
      type: object
      properties:
        currency:
          type: string
          description: International code of the currency used
          example: EUR
          pattern: '[A-Z]{3}'
        value:
          type: string
          description: Amount value
          example: '10.05'
          maximum: 99999999999999.98
          minimum: -99999999999999.98
      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
        scheme:
          type: string
          description: Bank Identifier Scheme
          enum:
          - BIC
          - CODE
          example: BIC
      required:
      - identifier
      - scheme
    Creditor:
      type: object
      description: The creditor information
      properties:
        account:
          $ref: '#/components/schemas/AccountIdentifier'
        name:
          type: string
          description: The name of the creditor
          example: Company XYZ
          maxLength: 70
          minLength: 0
      required:
      - account
      - name
    NestedProblem:
      type: object
      properties:
        detail:
          type: string
        error:
          type: string
        title:
          type: string
        type:
          type: string
          format: uri
      required:
      - detail
      - error
      - title
    Payment:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/AmountDto'
        children:
          type: array
          description: The child payments
          items:
            $ref: '#/components/schemas/Payment'
        id:
          type: string
          format: uuid
          description: The payment id
          example: 95717d5f-43d8-4b01-9d53-330af1a39f17
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
        status:
          type: string
          description: The payment status
          enum:
          - RECEIVED
          - OPEN
          - 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
      required:
      - amount
      - id
      - status
      - statusReason
    PaymentInitiationRequest:
      type: object
      properties:
        bulk:
          type: boolean
          description: Specify whether the payments should be processed individually
            or together
        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
        payments:
          type: array
          description: The list of payment transactions
          items:
            $ref: '#/components/schemas/PaymentInitiationTransaction'
        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
    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:
      - paymentId
      - redirectUrl
    PaymentInitiationTransaction:
      type: object
      description: The list of payment transactions
      properties:
        amount:
          $ref: '#/components/schemas/AmountDto'
        creditor:
          $ref: '#/components/schemas/Creditor'
        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
    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
      required:
      - type
      - value
    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
      required:
      - accountId
      - connectionId
    TransferInitiationRequest:
      type: object
      properties:
        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
        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
        requestedExecutionDate:
          type: string
          format: date
          description: The requested execution date
          example: 2024-10-10
      required:
      - debtorAccountId
      - payment
    TransferInitiationTransaction:
      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: Callbacks defined for supporting PIS flows
  name: Payment Notifications (Internal)
- description: Payment operations endpoints
  name: Payments
