swagger: "2.0"
basePath: /openbanking/sandbox/connect/api
info:
  contact:
    email: apisupport@mastercard.com
    name: Open Banking Connect Support
    url: https://developer.mastercard.com/product/open-banking-connect-api-product
  description: Open Banking - Payments initiation service
  title: Open Banking - Payments initiation service
  version: 1.16.0
  x-artifactId: mcob-inbound-service
  x-origin:
    - format: swagger
      url: https://developer.mastercard.com/devzone/api/portal/swagger/open-banking-connect-payment-initiation-service
      version: "2.0"
  x-providerName: mastercard.com
  x-serviceName: open-banking-connect-pis
tags:
  - description: List of account information and payment initiation providers
    name: ASPSPs
  - description: Domestic Payments operations
    name: Domestic Payments Consent
  - description: Domestic Payments operations
    name: Domestic Payments
  - description: Domestic Payments operations
    name: Domestic Payments Status
  - description: SEPA Payments operations
    name: SEPA Payments Consent
  - description: SEPA Payments operations
    name: SEPA Payments
  - description: SEPA Payments operations
    name: SEPA Payments Status
  - description: Cross border Payments Consent operation
    name: Cross border Payments Consent
  - description: Cross border Payments Redeem operation
    name: Cross border Payments
  - description: Cross border Payments get status operation
    name: Cross border Payments Status
  - description: PI Consent Original consent given by the bank.
    name: PI Consents Raw
  - description: Open banking connect health status
    name: Health
paths:
  /payments/aspsps:
    post:
      consumes:
        - application/json
      description: Get the list of all active ASPSPs supported by the Open Banking Connect platform at this time with possibility to filter by id, name or country. This list is updated regularly as new ASPSPs are connected.
      parameters:
        - description: Request Body
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postAspspsParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postAspspsOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Get list of ASPSPs
      tags:
        - ASPSPs
  /payments/consents/raw:
    post:
      consumes:
        - application/json
      description: Extracts the original raw consent given by the aspsp
      parameters:
        - description: Request Body
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsConsentsRawParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsConsentsRawOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Extracts the original raw consent given by the aspsp
      tags:
        - PI Consents Raw
  /payments/cross-border-credit-transfers:
    post:
      consumes:
        - application/json
      parameters:
        - description: Request Body
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Redeem the payment
      tags:
        - Cross border Payments
  /payments/cross-border-credit-transfers/consents:
    post:
      consumes:
        - application/json
      parameters:
        - description: Cross border payment consent
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Request consent initiation via redirect
      tags:
        - Cross border Payments Consent
  /payments/cross-border-credit-transfers/payment-status:
    post:
      consumes:
        - application/json
      parameters:
        - description: Request Body
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersPaymentStatusParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersPaymentStatusOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Get payment status
      tags:
        - Cross border Payments Status
  /payments/domestic-credit-transfers:
    post:
      consumes:
        - application/json
      description: Redeem the payment which was previously consented by the PSU.
      parameters:
        - description: Request Body
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsDomesticCreditTransfersParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsDomesticCreditTransfersOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Redeem the payment
      tags:
        - Domestic Payments
  /payments/domestic-credit-transfers/consents:
    post:
      consumes:
        - application/json
      description: Request Payment Initiation Consent for a domestic credit transfer on behalf of the PSU.
      parameters:
        - description: Domestic Payment consent to be wired via Faster Payment System
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Request consent initiation via redirect
      tags:
        - Domestic Payments Consent
  /payments/domestic-credit-transfers/payment-status:
    post:
      consumes:
        - application/json
      description: Get the status for an existing domestic credit transfer payment.
      parameters:
        - description: Request Body
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsDomesticCreditTransfersPaymentStatusParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsDomesticCreditTransfersPaymentStatusOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Get payment status
      tags:
        - Domestic Payments Status
  /payments/health:
    get:
      consumes:
        - application/json
      description: Returns the status of each connectivity provider
      parameters: []
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/ApiHealth"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
      summary: Returns the status of each connectivity provider
      tags:
        - Health
  /payments/sepa-credit-transfers:
    post:
      consumes:
        - application/json
      description: Redeem a SEPA credit transfer previously consented by the PSU.
      parameters:
        - description: Request Body
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsSepaCreditTransfersParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsSepaCreditTransfersOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Redeem the payment
      tags:
        - SEPA Payments
  /payments/sepa-credit-transfers/consents:
    post:
      consumes:
        - application/json
      description: Request a SEPA credit transfer consent on behalf of the PSU via a URL redirect to the ASPSP.
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Request consent initiation via redirect
      tags:
        - SEPA Payments Consent
  /payments/sepa-credit-transfers/payment-status:
    post:
      consumes:
        - application/json
      description: Get the status of an existing SEPA credit transfer
      parameters:
        - description: Request Body
          in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/postPaymentsSepaCreditTransfersPaymentStatusParamsBody"
      produces:
        - application/json
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/postPaymentsSepaCreditTransfersPaymentStatusOKBody"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Error
          schema:
            $ref: "#/definitions/Error"
        "504":
          description: Server while acting as a gateway or proxy, cannot get a response in time.
          schema:
            $ref: "#/definitions/Error"
      summary: Get payment status
      tags:
        - SEPA Payments Status
definitions:
  AdditionalDataField:
    description: Additional ASPSP field Types to be returned
    enum:
      - capabilities
      - logo
    type: string
  ApiHealth:
    description: API Healt response object
    properties:
      connectors:
        description: Connector availability
        items:
          $ref: "#/definitions/ApiHealth_connectors"
        type: array
      status:
        description: Overall connect platform availability status
        enum:
          - UP
          - DOWN
          - DEGRADED
        example: UP
        type: string
      statusMessage:
        description: Additional informational message
        example: ""
        type: string
    required:
      - status
    type: object
  ApiHealth_connectors:
    properties:
      name:
        description: Connector name
        example: Buffalo
        type: string
      status:
        description: Overall connect platform availability status
        enum:
          - UP
          - DOWN
          - DEGRADED
        example: UP
        type: string
      statusMessage:
        description: Additional informational message
        example: ""
        type: string
    required:
      - name
      - status
  CapabilitiesObject:
    additionalProperties:
      type: boolean
    description: Capabilities related to api profile assigned to ASPSP
    example:
      delete_ais_consent: true
      obtain_ais_consent: true
      retrieve_accounts: true
    type: object
  Error:
    properties:
      Errors:
        $ref: "#/definitions/Error_Errors"
    required:
      - Errors
    type: object
  Error_Errors:
    properties:
      Error:
        items:
          $ref: "#/definitions/Error_Errors_Error"
        type: array
    required:
      - Error
  Error_Errors_Error:
    properties:
      Description:
        type: string
      Details:
        type: string
      ReasonCode:
        type: string
      Recoverable:
        type: boolean
      Source:
        type: string
  LogoFileType:
    description: Type of the uploaded Logo file
    enum:
      - png
      - jpg
      - svg
    type: string
  LogoObject:
    description: Logo metadata and image content
    properties:
      binaryContent:
        description: This field is deprecated, use logoUrl instead
        type: string
      fileType:
        $ref: "#/definitions/LogoFileType"
      logoUrl:
        description: URL to a logo file
        example: https://openbanking.mastercard.eu/live/imgs/16f0f635-9d94-4976-b49b-584ca231c232.svg
        type: string
    type: object
  Merchant:
    description: Marchant Object
    properties:
      id:
        description: Merchant id
        example: MerchantId
        maxLength: 256
        minLength: 1
        type: string
      name:
        description: Merchant name
        example: MerchantName
        maxLength: 256
        minLength: 1
        type: string
    required:
      - id
      - name
    type: object
  PaymentConsent:
    description: Return the consent data exchanged for PSU authorization
    properties:
      consentId:
        description: Consent Id
        type: string
      consentRequestId:
        description: Consent Request Id, the same as received from /consent operations.
        type: string
      signatureStatus:
        $ref: "#/definitions/SignatureValidationStatus"
    required:
      - consentId
      - consentRequestId
    type: object
  RequestPisDomesticSchedule:
    properties:
      endDate:
        description: End date for the schedule
        example: ""
        format: date
        type: string
      frequency:
        description: Frequency type
        enum:
          - DAIL
          - WEEK
          - MNTH
          - QUTR
          - SEMI
          - YEAR
        type: string
      startDate:
        description: Start date for the schedule
        example: ""
        format: date
        type: string
    required:
      - frequency
      - startDate
    type: object
  RequestPisSepaSchedule:
    properties:
      endDate:
        description: End date for the schedule
        example: ""
        format: date
        type: string
      frequency:
        description: Frequency type
        enum:
          - DAIL
          - WEEK
          - MNTH
          - QUTR
          - SEMI
          - YEAR
        type: string
      startDate:
        description: Start date for the schedule
        example: ""
        format: date
        type: string
    required:
      - frequency
      - startDate
    type: object
  SepaPaymentConsent:
    description: Return the consent data exchanged for PSU authorization
    properties:
      consentId:
        description: Consent Id
        type: string
      consentRequestId:
        description: Consent Request Id, the same as received from /consent operations.
        type: string
    required:
      - consentId
      - consentRequestId
    type: object
  SignatureValidationStatus:
    description: "For CMA9 ASPSPs: Status of validation of ASPSP's signature present in authorization code that TPP included in the request for credit transfer"
    enum:
      - VALID
      - UNKNOWN
      - UNSIGNED
      - NONCOMPLIANT
    type: string
  postAspspsOKBody:
    properties:
      aspsps:
        items:
          $ref: "#/definitions/postAspspsOKBodyAspspsItems"
        type: array
      originalRequestInfo:
        $ref: "#/definitions/postAspspsOKBodyOriginalRequestInfo"
    required:
      - originalRequestInfo
    type: object
  postAspspsOKBodyAspspsItems:
    properties:
      aspspServices:
        description: Provided services, AIS - account information, PIS - payment initiation
        example:
          - AIS
          - PIS
          - COF
        items:
          enum:
            - AIS
            - PIS
            - COF
          type: string
        type: array
      capabilities:
        $ref: "#/definitions/CapabilitiesObject"
      country:
        description: Country code
        example: UK
        type: string
      id:
        description: Identification of the ASPSP
        example: 123e4567-e89b-12d3-a456-426655440000
        type: string
      logo:
        $ref: "#/definitions/LogoObject"
      name:
        description: Name of the ASPSP
        example: Wood bank
        type: string
      profile:
        description: ASPSP profile
        example: CMA9
        type: string
    type: object
  postAspspsOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postAspspsParamsBody:
    properties:
      country:
        description: Filter by country code (ISO 3166 Alpha 2), exact match pattern
        example: GB
        pattern: ^[A-Z]{2}$
        type: string
      id:
        description: Filter by internal id of ASPSP, exact match pattern
        example: ""
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      name:
        description: Filter by name of ASPSP, contains pattern
        example: ""
        maxLength: 256
        minLength: 1
        type: string
      requestInfo:
        $ref: "#/definitions/postAspspsParamsBodyRequestInfo"
      returnAdditionalData:
        description: Specifies what additional fields for ASPSP object should be included in response
        items:
          $ref: "#/definitions/AdditionalDataField"
        type: array
    required:
      - requestInfo
    type: object
  postAspspsParamsBodyRequestInfo:
    properties:
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsConsentsRawOKBody:
    properties:
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsConsentsRawOKBody_originalRequestInfo"
      rawConsent:
        description: Raw Consent
        type: string
    required:
      - originalRequestInfo
    type: object
  postPaymentsConsentsRawOKBody_originalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
  postPaymentsConsentsRawParamsBody:
    properties:
      requestInfo:
        $ref: "#/definitions/postPaymentsConsentsRawParamsBody_requestInfo"
    required:
      - requestInfo
    type: object
  postPaymentsConsentsRawParamsBody_requestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: 420e5cff-0e2a-4156-991a-f6eeef0478cf
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      consentId:
        description: Consent identification
        example: GFiTpF3:EBy5xGqQMatk
        maxLength: 256
        minLength: 1
        type: string
      merchant:
        $ref: "#/definitions/Merchant"
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - consentId
      - xRequestId
  postPaymentsCrossBorderCreditTransfersConsentsOKBody:
    properties:
      _links:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsOKBodyLinks"
      additionalData:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsOKBody_additionalData"
      aspspSCAApproach:
        enum:
          - REDIRECT
        type: string
      consentRequestId:
        type: string
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsOKBodyOriginalRequestInfo"
    required:
      - originalRequestInfo
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsOKBodyLinks:
    properties:
      scaRedirect:
        description: Redirect URL for SCA
        example: https://bank1.com/sca/login
        type: string
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsOKBody_additionalData:
    description: Returning additional data related to the consent
    properties:
      rawConsent:
        description: Raw Consent, available only for specific standards and returned only if requestInfo.flag contained 'Return.Raw.Consent'
        type: string
  postPaymentsCrossBorderCreditTransfersConsentsParamsBody:
    properties:
      payments:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPayments"
      requestInfo:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsParamsBodyRequestInfo"
    required:
      - payments
      - requestInfo
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPayments:
    properties:
      creditorAccount:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsCreditorAccount"
      creditorAddress:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsCreditorAddress"
      creditorAgent:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsCreditorAgent"
      creditorName:
        description: Bank name
        example: Wood bank
        maxLength: 256
        minLength: 1
        type: string
      debtorAccount:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsDebtorAccount"
      debtorAddress:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPayments_debtorAddress"
      debtorName:
        description: Debtor legal name
        example: NordPole PLC
        maxLength: 256
        minLength: 1
        type: string
      endToEndIdentification:
        description: Payment end to end identification
        example: Notification
        maxLength: 18
        minLength: 1
        type: string
      instructedAmount:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsInstructedAmount"
      instructionIdentification:
        description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. If API profile of ASPSP is CMA9, then field is mandatory.
        example: ""
        maxLength: 256
        minLength: 1
        type: string
      instructionPriority:
        description: Indicator of the urgency or order of importance
        enum:
          - Normal
          - Urgent
        example: Normal
        type: string
      localInstrument:
        description: User community specific instrument.
        enum:
          - Swift
        example: Swift
        type: string
      remittanceInformationReference:
        description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. (future use)
        example: UniqueRef1
        maxLength: 256
        minLength: 1
        type: string
      remittanceInformationUnstructured:
        description: Description of the payment
        example: Payment for fruits
        maxLength: 256
        minLength: 1
        type: string
      requestedExecutionDate:
        description: Scheduled Payment Date
        example: ""
        format: date
        type: string
      transferCharges:
        description: Charge bearer
        enum:
          - SEN
          - SHA
          - BEN
        type: string
    required:
      - creditorAccount
      - creditorAgent
      - creditorName
      - debtorAccount
      - endToEndIdentification
      - instructedAmount
      - instructionPriority
      - localInstrument
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsCreditorAccount:
    properties:
      identification:
        description: Account identification
        example: PL06884573292356737845125375
        maxLength: 256
        minLength: 1
        type: string
      schemeName:
        description: Scheme for the account identification
        enum:
          - IBAN
          - SortCodeAccountNumber
        example: IBAN
        type: string
    required:
      - identification
      - schemeName
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsCreditorAddress:
    properties:
      buildingNumber:
        example: "15"
        maxLength: 256
        minLength: 1
        type: string
      city:
        example: City
        maxLength: 256
        minLength: 1
        type: string
      country:
        description: ISO 3166 ALPHA2 country code
        example: AA
        pattern: ^[A-Z]{2}$
        type: string
      countrySubDivision:
        example: SubDivision
        maxLength: 256
        minLength: 1
        type: string
      postalCode:
        example: POSTCODE
        maxLength: 256
        minLength: 1
        type: string
      street:
        example: Street
        maxLength: 70
        minLength: 1
        type: string
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsCreditorAgent:
    properties:
      identification:
        description: Agent identification
        example: BARCGB22XXX
        maxLength: 256
        minLength: 1
        type: string
      schemeName:
        description: Scheme for the agent/bank identification
        enum:
          - BIC
        example: BIC
        type: string
    required:
      - identification
      - schemeName
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsDebtorAccount:
    properties:
      identification:
        description: Account identification
        example: PL06884573292356737845125375
        maxLength: 256
        minLength: 1
        type: string
      schemeName:
        description: Scheme for the account identification
        enum:
          - IBAN
          - SortCodeAccountNumber
        example: IBAN
        type: string
    required:
      - identification
      - schemeName
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPaymentsInstructedAmount:
    properties:
      amount:
        description: amount value
        example: 100.23
        exclusiveMinimum: true
        format: double
        minimum: 0
        type: number
      currency:
        description: Currency code
        example: GBP
        pattern: ^[A-Z]{3}$
        type: string
    required:
      - amount
      - currency
    type: object
  postPaymentsCrossBorderCreditTransfersConsentsParamsBodyPayments_debtorAddress:
    properties:
      buildingNumber:
        example: "15"
        maxLength: 256
        minLength: 1
        type: string
      city:
        example: City
        maxLength: 256
        minLength: 1
        type: string
      country:
        description: ISO 3166 ALPHA2 country code
        example: CC
        pattern: ^[A-Z]{2}$
        type: string
      countrySubDivision:
        example: Division
        maxLength: 256
        minLength: 1
        type: string
      postalCode:
        example: PostCode
        maxLength: 256
        minLength: 1
        type: string
      street:
        example: Street
        maxLength: 70
        minLength: 1
        type: string
  postPaymentsCrossBorderCreditTransfersConsentsParamsBodyRequestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: 420e5cff-0e2a-4156-991a-f6eeef0478cf
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      flags:
        description: Request information flags which can influence the behaviour or returned data
        items:
          enum:
            - Return.Raw.Consent
          type: string
        type: array
      merchant:
        $ref: "#/definitions/Merchant"
      tppRedirectURI:
        description: Call back uri
        example: https://tpp-ob.com/callback
        maxLength: 256
        minLength: 1
        type: string
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - tppRedirectURI
      - xRequestId
    type: object
  postPaymentsCrossBorderCreditTransfersOKBody:
    properties:
      consent:
        $ref: "#/definitions/PaymentConsent"
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersOKBodyOriginalRequestInfo"
      transfer:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersOKBodyTransfer"
    required:
      - consent
      - originalRequestInfo
    type: object
  postPaymentsCrossBorderCreditTransfersOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsCrossBorderCreditTransfersOKBodyTransfer:
    properties:
      paymentId:
        description: PI / Transfer identification
        example: trasnferIdentificaion1
        type: string
      statusReasonCode:
        description: Rejection reson code
        example: AM04
        type: string
      transactionStatus:
        description: Status of the payment
        enum:
          - ACCP
          - ACSC
          - ACSP
          - ACTC
          - ACWC
          - ACWP
          - PDNG
          - RCVD
          - RJCT
        type: string
    type: object
  postPaymentsCrossBorderCreditTransfersParamsBody:
    properties:
      requestInfo:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersParamsBodyRequestInfo"
    required:
      - requestInfo
    type: object
  postPaymentsCrossBorderCreditTransfersParamsBodyRequestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: 420e5cff-0e2a-4156-991a-f6eeef0478cf
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      authorization:
        description: The authorization query / data received after PSU has authorized the consent
        example: code=UKcrossVsbG8gQ2TP9kZWJleft53serYXV0aUK001&state=38948933-38ae-45af-953e-25a69fefa39e
        maxLength: 5000
        minLength: 1
        type: string
      merchant:
        $ref: "#/definitions/Merchant"
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - authorization
      - xRequestId
    type: object
  postPaymentsCrossBorderCreditTransfersPaymentStatusOKBody:
    properties:
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersPaymentStatusOKBodyOriginalRequestInfo"
      payments:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersPaymentStatusOKBodyPayments"
    required:
      - originalRequestInfo
    type: object
  postPaymentsCrossBorderCreditTransfersPaymentStatusOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsCrossBorderCreditTransfersPaymentStatusOKBodyPayments:
    properties:
      statusReasonCode:
        description: Rejection reson code
        example: AM04
        type: string
      transactionStatus:
        description: Payment transaction status
        enum:
          - ACCP
          - ACSC
          - ACSP
          - ACTC
          - ACWC
          - ACWP
          - PDNG
          - RCVD
          - RJCT
        type: string
    required:
      - transactionStatus
    type: object
  postPaymentsCrossBorderCreditTransfersPaymentStatusParamsBody:
    properties:
      paymentId:
        description: Payment identification
        example: 258aFR415:22Aa:6asdC
        maxLength: 256
        minLength: 1
        type: string
      requestInfo:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersPaymentStatusParamsBodyRequestInfo"
    required:
      - paymentId
      - requestInfo
    type: object
  postPaymentsCrossBorderCreditTransfersPaymentStatusParamsBodyRequestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: 420e5cff-0e2a-4156-991a-f6eeef0478cf
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      consentId:
        description: Consent identification
        example: CBgBTpF3:EBy5xGqQMatk
        maxLength: 256
        minLength: 1
        type: string
      merchant:
        $ref: "#/definitions/Merchant"
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - consentId
      - xRequestId
    type: object
  postPaymentsDomesticCreditTransfersConsentsOKBody:
    properties:
      _links:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsOKBodyLinks"
      additionalData:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsOKBody_additionalData"
      aspspSCAApproach:
        enum:
          - REDIRECT
        type: string
      consentRequestId:
        type: string
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsOKBodyOriginalRequestInfo"
    required:
      - originalRequestInfo
    type: object
  postPaymentsDomesticCreditTransfersConsentsOKBodyLinks:
    properties:
      scaRedirect:
        description: Redirect URL for SCA
        example: https://bank1.com/sca/login
        type: string
    type: object
  postPaymentsDomesticCreditTransfersConsentsOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsDomesticCreditTransfersConsentsParamsBody:
    properties:
      payments:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsParamsBodyPayments"
      requestInfo:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsParamsBodyRequestInfo"
    required:
      - payments
      - requestInfo
    type: object
  postPaymentsDomesticCreditTransfersConsentsParamsBodyPayments:
    properties:
      creditorAccount:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsParamsBodyPaymentsCreditorAccount"
      creditorAddress:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsParamsBodyPaymentsCreditorAddress"
      creditorAgent:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsParamsBodyPaymentsCreditorAgent"
      creditorName:
        description: Bank name
        example: Wood bank
        maxLength: 70
        minLength: 1
        type: string
      debtorAccount:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsParamsBodyPayments_debtorAccount"
      debtorAgent:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsParamsBodyPayments_debtorAgent"
      endToEndIdentification:
        description: Payment end to end identification
        example: Notification
        maxLength: 18
        minLength: 1
        type: string
      instructedAmount:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersConsentsParamsBodyPaymentsInstructedAmount"
      instructionIdentification:
        description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. If API profile of ASPSP is CMA9, then field is mandatory.
        example: ""
        maxLength: 256
        minLength: 1
        type: string
      instructionPriority:
        description: Indicator of the urgency or order of importance
        enum:
          - Normal
          - Urgent
        example: ""
        type: string
      localInstrument:
        description: User community specific instrument.
        enum:
          - UK.FasterPayments
          - PL.Elixir
        example: UK.FasterPayments
        type: string
      remittanceInformationReference:
        description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. (future use)
        example: UniqueRef1
        maxLength: 256
        minLength: 1
        type: string
      remittanceInformationUnstructured:
        description: Description of the payment
        example: Payment for fruits
        maxLength: 140
        minLength: 1
        type: string
      requestedExecutionDate:
        description: Scheduled Payment Date
        example: ""
        format: date
        type: string
      schedule:
        $ref: "#/definitions/RequestPisDomesticSchedule"
    required:
      - creditorAccount
      - creditorName
      - endToEndIdentification
      - instructedAmount
      - localInstrument
    type: object
  postPaymentsDomesticCreditTransfersConsentsParamsBodyPaymentsCreditorAccount:
    properties:
      identification:
        description: Account number
        example: "30087236"
        maxLength: 256
        minLength: 1
        type: string
      schemeName:
        description: Account scheme name
        enum:
          - UK.AccountNumber
          - PL.AccountNumber
        example: UK.AccountNumber
        type: string
    required:
      - identification
    type: object
  postPaymentsDomesticCreditTransfersConsentsParamsBodyPaymentsCreditorAddress:
    properties:
      buildingNumber:
        example: "15"
        maxLength: 256
        minLength: 1
        type: string
      city:
        example: City
        maxLength: 256
        minLength: 1
        type: string
      country:
        description: ISO 3166 ALPHA2 country code
        example: CC
        pattern: ^[A-Z]{2}$
        type: string
      countrySubDivision:
        example: Division
        maxLength: 256
        minLength: 1
        type: string
      postalCode:
        example: PostCode
        maxLength: 256
        minLength: 1
        type: string
      street:
        example: Street
        maxLength: 70
        minLength: 1
        type: string
    required:
      - buildingNumber
      - city
      - country
      - postalCode
      - street
    type: object
  postPaymentsDomesticCreditTransfersConsentsParamsBodyPaymentsCreditorAgent:
    properties:
      clearingSystemIdentification:
        description: |
          System identification:
            * 'UK.SortCode' - UK FPS
        enum:
          - UK.SortCode
        example: UK.SortCode
        type: string
      memberIdentification:
        description: Sort code
        example: "283746"
        maxLength: 256
        minLength: 1
        type: string
    required:
      - clearingSystemIdentification
      - memberIdentification
    type: object
  postPaymentsDomesticCreditTransfersConsentsParamsBodyPaymentsInstructedAmount:
    properties:
      amount:
        description: amount value
        example: 100.23
        exclusiveMinimum: true
        format: double
        minimum: 0
        type: number
      currency:
        description: Currency code
        enum:
          - GBP
          - PLN
        example: GBP
        type: string
    required:
      - amount
      - currency
    type: object
  postPaymentsDomesticCreditTransfersConsentsParamsBodyPayments_debtorAccount:
    properties:
      identification:
        description: Debtor account identification, If localInstrument = 'UK.FasterPayments' and debtorAgent was specified then this needs to be a UK Account number (8 digits)
        example: ""
        maxLength: 256
        minLength: 1
        type: string
    required:
      - identification
  postPaymentsDomesticCreditTransfersConsentsParamsBodyPayments_debtorAgent:
    properties:
      identification:
        description: Debtor agent identification, If localInstrument = 'UK.FasterPayments' and debtorAccount was specified then this needs to be a UK Sort code (6 digits)
        example: ""
        maxLength: 256
        minLength: 1
        type: string
    required:
      - identification
  postPaymentsDomesticCreditTransfersConsentsParamsBodyRequestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: 420e5cff-0e2a-4156-991a-f6eeef0478cf
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      flags:
        description: Request information flags which can influence the behaviour or returned data
        items:
          enum:
            - Return.Raw.Consent
          example: Return.Raw.Consent
          type: string
        type: array
      merchant:
        $ref: "#/definitions/Merchant"
      tppRedirectURI:
        description: Call back uri
        example: https://tpp-ob.com/callback
        maxLength: 256
        minLength: 1
        type: string
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - tppRedirectURI
      - xRequestId
    type: object
  postPaymentsDomesticCreditTransfersOKBody:
    properties:
      consent:
        $ref: "#/definitions/PaymentConsent"
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersOKBodyOriginalRequestInfo"
      transfer:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersOKBodyTransfer"
    required:
      - consent
      - originalRequestInfo
      - transfer
    type: object
  postPaymentsDomesticCreditTransfersOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsDomesticCreditTransfersOKBodyTransfer:
    properties:
      paymentId:
        description: PI / Transfer identification
        example: trasnferIdentificaion1
        type: string
      statusReasonCode:
        description: Rejection reson code
        example: AM04
        type: string
      transactionStatus:
        description: Status of the payment
        enum:
          - ACCP
          - ACSC
          - ACSP
          - ACTC
          - ACWC
          - ACWP
          - PDNG
          - RCVD
          - RJCT
          - CANC
        type: string
    required:
      - paymentId
      - transactionStatus
    type: object
  postPaymentsDomesticCreditTransfersParamsBody:
    properties:
      requestInfo:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersParamsBodyRequestInfo"
    required:
      - requestInfo
    type: object
  postPaymentsDomesticCreditTransfersParamsBodyRequestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: 420e5cff-0e2a-4156-991a-f6eeef0478cf
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      authorization:
        description: The authorization query / data received after PSU has authorized the consent
        example: code=UKdpVsbG8gQ2TP9kZWJleft53serYXV0aUK001&state=38948933-38ae-45af-953e-25a69fefa39e
        maxLength: 5000
        minLength: 1
        type: string
      merchant:
        $ref: "#/definitions/Merchant"
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - authorization
      - xRequestId
    type: object
  postPaymentsDomesticCreditTransfersPaymentStatusOKBody:
    properties:
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersPaymentStatusOKBodyOriginalRequestInfo"
      payments:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersPaymentStatusOKBodyPayments"
    required:
      - originalRequestInfo
    type: object
  postPaymentsDomesticCreditTransfersPaymentStatusOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsDomesticCreditTransfersPaymentStatusOKBodyPayments:
    properties:
      statusReasonCode:
        description: Rejection reson code
        example: AM04
        type: string
      transactionStatus:
        description: Payment transaction status
        enum:
          - ACCP
          - ACSC
          - ACSP
          - ACTC
          - ACWC
          - ACWP
          - PDNG
          - RCVD
          - RJCT
          - CANC
        type: string
    required:
      - transactionStatus
    type: object
  postPaymentsDomesticCreditTransfersPaymentStatusParamsBody:
    properties:
      paymentId:
        description: Payment identification
        example: UK8aFR415:22Aa:6asdC
        maxLength: 256
        minLength: 1
        type: string
      requestInfo:
        $ref: "#/definitions/postPaymentsDomesticCreditTransfersPaymentStatusParamsBodyRequestInfo"
    required:
      - paymentId
      - requestInfo
    type: object
  postPaymentsDomesticCreditTransfersPaymentStatusParamsBodyRequestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: 420e5cff-0e2a-4156-991a-f6eeef0478cf
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      consentId:
        description: Consent identification
        example: UK8sPNznYtfV:5zKxyC
        maxLength: 256
        minLength: 1
        type: string
      merchant:
        $ref: "#/definitions/Merchant"
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - consentId
      - xRequestId
    type: object
  postPaymentsSepaCreditTransfersConsentsOKBody:
    properties:
      _links:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsOKBodyLinks"
      additionalData:
        $ref: "#/definitions/postPaymentsCrossBorderCreditTransfersConsentsOKBody_additionalData"
      aspspSCAApproach:
        enum:
          - REDIRECT
        type: string
      consentRequestId:
        type: string
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsOKBodyOriginalRequestInfo"
    required:
      - originalRequestInfo
    type: object
  postPaymentsSepaCreditTransfersConsentsOKBodyLinks:
    properties:
      scaRedirect:
        description: Redirect URL for SCA
        example: https://bank1.com/sca/login
        type: string
    type: object
  postPaymentsSepaCreditTransfersConsentsOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsSepaCreditTransfersConsentsParamsBody:
    properties:
      payments:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBodyPayments"
      requestInfo:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBodyRequestInfo"
    required:
      - payments
      - requestInfo
    type: object
  postPaymentsSepaCreditTransfersConsentsParamsBodyPayments:
    properties:
      categoryPurpose:
        description: Purpose of the payment
        enum:
          - CASH
          - CORT
          - DVPM
          - INTC
          - TREA
        example: CASH
        type: string
      creditorAccount:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsCreditorAccount"
      creditorAddress:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsCreditorAddress"
      creditorAgent:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBodyPayments_creditorAgent"
      creditorName:
        description: Bank name
        example: Wood bank
        maxLength: 70
        minLength: 1
        type: string
      debtorAccount:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsDebtorAccount"
      debtorAddress:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsDebtorAddress"
      debtorAgent:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBodyPayments_debtorAgent"
      debtorName:
        description: Debtor legal name
        example: NordPole PLC
        maxLength: 256
        minLength: 1
        type: string
      endToEndIdentification:
        description: Payment end to end identification
        example: Notification
        maxLength: 18
        minLength: 1
        type: string
      instructedAmount:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsInstructedAmount"
      instructionPriority:
        description: Indicator of the urgency or order of importance
        enum:
          - Normal
          - Urgent
        example: Normal
        type: string
      localInstrument:
        description: User community specific instrument.
        enum:
          - SEPA
        example: SEPA
        type: string
      remittanceInformationReference:
        description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. (future use)
        example: UniqueRef1
        maxLength: 256
        minLength: 1
        type: string
      remittanceInformationStructured:
        description: Description of the payment
        example: Payment for fruits from card 543210000023456
        maxLength: 256
        minLength: 1
        type: string
      remittanceInformationUnstructured:
        description: Description of the payment
        example: Payment for fruits
        maxLength: 140
        minLength: 1
        type: string
      requestedExecutionDate:
        description: Scheduled Payment Date
        example: ""
        format: date
        type: string
      schedule:
        $ref: "#/definitions/RequestPisSepaSchedule"
    required:
      - creditorAccount
      - creditorAddress
      - creditorAgent
      - creditorName
      - debtorName
      - endToEndIdentification
      - instructedAmount
      - instructionPriority
      - localInstrument
    type: object
  postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsCreditorAccount:
    properties:
      iban:
        description: Account IBAN
        example: PL45222222222222222222222222
        pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
        type: string
    required:
      - iban
    type: object
  postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsCreditorAddress:
    properties:
      buildingNumber:
        example: "15"
        maxLength: 256
        minLength: 1
        type: string
      city:
        example: City
        maxLength: 256
        minLength: 1
        type: string
      country:
        description: ISO 3166 ALPHA2 country code
        example: CC
        pattern: ^[A-Z]{2}$
        type: string
      countrySubDivision:
        example: Division
        maxLength: 256
        minLength: 1
        type: string
      postalCode:
        example: PostCode
        maxLength: 256
        minLength: 1
        type: string
      street:
        example: Street
        maxLength: 70
        minLength: 1
        type: string
    required:
      - country
    type: object
  postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsDebtorAccount:
    properties:
      iban:
        description: Account IBAN
        example: PL45222222222222222222222222
        pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
        type: string
    required:
      - iban
    type: object
  postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsDebtorAddress:
    properties:
      buildingNumber:
        example: "15"
        maxLength: 256
        minLength: 1
        type: string
      city:
        example: City
        maxLength: 256
        minLength: 1
        type: string
      country:
        description: ISO 3166 ALPHA2 country code
        example: CC
        pattern: ^[A-Z]{2}$
        type: string
      countrySubDivision:
        example: Division
        maxLength: 256
        minLength: 1
        type: string
      postalCode:
        example: PostCode
        maxLength: 256
        minLength: 1
        type: string
      street:
        example: Street
        maxLength: 70
        minLength: 1
        type: string
    type: object
  postPaymentsSepaCreditTransfersConsentsParamsBodyPaymentsInstructedAmount:
    properties:
      amount:
        description: amount value
        example: 200
        exclusiveMinimum: true
        format: double
        minimum: 0
        type: number
      currency:
        description: Currency code
        enum:
          - EUR
        example: EUR
        type: string
    required:
      - amount
      - currency
    type: object
  postPaymentsSepaCreditTransfersConsentsParamsBodyPayments_creditorAgent:
    properties:
      bicfi:
        description: Creditor FI
        example: BARCGB22XXX
        maxLength: 256
        minLength: 1
        type: string
    required:
      - bicfi
  postPaymentsSepaCreditTransfersConsentsParamsBodyPayments_debtorAgent:
    properties:
      bicfi:
        description: Debtor FI
        example: BARCGB22XXX
        maxLength: 256
        minLength: 1
        type: string
    required:
      - bicfi
  postPaymentsSepaCreditTransfersConsentsParamsBodyRequestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: b806ae68-a45b-49d6-b25a-69fdb81dede6
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      flags:
        description: Request information flags which can influence the behaviour or returned data
        items:
          enum:
            - Return.Raw.Consent
          type: string
        type: array
      merchant:
        $ref: "#/definitions/Merchant"
      tppRedirectURI:
        description: Call back uri
        example: https://tpp-ob.com/callback
        maxLength: 256
        minLength: 1
        type: string
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - tppRedirectURI
      - xRequestId
    type: object
  postPaymentsSepaCreditTransfersOKBody:
    properties:
      consent:
        $ref: "#/definitions/SepaPaymentConsent"
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersOKBodyOriginalRequestInfo"
      transfer:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersOKBodyTransfer"
    required:
      - consent
      - originalRequestInfo
      - transfer
    type: object
  postPaymentsSepaCreditTransfersOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsSepaCreditTransfersOKBodyTransfer:
    properties:
      paymentId:
        description: PI / Transfer identification
        example: trasnferIdentificaion1
        type: string
      statusReasonCode:
        description: Rejection reson code
        example: AM04
        type: string
      transactionStatus:
        description: Status of the payment
        enum:
          - ACCP
          - ACSC
          - ACSP
          - ACTC
          - ACWC
          - ACWP
          - PDNG
          - RCVD
          - RJCT
          - CANC
        type: string
    required:
      - paymentId
      - transactionStatus
    type: object
  postPaymentsSepaCreditTransfersParamsBody:
    properties:
      requestInfo:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersParamsBodyRequestInfo"
    required:
      - requestInfo
    type: object
  postPaymentsSepaCreditTransfersParamsBodyRequestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: b806ae68-a45b-49d6-b25a-69fdb81dede6
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      authorization:
        description: The authorization query / data received after PSU has authorized the consent
        example: code=PLsepaVsbG8gQ2TP9kZWJleft53serYXV0aPL003&state=38948933-38ae-45af-953e-25a69fefa39e
        maxLength: 5000
        minLength: 1
        type: string
      merchant:
        $ref: "#/definitions/Merchant"
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - authorization
      - xRequestId
    type: object
  postPaymentsSepaCreditTransfersPaymentStatusOKBody:
    properties:
      originalRequestInfo:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersPaymentStatusOKBodyOriginalRequestInfo"
      payments:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersPaymentStatusOKBodyPayments"
    required:
      - originalRequestInfo
    type: object
  postPaymentsSepaCreditTransfersPaymentStatusOKBodyOriginalRequestInfo:
    properties:
      xRequestId:
        description: Original xRequestId given by the client on request
        example: 444e4567-e55b-12d3-a456-426655448888
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - xRequestId
    type: object
  postPaymentsSepaCreditTransfersPaymentStatusOKBodyPayments:
    properties:
      statusReasonCode:
        description: Rejection reson code
        example: AM04
        type: string
      transactionStatus:
        description: Payment transaction status
        enum:
          - ACCP
          - ACSC
          - ACSP
          - ACTC
          - ACWC
          - ACWP
          - PDNG
          - RCVD
          - RJCT
          - CANC
        type: string
    required:
      - transactionStatus
    type: object
  postPaymentsSepaCreditTransfersPaymentStatusParamsBody:
    properties:
      paymentId:
        description: Payment identification
        example: wAa:665hs5:r5544dhhKM
        maxLength: 256
        minLength: 1
        type: string
      requestInfo:
        $ref: "#/definitions/postPaymentsSepaCreditTransfersPaymentStatusParamsBodyRequestInfo"
    required:
      - paymentId
      - requestInfo
    type: object
  postPaymentsSepaCreditTransfersPaymentStatusParamsBodyRequestInfo:
    properties:
      aspspId:
        description: Identification of ASPSP
        example: b806ae68-a45b-49d6-b25a-69fdb81dede6
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
      consentId:
        description: Consent identification
        example: SEPABJbqtZ8sPNznYtfV:5
        maxLength: 256
        minLength: 1
        type: string
      merchant:
        $ref: "#/definitions/Merchant"
      xRequestId:
        description: Request id given by the client
        example: 123e4567-e89b-12d3-a456-426655440000
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        type: string
    required:
      - aspspId
      - consentId
      - xRequestId
    type: object
