This set of methods involves the implementation of a PSD2 compliant API based on Berlin Group XS2A Framework.
Base Gateway API Endpoint
Paths
/v1/funds-confirmations
checkAvailabilityOfFunds
Creates a confirmation of funds request to check whether a specific amount is available at the time of the request on an account linked to a given tuple card issuer (TPP)/card number, or addressed by IBAN and TPP respectively
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
ID of the request, unique to the call, as determined by the initiating party.
Request body for a confirmation of funds request.
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.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
Definitions
Reference to an account by either:
- IBAN, of a payment accounts, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
{
"type": "object",
"properties": {
"iban": {
"description": "IBAN of an account",
"example": "FR7612345987650123456789014",
"type": "string",
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
},
"bban": {
"description": "Basic Bank Account Number (BBAN) Identifier\n\nThis data element can be used in the body of the Consent Request\n Message for retrieving Account access Consent from this Account. This\n data elements is used for payment Accounts which have no IBAN.\n ISO20022: Basic Bank Account Number (BBAN).\n\n Identifier used nationally by financial institutions, i.e., in individual countries,\n generally as part of a National Account Numbering Scheme(s),\n which uniquely identifies the account of a customer.",
"example": "BARC12345612345678",
"type": "string",
"pattern": "[a-zA-Z0-9]{1,30}"
},
"pan": {
"description": "Primary Account Number according to ISO\/IEC 7812.",
"example": 5409050000000000,
"type": "string",
"maxLength": 35
},
"maskedPan": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"msisdn": {
"description": "Mobile phone number.",
"example": "+49 170 1234567",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
}
}
}
Link to a resource
{
"type": "object",
"properties": {
"href": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
Object describing an amount as a combination of its value and currency code
{
"example": {
"currency": "EUR",
"amount": 123
},
"type": "object",
"properties": {
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"amount": {
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78",
"example": 5877.78,
"type": "string",
"pattern": "-?[0-9]{1,14}(\\.[0-9]{1,3})?"
}
},
"required": [
"currency",
"amount"
]
}
JSON Request body for the "Confirmation of Funds Service"
{
"type": "object",
"properties": {
"cardNumber": {
"description": "Card Number of the card issued by the PIISP.\nShould be delivered if available.",
"type": "string",
"maxLength": 35
},
"account": {
"$ref": "#\/definitions\/accountReference"
},
"payee": {
"description": "Name payee",
"type": "string",
"maxLength": 70
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
}
},
"required": [
"account",
"instructedAmount"
]
}
A _link object with all available link types
{
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithProprietaryData": {
"$ref": "#\/definitions\/hrefType"
},
"updateProprietaryData": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"updateEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType"
},
"selectAuthenticationMethod": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithTransactionAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"authoriseTransaction": {
"$ref": "#\/definitions\/hrefType"
},
"self": {
"$ref": "#\/definitions\/hrefType"
},
"status": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
},
"account": {
"$ref": "#\/definitions\/hrefType"
},
"balances": {
"$ref": "#\/definitions\/hrefType"
},
"transactions": {
"$ref": "#\/definitions\/hrefType"
},
"transactionDetails": {
"$ref": "#\/definitions\/hrefType"
},
"cardAccount": {
"$ref": "#\/definitions\/hrefType"
},
"cardTransactions": {
"$ref": "#\/definitions\/hrefType"
},
"first": {
"$ref": "#\/definitions\/hrefType"
},
"next": {
"$ref": "#\/definitions\/hrefType"
},
"previous": {
"$ref": "#\/definitions\/hrefType"
},
"last": {
"$ref": "#\/definitions\/hrefType"
},
"download": {
"$ref": "#\/definitions\/hrefType"
}
}
}
Category of the TPP message
{
"example": "ERROR",
"type": "string",
"enum": [
"ERROR",
"WARNING"
]
}
Message codes for HTTP Error codes 2XX.
{
"example": "WARNING",
"type": "string",
"enum": [
"WARNING"
]
}
Message codes defined for PIIS for HTTP Error code 400 (BAD_REQUEST).
{
"example": "FORMAT_ERROR",
"type": "string",
"enum": [
"FORMAT_ERROR",
"PARAMETER_NOT_CONSISTENT",
"PARAMETER_NOT_SUPPORTED",
"SERVICE_INVALID",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"RESOURCE_BLOCKED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKNOWN",
"CONSENT_UNKNOWN",
"CARD_INVALID",
"NO_PIIS_ACTIVATION"
]
}
Message codes defined for PIIS for HTTP Error code 401 (UNAUTHORIZED).
{
"example": "CERTIFICATE_INVALID",
"type": "string",
"enum": [
"CERTIFICATE_INVALID",
"CERTIFICATE_EXPIRED",
"CERTIFICATE_BLOCKED",
"CERTIFICATE_REVOKE",
"CERTIFICATE_MISSING",
"SIGNATURE_INVALID",
"SIGNATURE_MISSING",
"CORPORATE_ID_INVALID",
"PSU_CREDENTIALS_INVALID",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"TOKEN_UNKNOWN",
"TOKEN_INVALID",
"TOKEN_EXPIRED"
]
}
Message codes defined for PIIS for HTTP Error code 403 (FORBIDDEN).
{
"example": "CONSENT_UNKNOWN",
"type": "string",
"enum": [
"CONSENT_UNKNOWN",
"SERVICE_BLOCKED",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED"
]
}
Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
{
"example": "RESOURCE_UNKNOWN",
"type": "string",
"enum": [
"RESOURCE_UNKNOWN"
]
}
Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).
{
"example": "STATUS_INVALID",
"type": "string",
"enum": [
"STATUS_INVALID"
]
}
Message codes defined for PIIS for HTTP Error code 415 (UNSUPPORTED MEDIA TYPE).
{
"example": "UNSUPPORTED_MEDIA_TYPE",
"type": "string",
"enum": [
"UNSUPPORTED_MEDIA_TYPE"
]
}
Message codes for HTTP Error code 503 (SERVICE UNAVAILABLE).
{
"example": "SERVICE_UNAVAILABLE",
"type": "string",
"enum": [
"SERVICE_UNAVAILABLE"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes for HTTP Error codes 2XX.",
"example": "WARNING",
"type": "string",
"default": "WARNING"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode415_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode503_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for PIIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError2"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for PIIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError6"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for PIIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError10"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for PIIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError14"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for PIIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError19"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for PIIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError24"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 405.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 415.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage415_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 503.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage503_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"default": "RESOURCE_UNKNOWN",
"$ref": "#\/definitions\/MessageCode404_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"default": "SERVICE_INVALID",
"$ref": "#\/definitions\/MessageCode405_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"default": "STATUS_INVALID",
"$ref": "#\/definitions\/MessageCode409_PIIS"
}
},
"required": [
"code"
]
}
Object containing a flag which determines whether the available funds are sufficient compared to the instructed amount provided in the request.
{
"type": "object",
"properties": {
"fundsAvailable": {
"type": "boolean",
"description": "Equals \"true\" if sufficient funds are available at the time of the request, \"false\" otherwise."
}
},
"required": [
"fundsAvailable"
]
}