Paths
/{aspsp-cde}/v1-0-0/mandates/{product-name}
Creates an Direct Debit consent resource at the SIBS API Management solution regarding creation of mandate specified in this request.
Creates an Direct Debit consent resource at the SIBS API Management solution regarding creation of mandate specified in this request.
The addressed product name endpoint, e.g. for SEPA Core Direct Debit (SDD) e-Mandates. The default list of products supported in this standard is: \n - sepa-direct-debits. \n The ASPSP will publish which of the product name endpoints will be supported.\n Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
{
"enum": [
"sepa-direct-debits"
]
}Identification of the aspsp
It must be contained if the PSU is involved in request process. This flag is then set to "true".
Standard https header element date and time
Hash of the message body. Should be present when Request body exists
ID of the transaction as determined by the initiating party.
ID of the request, unique to the call, as determined by the initiating party.
The forwarded Agent header field of the http request between PSU and TPP.
{
"default": ""
}The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. Do not fill in Direct Debit context. Reserved for future use.
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"
}The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
{
"default": ""
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
{
"default": ""
}Fingerprint of the device used in the request between PSU and TPP, if available.
{
"default": ""
}Mandate Request
Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
Update information related to a previous Direct Debit consent resource request.
Update information related to a previous Direct Debit consent resource request.
The addressed product name endpoint, e.g. for SEPA Core Direct Debit (SDD) e-Mandates. The default list of products supported in this standard is: \n - sepa-direct-debits. \n The ASPSP will publish which of the product name endpoints will be supported.\n Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
{
"enum": [
"sepa-direct-debits"
]
}Identification of the aspsp
It must be contained if the PSU is involved in request process. This flag is then set to "true".
Hash of the message body. Should be present when Request body exists
Standard https header element date and time
Identification of updating action type in request context. It must fulfill with the following values:
- 'MNDD', when update scope is maximumAmount and/or finalCollectionDate;
- 'MNDA', when update scope is Debtor Account Details (namely, IBAN);
- 'MNDI', when update scope is mandate inactivation;
- 'MNDR', when update scope is mandate reactivation.
{
"enum": [
"MNDD",
"MNDA",
"MNDI",
"MNDR"
]
}ID of the transaction as determined by the initiating party.
ID of the request, unique to the call, as determined by the initiating party.
The forwarded Agent header field of the http request between PSU and TPP.
{
"default": ""
}The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. Do not fill in Direct Debit context. Reserved for future use.
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"
}The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
{
"default": ""
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
{
"default": ""
}Fingerprint of the device used in the request between PSU and TPP, if available.
{
"default": ""
}Mandate Update Request.
Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
/{aspsp-cde}/v1-0-0/mandates/{product-name}/{mandate-id}
Requests the content of a Direct Debit consent resource.
Requests the content of a Direct Debit consent resource.
Identification of the aspsp
The addressed product name endpoint, e.g. for SEPA Core Direct Debit (SDD) e-Mandates. The default list of products supported in this standard is: \n - sepa-direct-debits. \n The ASPSP will publish which of the product name endpoints will be supported.\n Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
{
"enum": [
"sepa-direct-debits"
]
}Identification of the Direct Debit mandate resource. It refers to Debit Authorisation Number.
Identification of the SEPA Direct Debits service related to the specific Direct Debit Mandate. It can be fulfilled with the following values: - "COR" when it refers to SEPA DD CORE service; - "B2B" when it refers to SEPA DD B2B service.
Standard https header element date and time
Hash of the message body. Should be present when Request body exists
Identification of Creditors, e.g. a SEPA Creditor ID
{
"maxLength": 35
}It must be contained if the PSU is involved in request process. This flag is then set to "true".
ID of the transaction as determined by the initiating party.
ID of the request, unique to the call, as determined by the initiating party.
The forwarded Agent header field of the http request between PSU and TPP.
{
"default": ""
}The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. Do not fill in Direct Debit context. Reserved for future use.
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"
}The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
{
"default": ""
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
{
"default": ""
}Fingerprint of the device used in the request between PSU and TPP, if available.
{
"default": ""
}Mandate Request
Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
Definitions
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
}
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
}
Message error codes.
{
"type": "string",
"enum": [
"CERTIFICATE_INVALID",
"CERTIFICATE_EXPIRED",
"CERTIFICATE_BLOCKED",
"CERTIFICATE_REVOKED",
"CERTIFICATE_MISSING",
"SIGNATURE_INVALID",
"SIGNATURE_MISSING",
"FORMAT_ERROR",
"PSU_CREDENTIALS_INVALID",
"SERVICE_INVALID",
"SERVICE_BLOCKED",
"CORPORATE_ID_INVALID",
"CONSENT_UNKNOWN",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"TOKEN_UNKNOWN",
"TOKEN_INVALID",
"TOKEN_EXPIRED",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKNOWN",
"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
}
ISO20022: The transaction status is filled with value of the ISO20022 data table.
{
"type": "string",
"enum": [
"ACCP",
"ACTC",
"RCVD",
"PDNG",
"RJCT",
"CANC",
"SUSP"
],
"default": "RJCT",
"additionalProperties": false
}
authentication status of the mandate. Values: "ACCP"-"AcceptedCustomerProfile"; "ACSC"-"AcceptedSettlementCompleted"; "ACSP"-"AcceptedSettlementInProcess"; "ACTC"-"AcceptedTechnicalValidation"; "ACWC"-"AcceptedWithChange"; "ACWP"-"AcceptedWithoutPosting"; "RCVD"-"Received"; "PDNG"-"Pending"; "RJCT"-"Rejected"; "CANC"-"Cancelled"
{
"type": "string",
"enum": [
"ACCP",
"ACSC",
"ACSP",
"ACTC",
"ACWC",
"ACWP",
"RCVD",
"PDNG",
"RJCT",
"CANC"
],
"default": "RJCT",
"additionalProperties": false
}
Is asking for detailed account information.
If the array is empty, the TPP is asking for an accessible account list. This may be restricted in a PSU/ASPSP authorization dialogue.
{
"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",
"pattern": "^[A-Z]{3,3}$"
}
},
"additionalProperties": false,
"required": [
"iban"
]
}
{
"properties": {
"debtorAccount": {
"$ref": "#/definitions/AccountReference"
}
},
"required": [
"debtorAccount"
]
}
{
"properties": {
"mandateId": {
"type": "string",
"description": "Identification of the Direct Debit mandate resource. It refers to Debit Authorisation Number."
},
"serviceId": {
"type": "string",
"enum": [
"COR",
"B2B"
],
"default": "COR",
"additionalProperties": false,
"description": "Identification of the SEPA Direct Debits service related to the specific Direct Debit Mandate. It can be fulfilled with the following values: - \"COR\" when it refers to SEPA DD CORE service; - \"B2B\" when it refers to SEPA DD B2B service."
},
"creditorId": {
"type": "string",
"description": "Identification of Creditors, e.g. a SEPA Creditor ID",
"maxLength": 35
},
"creditorAccount": {
"$ref": "#/definitions/AccountReference"
},
"debtorName": {
"type": "string",
"maxLength": 35,
"description": "Do not fill in Direct Debit context. Reserved for future use."
},
"debtorAgent": {
"type": "string",
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
"default": "ABCDEFABC0A",
"description": "Identification of Creditor (BIC SWIFT). It must be fulfilled whenever IBAN do not begin with PT50."
},
"debtorAccount": {
"$ref": "#/definitions/AccountReference"
},
"firstCollectionDate": {
"type": "string",
"format": "date",
"description": "Date of the first collection of a direct debit as per the mandate. Do not fill in Direct Debit context. Reserved for future use."
},
"finalCollectionDate": {
"type": "string",
"format": "date",
"description": "Date of the final collection of a direct debit as per the mandate. Do not fill in Direct Debit context. Reserved for future use."
},
"frequency": {
"type": "string",
"enum": [
"ADHO",
"DAIL",
"WEEK",
"MNTH",
"QURT",
"MIAN",
"YEAR"
],
"default": "ADHO",
"description": "Regularity with which instructions are to be created and processed. Values: \"ADHO\"-\"Standard\"; \"DAIL\"-\"Daily\"; \"WEEK\"-\"Weekly\"; \"MNTH\"-\"Monthly\"; \"QURT\"-\"Quarterly\"; \"MIAN\"-\"SemiAnnual\"; \"YEAR\"-\"Annual\""
},
"maximumAmount": {
"description": "The maximum amount to be collected (Min. 5€). Related amount will be considered as expressed in Euro currency.",
"type": "integer",
"minimum": 5
}
},
"additionalProperties": false,
"required": [
"mandateId",
"serviceId",
"creditorId",
"creditorAccount",
"debtorAccount"
]
}
Mandates Update Request Resource
{
"properties": {
"mandateId": {
"type": "string",
"maxLength": 35,
"description": "Identification of the Direct Debit mandate resource. It refers to Debit Authorisation Number."
},
"serviceId": {
"type": "string",
"maxLength": 3,
"enum": [
"COR",
"B2B"
],
"default": "COR",
"description": "Identification of the SEPA Direct Debits service related to the specific Direct Debit Mandate. It can be fulfilled with the following values: - \"COR\" when it refers to SEPA DD CORE service; - \"B2B\" when it refers to SEPA DD B2B service."
},
"creditorId": {
"type": "string",
"maxLength": 32,
"description": "Identification of Creditors, e.g. a SEPA Creditor ID"
},
"creditorAccount": {
"$ref": "#/definitions/AccountReference"
},
"debtorName": {
"type": "string",
"maxLength": 35,
"description": "Do not fill in Direct Debit context. Reserved for future use."
},
"debtorAgent": {
"type": "string",
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
"default": "ABCDEFABC0A",
"description": "Identification of Creditor (BIC SWIFT). It must be fulfilled whenever IBAN do not begin with PT50."
},
"debtorAccount": {
"$ref": "#/definitions/AccountReference"
},
"oldDebtorAccount": {
"description": "Is asking for detailed account information. If the array is empty, the TPP is asking for an accessible account list. This may be restricted in a PSU/ASPSP authorization dialogue.",
"$ref": "#/definitions/AccountReference"
},
"finalCollectionDate": {
"type": "string",
"description": "Date of the final collection of a direct debit as per the mandate. Do not fill in Direct Debit context. Reserved for future use.",
"format": "date"
},
"frequency": {
"type": "string",
"enum": [
"ADHO",
"DAIL",
"WEEK",
"MNTH",
"QURT",
"MIAN",
"YEAR"
],
"default": "ADHO",
"description": "Regularity with which instructions are to be created and processed. Values: \"ADHO\"-\"Standard\"; \"DAIL\"-\"Daily\"; \"WEEK\"-\"Weekly\"; \"MNTH\"-\"Monthly\"; \"QURT\"-\"Quarterly\"; \"MIAN\"-\"SemiAnnual\"; \"YEAR\"-\"Annual\""
},
"maximumAmount": {
"description": "The maximum amount to be collected. Related amount will be considered as expressed in Euro currency If maximumAmount is the update object, it's not allowed to fill 'IBAN'. If updateType is equal to 'MNDA', in order to keep previous Direct Debit context, maximumAmount should be fulfilled with previous indicated value. If maximumAmount is not fulfilled, Direct Debit will be updated with default value, overriding previous customer's defined value",
"type": "integer",
"minimum": 5
}
},
"additionalProperties": false,
"required": [
"mandateId",
"serviceId",
"creditorId",
"creditorAccount",
"debtorAccount"
]
}
{
"properties": {
"mandateStatus": {
"description": "Authentication status of the mandate",
"$ref": "#/definitions/MandateStatusType"
},
"mandateId": {
"type": "string",
"maxLength": 35,
"description": "Identification of the mandate resource as it is used in the API structure"
},
"serviceId": {
"type": "string",
"maxLength": 3,
"enum": [
"COR",
"B2B"
],
"default": "COR",
"description": "Identification of the SEPA Direct Debits service related to the specific Direct Debit Mandate. It can be fulfilled with the following values: - \"COR\" when it refers to SEPA DD CORE service; - \"B2B\" when it refers to SEPA DD B2B service."
},
"creditorId": {
"type": "string",
"maxLength": 32,
"description": "Identification of Creditors, e.g. a SEPA Creditor ID"
},
"transactionStatus": {
"description": "",
"$ref": "#/definitions/TransactionStatusType"
},
"tppMessages": {
"description": "Messages to the TPP on operational issues.",
"$ref": "#/definitions/TppMessageArray"
}
},
"additionalProperties": false,
"required": [
"mandateStatus",
"mandateId",
"serviceId",
"creditorId",
"transactionStatus"
]
}
Mandates Update Response Resource
{
"properties": {
"mandateStatus": {
"description": "",
"$ref": "#/definitions/MandateStatusType"
},
"mandateId": {
"type": "string",
"maxLength": 35,
"description": "Identification of the mandate resource as it is used in the API structure"
},
"serviceId": {
"type": "string",
"maxLength": 3,
"enum": [
"COR",
"B2B"
],
"default": "COR",
"description": "Identification of the SEPA Direct Debits service related to the specific Direct Debit Mandate. It can be fulfilled with the following values: - \"COR\" when it refers to SEPA DD CORE service; - \"B2B\" when it refers to SEPA DD B2B service."
},
"creditorId": {
"type": "string",
"maxLength": 32,
"description": "Identification of Creditors, e.g. a SEPA Creditor ID"
},
"transactionStatus": {
"description": "",
"$ref": "#/definitions/TransactionStatusType"
},
"tppMessages": {
"description": "Messages to the TPP on operational issues.",
"$ref": "#/definitions/TppMessageArray"
}
},
"additionalProperties": false,
"required": [
"mandateStatus",
"transactionStatus"
]
}
Returns the content of a Direct Debit consent resource.
{
"properties": {
"mandateId": {
"type": "string",
"maxLength": 35,
"description": "Identification of the Direct Debit mandate resourceIt refers to Debit Authorisation Number."
},
"serviceId": {
"type": "string",
"maxLength": 3,
"enum": [
"COR",
"B2B"
],
"default": "COR",
"description": "Identification of the SEPA Direct Debits service related to the specific Direct Debit Mandate. It can be fulfilled with the following values: - \"COR\" when it refers to SEPA DD CORE service; - \"B2B\" when it refers to SEPA DD B2B service. In current context, it shall be fulifilled with \"B2B\"."
},
"creditorId": {
"type": "string",
"maxLength": 32,
"description": "Identification of Creditors, e.g. a SEPA Creditor ID"
},
"recurringIndicator": {
"type": "boolean",
"description": "true, if the mandate is recurring false, if the mandate is one-off"
},
"frequency": {
"type": "string",
"enum": [
"ADHO",
"DAIL",
"WEEK",
"MNTH",
"QURT",
"MIAN",
"YEAR"
],
"default": "ADHO",
"description": "Regularity with which instructions are to be created and processed. Values: \"ADHO\"-\"Standard\"; \"DAIL\"-\"Daily\"; \"WEEK\"-\"Weekly\"; \"MNTH\"-\"Monthly\"; \"QURT\"-\"Quarterly\"; \"MIAN\"-\"SemiAnnual\"; \"YEAR\"-\"Annual\""
},
"firstCollectionDate": {
"type": "string",
"description": "Date of the first collection of a direct debit as per the mandate.",
"format": "date"
},
"finalCollectionDate": {
"type": "string",
"description": "Date of the final collection of a direct debit as per the mandate.",
"format": "date"
},
"maximumAmount": {
"type": "integer",
"description": "The maximum amount to be collected. Related amount will be considered as expressed in Euro currency"
},
"creditorAccount": {
"$ref": "#/definitions/AccountReference"
},
"debtorName": {
"type": "string",
"maxLength": 35,
"description": "Do not fill in Direct Debit context. Reserved for future use."
},
"debtorAccount": {
"$ref": "#/definitions/AccountReference"
},
"lastActionDate": {
"type": "string",
"description": "This date is containing the date of the last action on the mandate object either through the XS2A interface or the PSU/ASPSP interface having an impact on the status.",
"format": "date"
},
"mandateStatus": {
"description": "The status of the mandate resource.",
"$ref": "#/definitions/MandateStatusType"
},
"transactionStatus": {
"description": "Status",
"$ref": "#/definitions/TransactionStatusType"
}
},
"additionalProperties": false,
"required": [
"mandateId",
"serviceId",
"creditorId",
"creditorAccount",
"debtorAccount",
"mandateStatus",
"transactionStatus"
]
}