--- swagger: "2.0" info: x-ibm-name: sibs-psd2-periodic-multibanco-payments-stub-api title: Periodic Multibanco Payments version: 2.1.8 contact: name: "" url: "" termsOfService: "" license: name: "" url: "" description: "" schemes: - https basePath: / consumes: - application/json produces: - application/json securityDefinitions: x-ibm-client-id: type: apiKey in: header name: X-IBM-Client-Id description: "" security: - x-ibm-client-id: [] x-ibm-configuration: testable: true enforced: true phase: realized paths: /{aspsp-cde}/v1-0-2/periodic-multibanco-payments/{multibanco-payment-type}/{service-payment-name}/: post: responses: 201: description: Created. schema: $ref: '#/definitions/PeriodicMBPaymentResponseResource' 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' tags: - Periodic MB Payment Initiation summary: Periodic MB Payment Initiation operationId: periodicMBPaymentInitiation parameters: - $ref: '#/parameters/aspsp-cde' - $ref: '#/parameters/multibanco-payment-type' - $ref: '#/parameters/TPP-Transaction-ID' - $ref: '#/parameters/TPP-Request-ID' - $ref: '#/parameters/PSU-ID' - $ref: '#/parameters/PSU-ID-Type' - $ref: '#/parameters/PSU-Corporate-ID' - $ref: '#/parameters/PSU-Corporate-ID-Type' - $ref: '#/parameters/PSU-Consent-ID' - $ref: '#/parameters/PSU-Agent' - $ref: '#/parameters/PSU-IP-Address' - $ref: '#/parameters/PSU-Geo-Location' - $ref: '#/parameters/TPP-Redirect-URI' - $ref: '#/parameters/Signature' - $ref: '#/parameters/TPP-Certificate' - $ref: '#/parameters/tppRedirectPreferred' - $ref: '#/parameters/Digest' - $ref: '#/parameters/Date' - $ref: '#/parameters/service-payment-name' - $ref: '#/parameters/periodicMBPaymentRequest' description: Creates a periodic Multibanco payment initiation request at the ASPSP. /{aspsp-cde}/v1-0-2/periodic-multibanco-payments/{multibanco-payment-type}/{service-payment-name}/{payment-id}/: get: responses: 200: description: OK schema: $ref: '#/definitions/PeriodicMBPaymentGetResponseResource' 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' tags: - Get Periodic MB Payment Request summary: Get Periodic MB Payment Request operationId: getPeriodicMBPaymentRequest parameters: - $ref: '#/parameters/aspsp-cde' - $ref: '#/parameters/multibanco-payment-type' - $ref: '#/parameters/service-payment-name' - $ref: '#/parameters/payment-id' - $ref: '#/parameters/TPP-Transaction-ID' - $ref: '#/parameters/TPP-Request-ID' - $ref: '#/parameters/PSU-ID' - $ref: '#/parameters/PSU-ID-Type' - $ref: '#/parameters/PSU-Corporate-ID' - $ref: '#/parameters/PSU-Corporate-ID-Type' - $ref: '#/parameters/Signature' - $ref: '#/parameters/TPP-Certificate' - $ref: '#/parameters/Date' description: Requests the content of Multibanco Periodic Payment Initiation object. delete: responses: 200: description: OK. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/PeriodicMBPaymentCancelResponseResource' 400: description: Bad Request. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 401: description: Unauthorized. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 403: description: Forbidden. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 404: description: Not Found. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 405: description: Method Not Allowed. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 406: description: Not Acceptable. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 408: description: Request Timeout. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 415: description: Unsupported Media Type. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 429: description: Too Many Requests. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 500: description: Internal Server Error. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 503: description: Service Unavailable. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' 504: description: Gatewaty Timeout. headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/ErrorMessage' tags: - Cancel Periodic MB Payment Request summary: Cancel Periodic MB Payment Request operationId: cancelPeriodicMBPaymentRequest parameters: - $ref: '#/parameters/aspsp-cde' - $ref: '#/parameters/multibanco-payment-type' - $ref: '#/parameters/service-payment-name' - $ref: '#/parameters/payment-id' - $ref: '#/parameters/TPP-Transaction-ID' - $ref: '#/parameters/TPP-Request-ID' - $ref: '#/parameters/Signature' - $ref: '#/parameters/TPP-Certificate' - $ref: '#/parameters/TPP-Redirect-URI' - $ref: '#/parameters/Date' description: Cancels a given Periodic Multibanco Payment Initiaton resource. put: responses: 201: description: Created headers: Location: type: string description: Response Location. schema: $ref: '#/definitions/PeriodicMBPaymentUpdateResponseResource' 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' tags: - Periodic MB Payment Update summary: Periodic MB Payment Update operationId: periodicMBPaymentUpdate parameters: - $ref: '#/parameters/aspsp-cde' - $ref: '#/parameters/multibanco-payment-type' - $ref: '#/parameters/service-payment-name' - $ref: '#/parameters/payment-id' - $ref: '#/parameters/TPP-Transaction-ID' - $ref: '#/parameters/TPP-Request-ID' - $ref: '#/parameters/PSU-ID' - $ref: '#/parameters/PSU-ID-Type' - $ref: '#/parameters/PSU-Corporate-ID' - $ref: '#/parameters/PSU-Corporate-ID-Type' - $ref: '#/parameters/Signature' - $ref: '#/parameters/TPP-Certificate' - $ref: '#/parameters/Date' - $ref: '#/parameters/Digest' - $ref: '#/parameters/periodicMBPaymentUpdateRequest' description: Update information related to a previous Periodic Multibanco payment initiation in order to obtain PSUId credentials. /{aspsp-cde}/v1-0-2/periodic-multibanco-payments/{multibanco-payment-type}/{service-payment-name}/{payment-id}/status: get: responses: 200: description: OK. schema: $ref: '#/definitions/PeriodicMBPaymentGetStatusResponseResource' 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' summary: Get Periodic MB Status Request tags: - Get Periodic MB Status Request operationId: getPeriodicMBStatusRequest parameters: - $ref: '#/parameters/aspsp-cde' - $ref: '#/parameters/multibanco-payment-type' - $ref: '#/parameters/service-payment-name' - $ref: '#/parameters/payment-id' - $ref: '#/parameters/TPP-Transaction-ID' - $ref: '#/parameters/TPP-Request-ID' - $ref: '#/parameters/Signature' - $ref: '#/parameters/TPP-Certificate' definitions: AccountReference: description: Identifier of the addressed account. type: object properties: iban: description: International Bank Account Number type: string pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ default: PT000 bban: description: This data elements is used for payment accounts which have no IBAN. type: string default: "1" pattern: ^[a-zA-Z0-9]{1,30}$ pan: description: Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements. type: string maxLength: 35 default: "" maskedPan: description: Primary Account Number (PAN) of a card in a masked form. type: string maxLength: 35 default: "" msisdn: description: An alias to access a payment account via a registered mobile phone number type: string maxLength: 35 default: "" currency: description: ISO 4217 Alpha 3 currency code. type: string default: "" additionalProperties: false 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 Authentication: description: Authentication Data type: object required: - authenticationType - authenticationMethodId properties: authenticationType: description: Type of the authentication method. $ref: '#/definitions/AuthenticationType' authenticationVersion: description: | Depending on the authenticationType. This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP’s documentation. type: string default: "" authenticationMethodId: description: | An identification provided by the ASPSP for the later identification of the authentication method selection. type: string maxLength: 35 default: "" name: description: | This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like “SMS OTP on phone +49160 xxxxx 28”. This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available. type: string default: "" explanation: description: | detailed information about the sca method for the PSU. type: string default: "" additionalProperties: false AuthenticationArray: description: Array of Authentication object type: array items: $ref: '#/definitions/Authentication' description: Authentication Data additionalProperties: false AuthenticationType: description: | authentication types: * SMS_OTP - An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel. * CHIP_OTP - An SCA method, where an OTP is generated by a chip card, e.g. an TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU. * PHOTO_OTP - An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU. * PUSH_OTP - An OTP is pushed to a dedicated authentication APP and displayed to the PSU. type: string enum: - SMS_OTP - CHIP_OTP - PHOTO_OTP - PUSH_OTP default: SMS_OTP additionalProperties: false Challenge: description: Requested Authentication Data type: object properties: image: description: | PNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding , cp. [RFC 4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method. type: string format: byte default: "" data: description: String challenge data type: string default: "" imageLink: description: A link where the ASPSP will provides the challenge image for the TPP. type: string default: "" otpMaxLength: description: The maximal length for the OTP to be typed in by the PSU. type: number default: 0 otpFormat: description: The format type of the OTP to be typed in. type: string enum: - characters - integer default: integer additionalInformation: description: Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU. type: string default: "" additionalProperties: false ErrorMessage: description: Error Information. type: object properties: tppMessages: $ref: '#/definitions/TppMessageArray' description: Messages to the TPP on operational issues. 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 FrequencyCode: description: |- Daily Weekly EveryTwoWeeks Monthly EveryTwoMonths Quarterly SemiAnnual Annual type: string enum: - Daily - Weekly - EveryTwoWeeks - Monthly - EveryTwoMonths - Quarterly - SemiAnnual - Annual default: Monthly 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 PaymentLink: description: | A list of hyperlinks to be recognized by the TPP. properties: redirect: description: | A link to an ASPSP site where SCA is performed within the Redirect SCA approach. type: string default: "" updatePsuIdentification: description: | The link to the payment initiation or account information resource, which needs to be updated by the PSU NextGenPSD2 XS2A Framework – Implementation Guidelines Complex Data Types and Code Lists Published by the Berlin Group under Creative Commons Attribution-NoDerivatives 4.0 International Public License Page 133(ref. License Notice for full license conditions) Attribute Type Condition Description identification if not delivered yet. type: string default: "" updatePsuAuthentication: description: | The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. type: string default: "" selectAuthenticationMethod: description: | This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. type: string default: "" authoriseTransaction: description: | The link to the payment initiation or consent resource, where the “Transaction Authorisation”Request” is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. type: string default: "" self: description: | The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. type: string default: "" updateProprietaryData: description: The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. type: string default: "" status: type: string additionalProperties: false PeriodicMBPaymentCancelResponseResource: type: object properties: transactionStatus: description: The transaction status is filled with codes of the ISO 20022 data table. $ref: '#/definitions/TransactionStatusType' _links: $ref: '#/definitions/PaymentLink' description: 'A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request. Remark: All links can be relative or full links, to be decided by the ASPSP. Type of links admitted in this response, (further links might be added for ASPSP defined extensions): “redirect”: In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser. “updatePsuIdentification”: The link to the payment initiation resource, which needs to be updated by the PSU identification. This might be used in an embedded, redirect or decoupled SCA Approach, where the PSU ID was missing in the first request. “updatePsuAuthentication”: The link to the payment initiation resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. This is used in case of the Embedded or Decoupled SCA approach. “selectAuthenticationMethod” : This is a link to a resource, where the TPP can select the applicable strong customer authentication methods for the PSU, if there were several available authentication methods. This link contained under exactly the same conditions as the data element “authenticationMethods”, see above. “authoriseTransaction” : The link to the payment initiation resource, where the “Payment Authorisation Request” is sent to. This is the link to the resource which will authorise the payment by checking the SCA authentication data within the Embedded SCA approach.' psuMessage: type: string description: Text to be displayed to the PSU. tppMessages: $ref: '#/definitions/TppMessageArray' description: Messages to the TPP on operational issues. transactionFees: description: Can be used by the ASPSP to transport transaction fees relevant for the underlying payments. $ref: '#/definitions/Amount' transactionFeeIndicator: type: boolean description: If equals “true”, the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU. If equals “false”, the transaction will not involve additional specific transaction costs to the PSU. scaMethods: description: This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported. If this data element is contained, then there is also an hyperlink of type “selectAuthenticationMethods” contained in the response body. These methods shall be presented towards the PSU for selection by the TPP. $ref: '#/definitions/AuthenticationArray' additionalProperties: false description: Cancels a given Multibanco payment initiaton resource. PeriodicMBPaymentGetResponseResource: properties: transactionStatus: description: The transaction status is filled with codes of the ISO 20022 data table. $ref: '#/definitions/TransactionStatusType' paymentId: type: string description: Resource identification of the generated payment initiation resource. debtorAccount: description: Debtor account $ref: '#/definitions/AccountReference' instructedAmount: description: Instructed amount (inc. Curr.). $ref: '#/definitions/Amount' transactionFees: description: Can be used by the ASPSP to transport transaction fees relevant for the underlying payments. $ref: '#/definitions/Amount' transactionFeeIndicator: type: boolean description: If equals “true”, the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU. If equals “false”, the transaction will not involve additional specific transaction costs to the PSU. multibancoPaymentEntity: type: string description: Multibanco Payment Entity. multibancoPaymentReference: type: string description: Multibanco Payment Reference additionalReference: type: string description: Additional Multibanco Payment Reference taxpayerIdentificationNumber: type: string description: Tax Payer Identification Number startDate: type: string description: StartDate format: date endDate: type: string description: EndDate format: date frequency: $ref: '#/definitions/FrequencyCode' executionRule: type: string dayOfExecution: type: string serviceEntityShortName: type: string description: It identifies Service Entity Name. plainInvoiceNumber: type: string description: Only mandatory for Multibanco Payments type 'special services' and when transaction status is accepted. plainInvoiceFootnote: type: string description: Only mandatory for Multibanco Payments type 'special services' and when transaction status is accepted. requestedExecutionDate: type: string description: Reserved for future use format: date requestedExecutionTime: type: string description: Reserved for future use processorAuthorisation: type: string description: Only mandatory for Multibanco Payments type 'Payment of Services' and when transaction status is accepted. additionalProperties: false required: - transactionStatus - paymentId - debtorAccount - multibancoPaymentReference PeriodicMBPaymentGetStatusResponseResource: properties: transactionStatus: $ref: '#/definitions/TransactionStatusType' description: In case where the Payment Initiation Request was JSON encoded as defined in Section 5.3.1, the status is returned in this JSON based encoding. additionalReference: type: string description: Additional Multibanco Payment Reference serviceEntityShortName: type: string description: It identifies Service Entity Name. plainInvoiceNumber: type: string description: Only mandatory for Multibanco Payments type 'special services' and when transaction status is accepted. plainInvoiceFootnote: type: string description: Only mandatory for Multibanco Payments type 'special services' and when transaction status is accepted. processorAuthorisation: type: string description: Only mandatory for Multibanco Payments type 'Payment of Services' and when transaction status is accepted. additionalProperties: false PeriodicMBPaymentRequestResource: properties: debtorAccount: $ref: '#/definitions/AccountReference' description: Debtor account instructedAmount: $ref: '#/definitions/Amount' description: Instructed amount (inc. Curr.) multibancoPaymentEntity: type: string description: Multibanco Payment Entity multibancoPaymentReference: type: string description: Multibanco Payment Reference taxpayerIdentificationNumber: type: string maxLength: 12 description: Taxpayer Identification Number startDate: type: string description: StartDate format: date endDate: type: string description: EndDate format: date frequency: $ref: '#/definitions/FrequencyCode' description: Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual executionRule: type: string description: following/preceeding dayOfExecution: type: integer description: 'Month day to execute payment. The format is following the regular expression \d{1,2}. Example: The first day is addressed by "1".' format: int32 requestedExecutionDate: type: string description: Reserved for future use format: date requestedExecutionTime: type: string description: Reserved for future use format: date-time additionalProperties: false required: - instructedAmount - multibancoPaymentReference - multibancoPaymentEntity PeriodicMBPaymentResponseResource: properties: transactionStatus: description: The transaction status is filled with codes of the ISO 20022 data table. $ref: '#/definitions/TransactionStatusType' paymentId: type: string description: Resource identification of the generated payment initiation resource. transactionFees: description: Can be used by the ASPSP to transport transaction fees relevant for the underlying payments. $ref: '#/definitions/Amount' transactionFeeIndicator: type: boolean description: If equals "true" the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU.If equals "false" the transaction will not involve additional specific transaction costs to the PSU. scaMethods: description: This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported. If this data element is contained, then there is also an hyperlink of type “selectAuthenticationMethods” contained in the response body.These methods shall be presented towards the PSU for selection by the TPP. $ref: '#/definitions/AuthenticationArray' chosenScaMethod: description: This data element is only contained in the response if the APSPS has chosen the Embedded SCA Approach, if the PSU is already identified e.g. with the first relevant factor or alternatively an access token, if SCA is required and if the authentication method is implicitly selected. $ref: '#/definitions/Authentication' challengeData: description: It is contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the psuAuthentication link. $ref: '#/definitions/Challenge' _links: $ref: '#/definitions/PaymentLink' description: A list of hyperlinks to be recognized by the TPP. psuMessage: type: string description: Text to be displayed to the PSU. tppMessages: description: Messages to the TPP on operational issues. $ref: '#/definitions/TppMessageArray' additionalProperties: false required: - transactionStatus - paymentId PeriodicMBPaymentUpdateRequestResource: properties: psuData: $ref: '#/definitions/PSUData' description: Include all credentials related data (e.g., user, password and additional data accordingly with ASPSP requests) scaAuthenticationData: description: | SCA authentication data, depending on the chosen authentication method. if the data is binary, then it is base64 encoded. type: string default: "" authenticationMethodId: description: | The authentication method ID as provided by the ASPSP This property is mandatory in a Select Authentication Method type: string default: "" additionalProperties: false PeriodicMBPaymentUpdateResponseResource: properties: transactionStatus: description: The transaction status is filled with codes of the ISO 20022 data table. $ref: '#/definitions/TransactionStatusType' psuMessage: type: string description: Include all credentiText to be displayed to the PSUals related data (e.g., user, password and additional data accordingly with ASPSP requests) tppMessages: description: Messages to the TPP on operational issues. $ref: '#/definitions/TppMessageArray' scaChallengeData: description: It is contained in addition to the data element chosenScaMethod if challenge data is needed for SCA.In rare cases this attribute is also used in the context of the psuAuthentication link. $ref: '#/definitions/Challenge' _links: $ref: '#/definitions/PaymentLink' description: 'A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request. Remark: All links can be relative or full links, to be decided by the ASPSP.Type of links admitted in this response, (further links might be added for ASPSP defined extensions):- “redirect”: In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.“oAuth”: In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.“updatePsuIdentification”: The link to the payment initiation resource, which needs to be updated by the PSU identification. This might be used in an embedded, redirect or decoupled SCA Approach, where the PSU ID was missing in the first request.“updatePsuAuthentication”: The link to the payment initiation resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. This is used in case of the Embedded or Decoupled SCA approach.“selectAuthenticationMethod” : This is a link to a resource, where the TPP can select the applicable strong customer authentication methods for the PSU, if there were several available authentication methods. This link contained under exactly the same conditions as the data element “authenticationMethods”, see above.“authoriseTransaction” : The link to the payment initiation resource, where the “Payment Authorisation Request” is sent to. This is the link to the resource which will authorise the payment by checking the SCA authentication data within the Embedded SCA approach.“self” : The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.“status”: The link to retrieve the transaction status of the payment initiation.' additionalProperties: false required: - transactionStatus PSUData: description: The password or encryptedPassword subfield is used, depending on encryption requirements of the ASPSP as indicated in the corresponding hyperlink contained in the last response message of the ASPSP. type: object properties: password: description: PSU Password. type: string minLength: 1 default: "1" additionalProperties: false 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. RCVD : RECEIVED PDNG : PENDING PATC : PARTIALLY ACCEPTED TECHNICAL CORRECT ACTC : ACCEPTED TECHNICAL VALIDATION ACFC : ACCEPTED FUNDS CHECKED ACWC : ACCEPTED WITH CHANGE ACWP : ACCEPTED WITHOUT POSTING ACSP : ACCEPTED SETTLEMENT IN PROCESS ACSC : ACCEPTED SETTLEMENT COMPLETED CANC : CANCELED RJCT : REJECTED type: string enum: - RCVD - PDNG - PATC - ACTC - ACFC - ACWC - ACWP - ACSP - ACSC - CANC - RJCT default: RJCT additionalProperties: false tags: [] parameters: aspsp-cde: name: aspsp-cde type: string required: true in: path description: Identification of the aspsp default: "" multibanco-payment-type: name: multibanco-payment-type type: string required: true in: path description: 'Multibanco Payment type should be fulfilled as determined by the initiating party and should assume the following values: - service-payments; - special-service-payments; - public-sector-payments.' default: service-payments enum: - service-payments - special-service-payments - public-sector-payments payment-id: name: payment-id type: string required: true in: path description: Identification of the payment service-payment-name: name: service-payment-name type: string required: true in: path description: service-payment-name should be fulfilled whenver Multibanco payment type is "special-service-payments" default: "" Digest: name: Digest type: string required: false in: header description: Hash of the message body default: "" Date: name: Date type: string required: true in: header format: date description: Standard https header element date and time PSU-Agent: name: PSU-Agent type: string required: false in: header description: The forwarded Agent header field of the http request between PSU and TPP. default: "" PSU-Consent-ID: name: PSU-Consent-ID type: string required: false in: header description: This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. default: "" PSU-Corporate-ID: name: PSU-Corporate-ID type: string required: false in: header description: Might be mandated in the ASPSP's documentation. Only used in a corporate context. default: "" PSU-Corporate-ID-Type: name: PSU-Corporate-ID-Type type: string required: false in: header description: Might be mandated in the ASPSPs documentation. Only used in a corporate context. default: "" PSU-Geo-Location: name: PSU-Geo-Location type: string required: false in: header description: The forwarded Geo Location of the corresponding http request between PSU and TPP if available. pattern: ^GEO:[-?+?(\d){1,3}.(\d){6}]{8,11}:[-?+?(\d){1,3}.(\d){6}]{8,11}$ default: GEO:1.111111:-1.111111 PSU-ID: name: PSU-ID type: string required: false in: header description: PSU unique identifier. default: "" PSU-ID-Type: name: PSU-ID-Type type: string required: false in: header description: Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. default: "" PSU-IP-Address: name: PSU-IP-Address type: string required: true in: header description: The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. default: "" 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. default: "" TPP-Certificate: name: TPP-Certificate type: string required: false in: header description: The certificate used for signing the request, in base64 encoding. Shall be contained if the signature is used. default: "" TPP-Redirect-URI: name: TPP-Redirect-URI type: string required: false in: header description: URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Shall be contained at least if the tppRedirectPreferred parameter is set to true or is missing. default: "" TPP-Request-ID: name: TPP-Request-ID type: string required: true in: header description: ID of the request, unique to the call, as determined bu the initiating party. default: "" TPP-Transaction-ID: name: TPP-Transaction-ID type: string required: true in: header description: ID of the transaction as determined by the initiating party. default: "" tppRedirectPreferred: name: tppRedirectPreferred type: string required: false in: query description: | If it equals “true”, the TPP prefers a redirect over an embedded SCA approach. If it equals “false”, the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. default: "" periodicMBPaymentRequest: name: periodicMBPaymentRequest required: true in: body schema: $ref: '#/definitions/PeriodicMBPaymentRequestResource' description: Periodic MB Payment Initiation Request periodicMBPaymentUpdateRequest: name: periodicMBPaymentUpdateRequest required: true in: body description: Periodic MB Payment Update Request schema: $ref: '#/definitions/PeriodicMBPaymentUpdateRequestResource' x-ibm-endpoints: - endpointUrl: https://site2.sibsapimarket.com:8445/sibs/apimarket-sb type: - production - development - endpointUrl: https://site1.sibsapimarket.com:8445/sibs/apimarket-sb type: - production - development ...