---
swagger: "2.0"
info:
  x-ibm-name: sibs-psd2-multibanco-payments-catalogue-api
  title: Multibanco Payments Catalogue
  version: 3.0.21
  description: ""
schemes:
- https
basePath: /
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  x-ibm-client-id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- x-ibm-client-id: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /v1-0-3/multibanco-payments/service-catalogue:
    get:
      responses:
        200:
          description: OK
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/MBServiceCatalogueResponseResource'
        400:
          description: Bad Request.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        401:
          description: Unauthorized.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        403:
          description: Forbidden.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        404:
          description: Not Found.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        405:
          description: Method Not Allowed.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        406:
          description: Not Acceptable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        408:
          description: Request Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        415:
          description: Unsupported Media Type.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        429:
          description: Too Many Requests.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        500:
          description: Internal Server Error.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        503:
          description: Service Unavailable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        504:
          description: Gatewaty Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
      parameters:
      - $ref: '#/parameters/TPP-Request-ID'
      - $ref: '#/parameters/TPP-Transaction-ID'
      - $ref: '#/parameters/Date'
      - $ref: '#/parameters/Signature'
      - $ref: '#/parameters/TPP-Certificate'
      tags:
      - Multibanco Payments Catalogue
      summary: Multibanco Payments Catalogue
      operationId: multibancoPaymentsCatalogue
      description: ""
definitions:
  Amount:
    description: Amount
    type: object
    required:
    - currency
    - content
    properties:
      currency:
        description: |
          ISO 4217 currency code
        type: string
        pattern: ^[A-Z]{3,3}$
        default: EUR
      content:
        description: |
          The amount given with fractional digits, where fractions must be compliant to the currency definition.

          The decimal separator is a dot.
        type: string
        pattern: ^\-{0,1}[0-9]{1,9}(\.[0-9]{0,2}){0,1}$
        default: "0"
    additionalProperties: false
  ErrorMessageWithStatus:
    description: Error and status Information.
    type: object
    properties:
      transactionStatus:
        $ref: '#/definitions/TransactionStatusType'
        description: The transaction status is filled with codes of the ISO 20022
          corresponding element.
      tppMessages:
        $ref: '#/definitions/TppMessageArray'
        description: Messages to the TPP on operational issues.
    additionalProperties: false
  EntityCorporateData:
    properties:
      entityFiscalName:
        type: string
        description: Entity Fiscal Name
      entityFiscalNumber:
        type: string
        description: Entity Fiscal Number
      entityFiscalAddress:
        type: string
        description: Entity Fiscal Address
      entityFiscalRegister:
        type: string
        description: Entity Fiscal Register
      entityCorporateCapital:
        description: Entity Corporate Capital Amount
        $ref: '#/definitions/Amount'
    additionalProperties: false
    description: Array of entitiy corporate related data
  EntityCorporateDataArray:
    type: array
    items:
      $ref: '#/definitions/EntityCorporateData'
    additionalProperties: false
    description: Array of entitiy corporate related data
  MBServiceCatalogueResponseResource:
    properties:
      catalogueUpdateDateTime:
        type: string
        description: Indicates when catalogue was last updated. Providers should update
          their catalogue information whenever this date changes.
        format: date-time
      servicePaymentData:
        $ref: '#/definitions/ServicePaymentData'
        description: Data for public sector payments.
      specialServicePaymentData:
        $ref: '#/definitions/SpecialServicePaymentData'
        description: Comprises all relevant special service payment data.
      publicSectorPaymentData:
        $ref: '#/definitions/PublicSectorPaymentData'
        description: Comprises all relevant public sector payment data.
      socialSecurityPaymentData:
        $ref: '#/definitions/SocialSecurityPaymentData'
        description: Relevant data for Social Security payments.
    additionalProperties: false
    description: Requests the list of all available Multibanco payments and corresponding
      business parameters
    required:
    - servicePaymentData
    - catalogueUpdateDateTime
  MessageCode:
    description: Message error codes.
    type: string
    enum:
    - SERVICE_BLOCKED
    - CORPORATE_ID_IVALID
    - CONSENT_UNKNOWN
    - CONSENT_INVALID
    - CONSENT_EXPIRED
    - RESOURCE_UNIKNOWN
    - RESOURCE_EXPIRED
    - TIMESTAMP_INVALID
    - PERIOD_INVALID
    - SCA_METHOD_UNKKNOWN
    - TRANSACTION_ID_INVALID
    - PRODUCT_INVALID
    - PRODUCT_UNKNOWN
    - PAYMENT_FAILED
    - REQUIRED_KID_MISSING
    - SESSIONS_NOT_SUPPORTED
    - ACCESS_EXCEEDED
    - REQUESTED_FORMATS_INVALID
    - CARD_INVALID
    - NO_PIIS_ACTIVATION
    default: CONSENT_INVALID
    additionalProperties: false
  PublicSectorPaymentData:
    properties:
      servicePaymentEndpoint:
        type: string
        description: Service Payment Endpoint
      servicePaymentName:
        type: string
        description: Service Payment Name
      publicSectorPaymentEntities:
        description: Comprises all relevant public sector payment data.
        $ref: '#/definitions/PublicSectorPaymentEntitiesArray'
    additionalProperties: false
    description: Comprises all relevant public sector payment data.
  PublicSectorPaymentEntities:
    properties:
      multibancoPaymentEntity:
        type: string
        description: Must be fulfilled if Multibanco Payment has "service-payments"
          value.
      paymentLiquidationCde:
        type: integer
        description: It indicates Payment Liquidation Code. It represents joint of
          Payment Liquidation Entity with Payment Liquidation Counter.
        format: int32
      paymentLiquidationName:
        type: string
        description: It indicates Payment Liquidation Name
      paymentLiquidationEntity:
        type: integer
        format: int32
        description: It indicates Payment Liquitation Entity
      paymentLiquidationBranch:
        type: integer
        format: int32
        description: It indicates Payment Liquidation Branch related to Payment Liquidation
          Entity.
      paymentLiquidationReferenceLength:
        type: integer
        format: int32
        description: It indicates the length of Payment Liquidation Reference. Payment
          Liquidation Reference exact length accpeted is 15.
    additionalProperties: false
    description: |-
      Report with the list of supported public sector entities.
      It consists on most relevant parameters to be provided to TPP in order to perform high level PSU data entry validation applied to each Public Sector payment entity.
    required:
    - paymentLiquidationCde
    - paymentLiquidationBranch
    - paymentLiquidationReferenceLength
    - paymentLiquidationEntity
  PublicSectorPaymentEntitiesArray:
    type: array
    items:
      $ref: '#/definitions/PublicSectorPaymentEntities'
    description: Array of Public Sector Payment Entities
  TppMessage:
    required:
    - category
    - code
    description: Transports additional error information.
    properties:
      category:
        type: string
        default: ""
        description: Category of the error. Only "ERROR" or "WARNING" permitted.
      code:
        $ref: '#/definitions/MessageCode'
        description: Message error code.
      path:
        type: string
        default: ""
        description: Path of the element of the request message which provoked this
          error message.
      text:
        type: string
        maxLength: 512
        default: ""
        description: Additional explaining text.
    additionalProperties: false
  TppMessageArray:
    type: array
    description: Messages to the TPP on operational issues.
    items:
      $ref: '#/definitions/TppMessage'
      description: Transports additional error information.
    additionalProperties: false
  TransactionStatusType:
    description: |
      ISO20022: The transaction status is filled with value of the ISO20022 data table.
      ACTC : ACCEPTED TECHNICAL VALIDATION
      RJCT : REJECTED
    type: string
    enum:
    - ACTC
    - RJCT
    default: RJCT
    additionalProperties: false
  ServicePaymentData:
    properties:
      servicePaymentEndpoint:
        type: string
        description: Service Payment Endpoint
      servicePaymentName:
        type: string
        description: Service Payment Name
      servicePaymentGeneric:
        $ref: '#/definitions/ServicePaymentGenericArray'
        description: Set of service payment generic parameters to be considered in
          TPP interface definition.
    additionalProperties: false
  ServicePaymentGenericArray:
    type: array
    items:
      $ref: '#/definitions/ServicePaymentGeneric'
    description: Array of Service Payment Generic
  ServicePaymentGeneric:
    properties:
      servicePaymenEntityLength:
        type: integer
        format: int32
        description: It indicates the length of Service Payment Entity. Service payment
          entity exact length accepted is 5.
      servicePaymentReferenceLength:
        type: integer
        format: int32
        description: It indicates the length of Service Payment Reference. Service
          payment reference exact length accepted is 9.
      servicePaymentMinimumAmount:
        $ref: '#/definitions/Amount'
        description: It indicates the minimum amount of a Service Payment. Service
          payment minimum amount accepted is 0,01.
      servicePaymentMaximumAmount:
        $ref: '#/definitions/Amount'
        description: It indicates the maximum amount of a Service Payment. Service
          payment maximum amount accepted is 99999,99.
    additionalProperties: false
    description: Set of service payment generic parameters to be considered in TPP
      interface definition.
    required:
    - servicePaymenEntityLength
    - servicePaymentReferenceLength
    - servicePaymentMinimumAmount
    - servicePaymentMaximumAmount
  SocialSecurityPaymentData:
    properties:
      servicePaymentEndpoint:
        type: string
        description: Fulfill with "social-security-payments"
      servicePaymentName:
        type: string
        description: Fulfill with "social-security-payments"
      multibancoPaymentEntity:
        type: string
        description: In case of "social-security-payment" must be fulfilled with 10078.
      socialSecurityPaymentGeneric:
        description: Comprises all relevant public sector payment data.
        $ref: '#/definitions/SocialSecurityPaymentGeneric'
    additionalProperties: false
    description: Comprises all relevant public sector payment data.
    required:
    - servicePaymentName
    - multibancoPaymentEntity
    - socialSecurityPaymentGeneric
  SocialSecurityPaymentGeneric:
    properties:
      socialSecurityPaymentMinimumAmount:
        $ref: '#/definitions/Amount'
        description: It indicates the minimum amount of a Social Security Payment.
          Service payment minimum amount accepted is 0,01.
      socialSecurityPaymentMaximumAmount:
        $ref: '#/definitions/Amount'
        description: It indicates the maximum amount of a Social Security Payment.
          Service payment maximum amount accepted is 99999,99.
    additionalProperties: false
    description: Set of service payment generic parameters to be considered in TPP
      interface definition.
    required:
    - socialSecurityPaymentMinimumAmount
    - socialSecurityPaymentMaximumAmount
  SpecialServicePaymentAmountArray:
    type: array
    items:
      $ref: '#/definitions/SpecialServicePaymentAmount'
    description: Array of Special Service Payment Amount
  SpecialServicePaymentAmount:
    properties:
      specialServicePaymentOperationAmount:
        $ref: '#/definitions/Amount'
        description: It identifies a specific value accepted as 'amount' associated
          to a specific special service special payment entity.
    additionalProperties: false
    description: |-
      It identifies all possible values associated to data element 'amount'.
      Whenever value '0,00' is positioned in the list it means that other values are acceptable (rather than the others in the list)
  SpecialServicePaymentData:
    properties:
      servicePaymentEndpoint:
        type: string
        description: Service Payment Endpoint
      specialServicePaymentEntities:
        description: Comprises all relevant special service payment data.
        $ref: '#/definitions/SpecialServicePaymentEntitiesArray'
    additionalProperties: false
    description: Comprises all relevant special service payment data.
  SpecialServicePaymentEntitiesArray:
    type: array
    items:
      $ref: '#/definitions/SpecialServicePaymentEntities'
    description: Array of Special Service Payment Entities
  SpecialServicePaymentEntities:
    properties:
      servicePaymentName:
        type: string
        description: It identifies special service payment name
      multibancoPaymentEntity:
        type: string
        description: Must be fulfilled if Multibanco Payment has "service-payments"
          value. In case of "public-sector-payments" must be fulfilled with 10095.
      specialServicePaymentMinimumAmount:
        $ref: '#/definitions/Amount'
        description: It indicates the minimum amount accepted to Special Service Payment.
      specialServicePaymentMaximumAmount:
        $ref: '#/definitions/Amount'
        description: It indicates the maximum amount accepted to Special Service Payment.
      specialServicePaymentAmountAbsoluteLength:
        type: integer
        format: int32
        description: It indicates the absolute length of Special Service Payment Amount.
      specialServicePaymentAmountDecimalLength:
        type: integer
        format: int32
        description: It indicates the decimal length of Special Service Payment Amount.
      specialServicePaymentReferenceLength:
        type: integer
        format: int32
        description: It indicates the length of Special Service Payment Reference.
      specialServicePaymentAmounts:
        description: It identifies all possible values associated to data element
          'amount'. Whenever value '0,00' is positioned in the list it means that
          other values are acceptable (rather than the others in the list)
        $ref: '#/definitions/SpecialServicePaymentAmountArray'
      entitiesCorporateData:
        $ref: '#/definitions/EntityCorporateDataArray'
        description: Entity Corporate Capital Currency.
    additionalProperties: false
    required:
    - multibancoPaymentEntity
    - specialServicePaymentMinimumAmount
    - specialServicePaymentMaximumAmount
    - specialServicePaymentAmountDecimalLength
    - specialServicePaymentReferenceLength
    - specialServicePaymentAmountAbsoluteLength
    - servicePaymentName
    description: special-service-payment-name should be fulfilled whenver Multibanco
      payment type is "special-service-payments"
tags: []
parameters:
  Date:
    name: Date
    type: string
    required: true
    in: header
    format: date
    description: Standard https header element date and time
  Signature:
    name: Signature
    type: string
    required: false
    in: header
    description: A signature of the request by the TPP on application level. This
      might be mandated by ASPSP
  TPP-Request-ID:
    name: TPP-Request-ID
    type: string
    required: true
    in: header
    description: ID of the request, unique to the call, as determined by the initiating
      party.
  TPP-Transaction-ID:
    name: TPP-Transaction-ID
    type: string
    required: true
    in: header
    description: ID of the transaction, unique to the call, as determined by the initiating
      party.
  TPP-Certificate:
    name: TPP-Certificate
    type: string
    required: false
    in: header
    description: The certificate used for signing the request, in base64 encoding.
      Must be contained if a signature is contained.
x-ibm-endpoints:
- endpointUrl: https://site1.sibsapimarket.com/sibs/apimarket
  type:
  - production
- endpointUrl: https://site2.sibsapimarket.com/sibs/apimarket
  type:
  - production
- endpointUrl: https://site2.sibsapimarket.com:8444/sibs/apimarket
  type:
  - development
- endpointUrl: https://site1.sibsapimarket.com:8444/sibs/apimarket
  type:
  - development
...