Paths
/{aspsp-cde}/v1/client-data/iban-tin-confirmation
Validation IBAN TIN
Requests the validation of the correlation between IBAN and TIN.
Is asking for detailed account information.
{
"schema": {
"type": "object",
"properties": {
"access": {
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/AccountReference"
}
},
"description": "Requested access services.",
"required": [
"account"
]
},
"taxpayerIdentificationNumber": {
"type": "string",
"maxLength": 12,
"default": "",
"description": "Taxpayer Identification Number. It must be fulfilled with TIN Country Code followed by Taxpayer Identification Number."
},
"creditorAgent": {
"description": "BICFI - Identification of Creditor (BIC SWIFT). It must be fulfilled whenever IBAN do not begin with PT50.",
"type": "string",
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
"default": "ABCDEFABC0A"
}
},
"required": [
"access",
"taxpayerIdentificationNumber"
]
}
}It must be contained if the PSU is involved in request process. This flag is then set to "true".
Identification of the aspsp
ID of the transaction as determined by the initiating party.
ID of the request, unique to the call, as determined by the initiating party.
It should be fulfilled whenever psuInvolved is set to "true". The forwarded Agent header field of the http request between PSU and TPP.
It should be fulfilled whenever psuInvolved is set to "true". The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
It should be fulfilled whenever psuInvolved is set to "true". The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
It should be fulfilled whenever psuInvolved is set to "true". The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
It should be fulfilled whenever psuInvolved is set to "true". 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.
It should be fulfilled whenever psuInvolved is set to "true". Fingerprint of the device used in the request between PSU and TPP, if available.
Hash of the message body. Should be present when Request body exists
{
"default": ""
}200 OK
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/client-data/iban-tin-postalcode-confirmation
Get correlation between IBAN, TIN and Postal Code
Requests the validation of the correlation between IBAN, TIN and Postal Code.
{
"schema": {
"type": "object",
"properties": {
"access": {
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/AccountReference"
}
},
"description": "Requested access services."
},
"taxpayerIdentificationNumber": {
"type": "string",
"maxLength": 12,
"default": "",
"description": "Taxpayer Identification Number. It must be fulfilled with TIN Country Code followed by Taxpayer Identification Number."
},
"postalCode": {
"type": "string",
"maxLength": 4,
"description": "Client Address Postal Code. It should only fulfilled with the first 4 digits of Postal Code.",
"pattern": "^\\d{4}$",
"default": "1111"
},
"creditorAgent": {
"description": "BICFI - Identification of Creditor (BIC SWIFT). It must be fulfilled whenever IBAN do not begin with PT50.",
"type": "string",
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
"default": "ABCDEFABC0A"
}
},
"required": [
"access",
"taxpayerIdentificationNumber",
"postalCode"
]
}
}It must be contained if the PSU is involved in request process. This flag is then set to "true".
Identification of the aspsp
ID of the transaction as determined by the initiating party.
ID of the request, unique to the call, as determined by the initiating party.
It should be fulfilled whenever psuInvolved is set to "true". The forwarded Agent header field of the http request between PSU and TPP.
It should be fulfilled whenever psuInvolved is set to "true". The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
It should be fulfilled whenever psuInvolved is set to "true". The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
It should be fulfilled whenever psuInvolved is set to "true". The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
It should be fulfilled whenever psuInvolved is set to "true". 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.
It should be fulfilled whenever psuInvolved is set to "true". Fingerprint of the device used in the request between PSU and TPP, if available.
Hash of the message body. Should be present when Request body exists
{
"default": ""
}200 OK
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
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,
"required": [
"iban"
]
}
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
}
{
"properties": {
"transactionStatus": {
"description": "Status",
"$ref": "#/definitions/TransactionStatusType"
},
"tinMatchIndicator": {
"type": "boolean",
"description": "Status of IBAN and TIN correlation validation."
},
"accountOwnershipCategory": {
"type": "string",
"description": "Only fulfilled if TinMatchIndicator is equal to \"True\". \\n Account Ownership Category considered are: \\n - Single Account; \\n - Joint Account; \\n - Solidary Account; \\n - Mixed Account; \\n - Business/Organisation Account; \\n - Other Account Ownership Category. \\n"
}
},
"additionalProperties": false,
"required": [
"transactionStatus",
"tinMatchIndicator"
]
}
{
"properties": {
"transactionStatus": {
"description": "Status",
"$ref": "#/definitions/TransactionStatusType"
},
"tinMatchIndicator": {
"type": "boolean",
"description": "Status of IBAN and TIN correlation validation."
},
"postalCodeMatchIndicator": {
"type": "boolean",
"description": "Status of TIN and Postal Code correlation validation."
},
"accountOwnershipCategory": {
"type": "string",
"description": "Only fulfilled if TinMatchIndicator is equal to \"True\". \\n Account Ownership Category considered are: \\n - Single Account; \\n - Joint Account; \\n - Solidary Account; \\n - Mixed Account; \\n - Business/Organisation Account; \\n - Other Account Ownership Category. \\n"
}
},
"additionalProperties": false,
"required": [
"transactionStatus",
"tinMatchIndicator",
"postalCodeMatchIndicator"
]
}
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",
"TRANSACTION_ID_INVALID",
"PRODUCT_INVALID",
"PRODUCT_UNKNOWN",
"REQUIRED_KID_MISSING",
"SESSIONS_NOT_SUPPORTED",
"ACCESS_EXCEEDED",
"REQUESTED_FORMATS_INVALID"
],
"additionalProperties": false
}
{
"type": "object",
"properties": {
"access": {
"type": "object",
"properties": {
"account": {
"$ref": "#/definitions/AccountReference"
}
},
"description": "Requested access services.",
"required": [
"account"
]
},
"taxpayerIdentificationNumber": {
"type": "string",
"maxLength": 12,
"default": "",
"description": "Taxpayer Identification Number. It must be fulfilled with TIN Country Code followed by Taxpayer Identification Number."
},
"creditorAgent": {
"description": "BICFI - Identification of Creditor (BIC SWIFT). It must be fulfilled whenever IBAN do not begin with PT50.",
"type": "string",
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
"default": "ABCDEFABC0A"
}
},
"required": [
"access",
"taxpayerIdentificationNumber"
]
}
{
"type": "object",
"properties": {
"access": {
"type": "object",
"properties": {
"account": {
"$ref": "#/definitions/AccountReference"
}
},
"description": "Requested access services."
},
"taxpayerIdentificationNumber": {
"type": "string",
"maxLength": 12,
"default": "",
"description": "Taxpayer Identification Number. It must be fulfilled with TIN Country Code followed by Taxpayer Identification Number."
},
"postalCode": {
"type": "string",
"maxLength": 4,
"description": "Client Address Postal Code. It should only fulfilled with the first 4 digits of Postal Code.",
"pattern": "^\\d{4}$",
"default": "1111"
},
"creditorAgent": {
"description": "BICFI - Identification of Creditor (BIC SWIFT). It must be fulfilled whenever IBAN do not begin with PT50.",
"type": "string",
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
"default": "ABCDEFABC0A"
}
},
"required": [
"access",
"taxpayerIdentificationNumber",
"postalCode"
]
}
Transports additional error information.
{
"required": [
"category",
"code"
],
"properties": {
"category": {
"type": "string",
"default": "",
"description": "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."
}
}
ISO20022: The transaction status is filled with value of the ISO20022 data table.
{
"type": "string",
"enum": [
"ACTC",
"RJCT"
],
"default": "RJCT",
"additionalProperties": false
}