production
https://site1.sibsapimarket.com/sibs/apimarket
production
https://site2.sibsapimarket.com/sibs/apimarket
development
https://site2.sibsapimarket.com:8444/sibs/apimarket
development
https://site1.sibsapimarket.com:8444/sibs/apimarket
Paths
/sibs/v1-0-4/multibanco-payments/service-catalogue
get /sibs/v1-0-4/multibanco-payments/service-catalogue
Multibanco Payments Catalogue
Multibanco Payments Catalogue
x-ibm-client-id
X-IBM-Client-Id
(apiKey located in header)
X-Request-ID
Required in header
string / uuid
ID of the request, unique to the call, as determined by the initiating party.
{
"default": ""
}Date
Required in header
string / date
Standard https header element date and time
Signature
Optional in header
string
A signature of the request by the TPP on application level. This might be mandated by ASPSP
TPP-Signature-Certificate
Optional in header
string
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
{
"default": ""
}Accept
Optional in header
string
application/json
400
Bad Request.
401
Unauthorized.
403
Forbidden.
404
Not Found.
405
Method Not Allowed.
406
Not Acceptable.
408
Request Timeout.
415
Unsupported Media Type.
429
Too Many Requests.
500
Internal Server Error.
503
Service Unavailable.
504
Gatewaty Timeout.
Example Request
Example Response
GET https://site1.sibsapimarket.com/sibs/apimarket/sibs/v1-0-4/multibanco-payments/service-catalogue
Try this operation
Definitions
Amount
{
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"currency": {
"description": "ISO 4217 currency code\n",
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"default": "EUR"
},
"amount": {
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\n\nThe decimal separator is a dot.\n",
"type": "string",
"pattern": "^\\-{0,1}[0-9]{1,9}(\\.[0-9]{0,2}){0,1}$",
"default": "0"
}
},
"additionalProperties": false
}
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
}
Array of entitiy corporate related data
{
"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
}
Array of entitiy corporate related data
{
"type": "array",
"items": {
"$ref": "#/definitions/EntityCorporateData"
},
"additionalProperties": false
}
Requests the list of all available Multibanco payments and corresponding business parameters
{
"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,
"required": [
"servicePaymentData",
"catalogueUpdateDateTime"
]
}
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
}
Comprises all relevant public sector payment data.
{
"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
}
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.
{
"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,
"required": [
"paymentLiquidationCde",
"paymentLiquidationBranch",
"paymentLiquidationReferenceLength",
"paymentLiquidationEntity"
]
}
Array of Public Sector Payment Entities
{
"type": "array",
"items": {
"$ref": "#/definitions/PublicSectorPaymentEntities"
}
}
Transports additional error information.
{
"required": [
"category",
"code"
],
"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
}
Messages to the TPP on operational issues.
{
"type": "array",
"items": {
"$ref": "#/definitions/TppMessage",
"description": "Transports additional error information."
},
"additionalProperties": false
}
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
}
{
"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
}
Array of Service Payment Generic
{
"type": "array",
"items": {
"$ref": "#/definitions/ServicePaymentGeneric"
}
}
Set of service payment generic parameters to be considered in TPP interface definition.
{
"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,
"required": [
"servicePaymenEntityLength",
"servicePaymentReferenceLength",
"servicePaymentMinimumAmount",
"servicePaymentMaximumAmount"
]
}
Comprises all relevant public sector payment data.
{
"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,
"required": [
"servicePaymentName",
"multibancoPaymentEntity",
"socialSecurityPaymentGeneric"
]
}
Set of service payment generic parameters to be considered in TPP interface definition.
{
"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,
"required": [
"socialSecurityPaymentMinimumAmount",
"socialSecurityPaymentMaximumAmount"
]
}
Array of Special Service Payment Amount
{
"type": "array",
"items": {
"$ref": "#/definitions/SpecialServicePaymentAmount"
}
}
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)
{
"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
}
Comprises all relevant special service payment data.
{
"properties": {
"servicePaymentEndpoint": {
"type": "string",
"description": "Service Payment Endpoint"
},
"specialServicePaymentEntities": {
"description": "Comprises all relevant special service payment data.",
"$ref": "#/definitions/SpecialServicePaymentEntitiesArray"
}
},
"additionalProperties": false
}
Array of Special Service Payment Entities
{
"type": "array",
"items": {
"$ref": "#/definitions/SpecialServicePaymentEntities"
}
}
special-service-payment-name should be fulfilled whenver Multibanco payment type is "special-service-payments"
{
"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"
]
}