API de Redsys para PSD2
Endpoint entorno Integracion
Paths
/api-entrada-xs2a/services/{aspsp}/v1.1/consents
Request for AIS consent
With this service, a TPP through the HUB can request a consent to access the PSU accounts. This request can be about indicated accounts or not.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST
{
"default": "POST"
}
UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
Identifier that the PSU uses to identify itself to its ASPSP. It can be reported even if an OAuth token is being used and, in such a case, the ASPSP could check that the PSU-ID and token match.
PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities.
Company" identifier in the Online Channels.
Type of PSU-Corporate-ID required by the ASPSP to identify its contents.
If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU.
TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb
{
"default": "www.example.com"
}
If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok"
{
"default": "www.exampleNOK.com"
}
This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP.
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
Access requested to services. Only sub attributes with tags "accounts", "balances" and "transactions" are accepted. Additionally, the ASPSP can support the "availableAccounts" or "allPsd2" sub attributes with the value "all-accounts".
HTTP/1.1 201 Created
/api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}/status
AIS Consent Status
This service allows the TPP to know the status of a previously initiated consent request.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST
{
"default": "GET"
}
UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU.
TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb
{
"default": "www.example.com"
}
If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok"
{
"default": "www.exampleNOK.com"
}
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
{
"default": "TestTPPCertificate"
}
HTTP/1.1 200 Ok
/api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}
Retrieve AIS consent information
This service allows the TPP to know the status of a previously initiated consent request.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST
{
"default": "GET"
}
UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU.
TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb
{
"default": "www.example.com"
}
If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok"
{
"default": "www.example.com"
}
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
HTTP/1.1 201 Created
Remove AIS consent
This service allows the TPP to eliminate a request for consent
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST
{
"default": "DELETE"
}
UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU.
TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb
{
"default": "www.example.com"
}
If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok"
{
"default": "www.exampleNOK.com"
}
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
HTTP/1.1 204 Ok
/api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds
FCS Consent request
With this service, a TPP through the HUB can request a consent to access the PSU accounts. This request can be about indicated accounts or not.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST
{
"default": "POST"
}
UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
Identifier that the PSU uses to identify itself to its ASPSP. It can be reported even if an OAuth token is being used and, in such a case, the ASPSP could check that the PSU-ID and token match.
PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities.
Company" identifier in the Online Channels.
Type of PSU-Corporate-ID required by the ASPSP to identify its contents.
If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU.
TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb
{
"default": "www.example.com"
}
If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok"
{
"default": "www.exampleNOK.com"
}
This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP.
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
Message body
HTTP/1.1 201 Created
/api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}/status
Status of the fund confirmation consent
This service allows the TPP, through the Hub, to know the status in which a resource for confirming funds is in the ASPSP.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Consent-id of the request
Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST
{
"default": "GET"
}
UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU.
TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb
{
"default": "www.example.com"
}
If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok"
{
"default": "www.example.com"
}
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
HTTP/1.1 201 Created
/api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}
Retrieve FCS consent information
This service allows the TPP, through the Hub, to know the status in which a resource for confirming funds is in the ASPSP.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Consent-id of the request
Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST
{
"default": "GET"
}
UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU.
TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb
{
"default": "www.example.com"
}
If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok"
{
"default": "www.example.com"
}
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
HTTP/1.1 201 Created
Delete FCS consent
This service allows the TPP, through the Hub, to know the status in which a resource for confirming funds is in the ASPSP.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Consent-id of the request
Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST
{
"default": "GET"
}
UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU.
TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb
{
"default": "www.example.com"
}
If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok"
{
"default": "www.example.com"
}
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
HTTP/1.1 204 Ok
Definitions
{
"required": [
"authenticationMethodId",
"authenticationType",
"name"
],
"type": "object",
"properties": {
"authenticationType": {
"type": "string",
"description": "Tipo del método de autenticación. Ver anexo 9.6 Tipos de autenticación para más información.",
"example": "SMS_OTP"
},
"authenticationVersion": {
"type": "string",
"description": "Versión de la herramienta asociada al authenticationType.",
"example": "1.0"
},
"authenticationMethodId": {
"type": "string",
"description": "Id del método de autenticación proporcionado por el ASPSP.",
"example": "SMS_OTP"
},
"name": {
"type": "string",
"description": "Nombre del método de autenticación definido por el PSU en la banca online del ASPSP. Alternativamente podría ser una descripción proporcionada por el ASPSP. Si el TPP lo tiene disponible, debe presentarlo al PSU.",
"example": "SMS OTP al teléfono 666777888"
},
"explanation": {
"type": "string",
"description": "Información detallada acerca del método SCA para el PSU."
}
}
}
{
"properties": {
"trustedBeneficiaries": {
"description": "Está solicitando acceso a los beneficiarios de confianza de la cuenta referenciada y relacionada al PSU. si se informa será ignorado por el ASPSP.",
"x-ibm-languages": {
"description": {
"en": "You are requesting access to the trusted beneficiaries of the account referenced and related to the PSU. if it is reported it will be ignored by the ASPSP."
}
},
"$ref": "#\/definitions\/List_AccountReference"
},
"ownerName": {
"description": "Si se informa será ignorado por el ASPSP",
"x-ibm-languages": {
"description": {
"en": "If reported it will be ignored by ASPSP"
}
},
"$ref": "#\/definitions\/List_AccountReference"
}
}
}
{
"properties": {
"accounts": {
"$ref": "#\/definitions\/List_AccountReference",
"description": "Indica las cuentas sobre las que pedir información detallada. Si la lista está vacía, el TPP está solicitando todas las cuentas accesibles.",
"x-ibm-languages": {
"description": {
"en": "Indicates the accounts on which to request detailed information. If the list is empty, the TPP is requesting all accessible accounts. "
}
}
},
"balances": {
"properties": [],
"$ref": "#\/definitions\/List_AccountReference",
"description": "Indica las cuentas sobre las que pedir saldos. Si la lista está vacía, el TPP está solicitando los saldos de todas las listas de cuentas accesibles.",
"x-ibm-languages": {
"description": {
"en": "Indicates the accounts to request balances. If the list is empty, the TPP is requesting the balances of all lists of accessible accounts. "
}
}
},
"transactions": {
"properties": [],
"$ref": "#\/definitions\/List_AccountReference",
"description": "Indica las cuentas sobre las que pedir transacciones. Si la lista está vacía, el TPP está solicitando las transacciones de todas las listas de cuentas accesibles.",
"x-ibm-languages": {
"description": {
"en": "Indicates the accounts on which to request transactions. If the list is empty, the TPP is requesting transactions from all lists of accessible accounts. "
}
}
},
"additionalInformation": {
"properties": [],
"$ref": "#\/definitions\/AdditionalInformationAccess",
"description": "la información contenida en este objeto será ignorada por el ASPSP.",
"x-ibm-languages": {
"description": {
"en": "the information contained in this object will be ignored by the ASPSP."
}
}
},
"availableAccounts": {
"properties": [],
"type": "string",
"description": "Solo el valor “allAccounts” es admitido",
"x-ibm-languages": {
"description": {
"en": "Only the \"allAccounts\" value is supported"
}
},
"example": "allAccounts"
},
"availableAccountsWithBalance": {
"properties": [],
"type": "string",
"description": "Solo el valor “allAccounts” es admitido",
"x-ibm-languages": {
"description": {
"en": "Only the \"allAccounts\" value is supported"
}
},
"example": "allAccounts"
},
"allPsd2": {
"properties": [],
"type": "string",
"example": "allAccounts",
"description": "Solo el valor “allAccounts” es admitido",
"x-ibm-languages": {
"description": {
"en": "Only the \"allAccounts\" value is supported"
}
}
}
},
"additionalProperties": false
}
{
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "object",
"description": "Nombre propietario de la cuenta.",
"x-ibm-languages": {
"description": {
"en": "Account owner name."
}
}
},
"role": {
"type": "object",
"description": "Los siguientes códigos de propietarios son usados: \"owner\",\"legalRepresentative\",\"authorisedUser\"",
"x-ibm-languages": {
"description": {
"en": "The following owner codes are used: \"owner\", \"legalRepresentative\", \"authorizedUser\"."
}
}
}
},
"additionalProperties": true
}
{
"required": [
"currency"
],
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"description": "Identificador de la cuenta a ser usado en el PATH cuando se solicitan datos sobre una cuenta dedicada.",
"example": "3dc3d5b3702348489853f5400a64e80f",
"x-ibm-languages": {
"description": {
"en": "Account identifier to be used in the PATH when requesting data about a dedicated account."
}
}
},
"iban": {
"type": "string",
"description": "IBAN de la cuenta",
"example": "ES1111111111111111111",
"x-ibm-languages": {
"description": {
"en": "Account IBAN"
}
}
},
"bban": {
"type": "string",
"description": "BBAN de la cuenta, cuando esta no tiene IBAN.",
"example": "20385778983000760236",
"x-ibm-languages": {
"description": {
"en": "Account BBAN, when it does not have IBAN."
}
}
},
"msisdn": {
"type": "string",
"description": "Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado.",
"x-ibm-languages": {
"description": {
"en": "Alias to access a payment account through a registered mobile phone number."
}
}
},
"currency": {
"type": "string",
"description": "Tipo de moneda de la cuenta",
"example": "EUR",
"x-ibm-languages": {
"description": {
"en": "Currency type of the account"
}
}
},
"ownerName": {
"type": "string",
"description": "Nombre del propietario legal de la cuenta ,en este caso, el nombre del PSU conectado. Para una cuenta corporativa, el nombre corporativo se usará en este campo.",
"example": "Heike Mustermann",
"x-ibm-languages": {
"description": {
"en": "Name of the legal owner of the account ,in this case, the name of the connected PSU. For a corporate account, the corporate name will be used in this field."
}
}
},
"name": {
"type": "string",
"description": "Nombre de la cuenta asignado por el ASPSP en el acuerdo con el propietario de la cuenta con el objetivo de proporcionar una nueva forma de identificar la cuenta.",
"example": "Nombre asignado por el ASPSP",
"x-ibm-languages": {
"description": {
"en": "Account name assigned by the ASPSP in the agreement with the account owner for the purpose of providing a new way to identify the account."
}
}
},
"displayName": {
"type": "string",
"description": "Nombre de la cuenta definido por el PSU en los Canales Online",
"example": "Nombre asignado por el PSU",
"x-ibm-languages": {
"description": {
"en": "Account name defined by PSU in Online Channels"
}
}
},
"product": {
"type": "string",
"description": "Nombre del producto que da el ASPSP a esta cuenta.",
"example": "Main Account",
"x-ibm-languages": {
"description": {
"en": "Name of the product that gives the ASPSP to this account."
}
}
},
"cashAccountType": {
"type": "string",
"description": "Especifica la naturaleza o el uso de la cuenta.",
"example": "CACC",
"x-ibm-languages": {
"description": {
"en": "Specifies the nature or use of the account."
}
}
},
"status": {
"type": "string",
"description": "Estado de la cuenta. El valor es uno de los siguientes: enabled: la cuenta está disponible ,deleted: cuenta cerrada, blocked: cuenta bloqueada.",
"example": "enabled",
"x-ibm-languages": {
"description": {
"en": "Account status. The value is one of the following: enabled: account is available ,deleted: account is closed, blocked: account is blocked."
}
}
},
"bic": {
"type": "string",
"description": "BIC asociado a la cuenta.",
"example": "XSXHXSMMXXX",
"x-ibm-languages": {
"description": {
"en": "BIC associated to the account."
}
}
},
"linkedAccounts": {
"type": "string",
"description": "En este campo el ASPSP puede nombrar una cuenta asociada a transacciones pendientes de tarjeta.",
"x-ibm-languages": {
"description": {
"en": "In this field the ASPSP can name an account associated with pending card transactions."
}
}
},
"usage": {
"type": "string",
"description": "Especifica el uso de la cuenta. Valores posibles: PRIV: cuenta personal privada, ORGA: cuenta profesional",
"example": "PRIV",
"x-ibm-languages": {
"description": {
"en": "Specifies the use of the account. Possible values: PRIV: private personal account, ORGA: professional account."
}
}
},
"details": {
"type": "string",
"description": "Especificaciones que deben ser provistas por el ASPSP. Características de la cuenta. Características de la tarjeta",
"x-ibm-languages": {
"description": {
"en": "Specifications to be provided by the ASPSP. Account features. Card characteristics"
}
}
},
"balances": {
"type": "object",
"description": "Balances de la cuenta.",
"additionalProperties": {
"$ref": "#\/definitions\/List_Balances"
},
"x-ibm-languages": {
"description": {
"en": "Account balances."
}
}
},
"_links": {
"type": "object",
"description": "Enlaces a la cuenta para recuperar información de balances y\/o transacciones de la cuenta. Links soportados solo cuando se ha dado el consentimiento correspondiente a la cuenta.",
"additionalProperties": {
"$ref": "#\/definitions\/Links"
},
"x-ibm-languages": {
"description": {
"en": "Links to the account to retrieve account balance and\/or transaction information. Links supported only when consent has been given to the account."
}
}
},
"ownerNames": {
"type": "object",
"description": "Listado de nombres de propietarios de la cuenta.",
"additionalProperties": {
"$ref": "#\/definitions\/AccountOwner"
},
"x-ibm-languages": {
"description": {
"en": "List of names of account owners."
}
}
},
"psuName": {
"type": "string",
"description": "Nombre del PSU conectado.En caso de cuentas corporativas, esto podría ser la persona que actúe en nombre de la empresa.",
"example": "Heike Mustermann",
"x-ibm-languages": {
"description": {
"en": "Name of the connected PSU. In case of corporate accounts, this could be the person acting on behalf of the company."
}
}
}
},
"additionalProperties": true
}
{
"required": [
"amount",
"currency"
],
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Moneda del importe.",
"example": "EUR"
},
"amount": {
"type": "string",
"description": "Cantidad del importe. El separador decimal es el punto. Representaciones válidas para EUR: 1056, 5768, 5877.78",
"example": "150.03"
}
}
}
{
"required": [
"balanceAmount",
"balanceType"
],
"type": "object",
"properties": {
"balanceAmount": {
"type": "object",
"description": "Importe y moneda del balance",
"additionalProperties": {
"$ref": "#\/definitions\/Amount"
},
"x-ibm-languages": {
"description": {
"en": "Balance amount and currency"
}
}
},
"balanceType": {
"type": "string",
"description": "Transacciones compuestas por las entradas anotadas y las entradas pendientes en el momento de la petición.",
"example": "closingBooked",
"x-ibm-languages": {
"description": {
"en": "Transactions composed of the entries entered and the pending entries at the time of the request."
}
}
},
"creditLimitIncluded": {
"type": "boolean",
"description": "Flag indicando si el límite de crédito de la cuenta correspondiente está incluido en el cálculo del balance, cuando aplique.",
"example": true,
"x-ibm-languages": {
"description": {
"en": "Flag indicating if the credit limit of the corresponding account is included in the balance calculation, when applicable."
}
}
},
"lastChangeDateTime": {
"type": "string",
"description": "Fecha de la última acción realizada sobre la cuenta.",
"example": "2017-10-25T15:30:35.035Z",
"x-ibm-languages": {
"description": {
"en": "Date of the last action performed on the account."
}
}
},
"referenceDate": {
"type": "string",
"description": "Fecha de referencia del balance",
"example": "2017-10-25T00:00:00.000Z",
"x-ibm-languages": {
"description": {
"en": "Balance sheet reference date"
}
}
},
"lastCommittedTransaction": {
"type": "string",
"description": "entryReference de la última transacción para ayudar al TPP a identificar si ya se conocen todas las transacciones del PSU.",
"example": "1234-asd-567",
"x-ibm-languages": {
"description": {
"en": "entryReference of the last transaction to help the TPP identify if all transactions of the PSU are already known."
}
}
}
},
"additionalProperties": true
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Balance"
}
}
{
"type": "object",
"properties": {
"iban": {
"type": "string",
"example": "ES1111111111111111111111",
"description": "IBAN de la cuenta",
"x-ibm-languages": {
"description": {
"en": "Account IBAN"
}
}
},
"bban": {
"type": "string",
"description": "BBAN de la cuenta, cuando esta no tiene IBAN.",
"x-ibm-languages": {
"description": {
"en": "Account BBAN, when it does not have IBAN."
}
},
"example": "20385778983000760236"
},
"pan": {
"type": "string",
"description": "Número de la tarjeta de la cuenta. Puede ser tokenizado por el ASPSP para cumplir los requerimientos de PCI DSS.Campo no soportado por el HUB.",
"x-ibm-languages": {
"description": {
"en": "Account card number. It can be tokenized by the ASPSP to meet the requirements of PCI DSS. Field not supported by the HUB."
}
},
"example": "1234567891234567"
},
"maskedPan": {
"type": "string",
"description": "Número de la tarjeta de la cuenta de forma enmascarda. Campo no soportado por el HUB.",
"x-ibm-languages": {
"description": {
"en": "Account card number masked. Field not supported by the HUB."
}
},
"example": "123456******4567"
},
"msisdn": {
"type": "string",
"description": "Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado.",
"x-ibm-languages": {
"description": {
"en": "Alias to access a payment account through a registered mobile phone number."
}
},
"example": "1549951988"
},
"currency": {
"type": "string",
"description": "Tipo de moneda.",
"x-ibm-languages": {
"description": {
"en": "Type of currency."
}
},
"example": "EUR"
}
}
}
{
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"description": "Contiene un enlace a un recurso",
"example": "\/v1.1\/payments\/sepa-credit-transfers\/asd-1234-jkl"
}
}
}
{
"type": "object",
"properties": {
"scaRedirect": {
"type": "object",
"description": "URL utilizada para la realización de SCA, mediante redirección del navegador del PSU.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"scaOAuth": {
"type": "object",
"description": "El enlace para recuperar un documento JSON que especifica los detalles del servidor de autorizaciones de ASPSP. El documento JSON sigue la definición dada en https:\/\/tools.ietf.org\/html\/draft-ietf-oauth-discovery. Solo para ASPSPs que requieran Ejecución de pago.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"startAuthorisation": {
"type": "object",
"description": "Enlace al endpoint donde la autorizaición de la transacción o la autorización de la transacción de cancelación debe ser iniciada.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"startAuthorisationWithAuthenticationMethodSelection": {
"type": "object",
"description": "Link al endpoint donde la autorización de una transacción o de una transacción de cancelación debe ser iniciada, donde el método SCA debe ser informado con la correspondiente llamada.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"selectAuthenticationMethod": {
"type": "object",
"description": "Enlace donde el TPP puede seleccionar el método de autenticación de 2º factor aplicable para el PSU, en caso de haber más de uno.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"self": {
"type": "object",
"description": "El enlace al recurso creado para la solicitud. Este enlace puede utilizarse posteriormente para recuperar el estado de la transacción.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"status": {
"type": "object",
"description": "El enlace para recuperar el estado de la transacción. Por ejemplo, estado de inicio de pago.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"scaStatus": {
"type": "object",
"description": "Enlace para recuperar el estado de la autorización o sub-recurso de autorización de cancelación.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"account": {
"type": "object",
"description": "Link al recurso que proporciona los datos de una cuenta.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"balances": {
"type": "object",
"description": "Link al recurso que proporciona los balances de la cuenta.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"transactions": {
"type": "object",
"description": "Link al recurso que proporciona las transacciones de la cuenta.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"cardAccount": {
"type": "object",
"description": "Link al recurso que proporciona los datos de una cuenta de tarjeta.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"cardTransactions": {
"type": "object",
"description": "Link al recurso que proporciona las transacciones de la cuenta de tarjeta.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"transactionDetails": {
"type": "object",
"description": "Enlace al recurso proporcionando detalles de una transacción específica. NO SOPORTADO EN ESTA VERSIÓN",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"first": {
"type": "object",
"description": "Enlace de navegación para informes de cuentas paginados.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"next": {
"type": "object",
"description": "Enlace de navegación para informes de cuentas paginados.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"previous": {
"type": "object",
"description": "Enlace de navegación para informes de cuentas paginados.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"last": {
"type": "object",
"description": "Enlace de navegación para informes de cuentas paginados.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
},
"download": {
"type": "object",
"description": "Enlace de descarga para grandes paquetes de datos AIS. Solo para camt-data.",
"additionalProperties": {
"$ref": "#\/definitions\/Href"
}
}
},
"additionalProperties": true
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/AuthenticationObject"
}
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/AccountDetails"
}
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/AccountReference"
}
}
{
"type": "object",
"properties": {
"access": {
"x-ibm-languages": {
"description": {
"en": "Access requested to services. Only sub attributes with tags \"accounts\", \"balances\" and \"transactions\" are accepted. Additionally, the ASPSP can support the \"availableAccounts\" or \"allPsd2\" sub attributes with the value \"all-accounts\". "
}
},
"$ref": "#\/definitions\/AccountAccess"
},
"recurringIndicator": {
"type": "boolean",
"description": "true: acceso recurrente a la cuenta. false: un solo acceso.",
"x-ibm-languages": {
"description": {
"en": "true: recurring access to the account. false: a single access. "
}
},
"example": "true"
},
"validUntil": {
"type": "string",
"description": "Fecha hasta la que el consentimiento solicita acceso. Para crear el consentimiento con el máximo tiempo de acceso posible se debe usar el valor: 9999-12-31 Cuando se recupere el consentimiento, la fecha máxima posible vendrá ajustada. La validez también incluye hasta la fecha solicitada.",
"x-ibm-languages": {
"description": {
"en": "Date until the consent requests access. To create the consent with the maximum possible access time the value must be used: 9999-12-31 When the consent is recovered, the maximum possible date will be set. The validity also includes up to the requested date."
}
},
"example": "2020-05-17"
},
"frequencyPerDay": {
"type": "integer",
"description": "Indica la frecuencia de acceso a la cuenta por día. 1 si es de un solo acceso.",
"x-ibm-languages": {
"description": {
"en": "Indicates the frequency of access to the account per day. 1 if it is single access."
}
},
"example": "4"
},
"combinedServiceIndicator": {
"type": "boolean",
"description": "Indica que un inicio de pago se realizará en la misma sesión. De momento el HUB no implementará servicios combinados por lo que este campo deberá tomar el valor de falso.",
"x-ibm-languages": {
"description": {
"en": "Indicates that a payment start will be made in the same session. At the moment the HUB will not implement combined services so this field should take the value of false."
}
},
"example": "false"
}
},
"additionalProperties": true,
"required": [
"access",
"recurringIndicator",
"validUntil",
"frequencyPerDay",
"combinedServiceIndicator"
]
}
{
"properties": {
"account": {
"$ref": "#\/definitions\/AccountReference",
"description": "Cuenta sobre la que se realizará la consulta de fondos.",
"x-ibm-languages": {
"description": {
"en": "Account on which the funds inquiry will be carried out."
}
}
},
"cardNumber": {
"type": "string",
"description": "Número de tarjeta de la tarjeta emitida por el PIISP. Debe ser enviada si está disponible.",
"x-ibm-languages": {
"description": {
"en": "Card number of the card issued by the PIISP. It must be sent if available."
}
},
"example": "4548-8100-0000-0001"
},
"cardExpiryDate": {
"type": "string",
"description": "Fecha de caducidad de la tarjeta emitida por el PIISP. (Formato ISODate)",
"x-ibm-languages": {
"description": {
"en": "Expiration date of the card issued by the PIISP. (ISODate format)"
}
},
"example": "2018-05-17"
},
"cardInformation": {
"type": "string",
"description": "Explicación adicional del producto.",
"x-ibm-languages": {
"description": {
"en": "Additional explanation of the product."
}
},
"example": "Informacion adicional"
},
"registrationInformation": {
"type": "string",
"description": "Información adicional acerca del proceso de registro para el PSU. Por ej. una referencia al contrato entre TPP\/PSU",
"x-ibm-languages": {
"description": {
"en": "Additional information about the registration process for the PSU. Eg a reference to the contract between TPP \/ PSU"
}
},
"example": "Informacion adicional"
}
},
"additionalProperties": false,
"required": [
"account"
]
}
{
"properties": {
"psuMessage": {
"type": "string",
"example": "Texto de ejemplo",
"description": "Texto a mostrar al PSU.",
"x-ibm-languages": {
"description": {
"en": "Text to display to the PSU."
}
}
},
"tppMessage": {
"description": "Mensaje para el TPP.",
"x-ibm-languages": {
"description": {
"en": "Message for the TPP."
}
},
"$ref": "#\/definitions\/TppMessage"
},
"consentStatus": {
"type": "string",
"description": "Estado de la transacción. Valores definidos en anexos.",
"x-ibm-languages": {
"description": {
"en": "Status of the transaction. Values defined in annexes."
}
},
"example": "ACCP"
},
"consentId": {
"type": "string",
"description": "Identificador del recurso que referencia al consentimiento. Debe ser contenido si se generó un consentimiento.",
"x-ibm-languages": {
"description": {
"en": "Identifier of the resource that references the consent. It must be contained if a consent was generated."
}
},
"example": "123-QWE-456"
},
"scaMethods": {
"$ref": "#\/definitions\/List_AuthenticationObject",
"description": "Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación.",
"x-ibm-languages": {
"description": {
"en": "This element is content if SCA is required and if the PSU can choose between different authentication methods."
}
}
},
"_links": {
"description": "Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta: redirect, oAuth, self, status",
"x-ibm-languages": {
"description": {
"en": "List of hyperlinks to be recognized by the TPP. Types supported in this response: redirect, oAuth, self, status"
}
},
"$ref": "#\/definitions\/Links"
}
},
"required": [
"consentStatus",
"consentId",
"_links"
]
}
{
"properties": {
"psuMessage": {
"type": "string",
"description": "Mensaje para mostrar",
"x-ibm-languages": {
"description": {
"en": "Message to display"
}
},
"example": "Informacion para PSU"
},
"tppMessage": {
"description": "Mensaje para el TPP",
"x-ibm-languages": {
"description": {
"en": "Message for the TPP"
}
},
"$ref": "#\/definitions\/TppMessage"
},
"consentStatus": {
"type": "string",
"description": "Estado de la transacción (solicitud de consentimiento identificado por consent-id)",
"x-ibm-languages": {
"description": {
"en": "Status of the transaction (consent request identified by consent-id)"
}
},
"example": "AcceptedTechnicalValidation"
}
},
"required": [
"consentStatus"
]
}
{
"properties": {
"psuMessage": {
"type": "string",
"description": "Texto a mostrar al PSU",
"x-ibm-languages": {
"description": {
"en": "Text to display to the PSU"
}
},
"example": "Informacion PSU"
},
"tppMessage": {
"$ref": "#\/definitions\/TppMessage",
"description": "Mensaje para el TPP",
"x-ibm-languages": {
"description": {
"en": "Message for the TPP"
}
}
},
"access": {
"x-ibm-languages": {
"description": {
"en": "Access requested to services. Only sub attributes with tags \"accounts\", \"balances\" and \"transactions\" are accepted. Additionally, the ASPSP can support the \"availableAccounts\" or \"allPsd2\" sub attributes with the value \"all-accounts\". "
}
},
"$ref": "#\/definitions\/AccountAccess"
},
"recurringIndicator": {
"type": "boolean",
"description": "true: acceso recurrente a la cuenta. false: un solo acceso.",
"x-ibm-languages": {
"description": {
"en": "true: recurring access to the account. false: a single access. "
}
},
"example": "true"
},
"validUntil": {
"type": "string",
"description": "Fecha hasta la que el consentimiento solicita acceso. Para crear el consentimiento con el máximo tiempo de acceso posible se debe usar el valor: 9999-12-31 Cuando se recupere el consentimiento, la fecha máxima posible vendrá ajustada.",
"x-ibm-languages": {
"description": {
"en": "Date until the consent requests access. To create the consent with the maximum possible access time the value must be used: 9999-12-31 When the consent is recovered, the maximum possible date will be set. "
}
},
"example": "2018-05-17"
},
"frequencyPerDay": {
"type": "integer",
"description": "Indica la frecuencia de acceso a la cuenta por día. 1 si es de un solo acceso.",
"x-ibm-languages": {
"description": {
"en": "Indicates the frequency of access to the account per day. 1 if it is single access."
}
},
"example": "4"
},
"lastActionDate": {
"type": "string",
"description": "Fecha de la última modificación realizada sobre el consentimiento.",
"x-ibm-languages": {
"description": {
"en": "Date of the last modification made on the consent."
}
},
"example": "2018-01-01"
},
"consentStatus": {
"type": "string",
"example": "valid",
"description": "Valores permitidos: empty, valid, blocked, expired, deleted",
"x-ibm-languages": {
"description": {
"en": "Allowed values: empty, valid, blocked, expired, deleted"
}
}
},
"_links": {
"description": "Tipos de enlaces recomendados para esta respuesta: account. Dependiendo de la naturaleza del consentimiento.",
"x-ibm-languages": {
"description": {
"en": "Recommended link types for this response: account. Depending on the nature of the consent."
}
},
"$ref": "#\/definitions\/Links"
}
},
"required": [
"access",
"recurringIndicator",
"validUntil",
"lastActionDate",
"frequencyPerDay",
"consentStatus"
]
}
{
"required": [
"_links",
"consentStatus",
"consentId"
],
"type": "object",
"properties": {
"consentStatus": {
"type": "string",
"description": "Estado de autenticación del consentimiento. Ver valores definidos en 9.5 Estados de consentimiento",
"example": "received"
},
"consentId": {
"type": "string",
"description": "Identificador del recurso que referencia al consentimiento. Debe ser contenido si se generó un consentimiento."
},
"scaMethods": {
"type": "object",
"description": "Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. Si este dato es contenido también se informará el link \"startAuthorisationWithAuthenticationMethodSelection”. Esto métodos deberán ser presentados al PSU. Nota: Solo si ASPSP soporta selección del método SCA",
"additionalProperties": {
"$ref": "#\/definitions\/List_AuthenticationObject"
}
},
"choosenScaMethod": {
"type": "object",
"description": "NO SOPORTADO PARA ESTA VERSION",
"additionalProperties": {
"$ref": "#\/definitions\/AuthenticationObject"
}
},
"_links": {
"type": "object",
"description": "Lista de hipervínculos para ser reconocidos por el HUB. Tipos soportados en esta respuesta: scaRedirect: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el Hub. startAuthorisation: en caso de que un inicio explícito de la autorización de la transacción sea necesario (no hay selección del método SCA) startAuthorisationWithAuthenticationMethodSelection: link al end-point de autorización donde el sub-recurso de autorización tiene que ser generado mientras se selecciona el método SCA. Este enlace es contenido bajo las mismas condiciones que el campo \"scaMethods\". self: link al recurso de inicio de pago creado por esta petición. status: link para recuperar el estado de la transacción. scaStatus: link para consultar el estado SCA correspondiente al sub-recurso de autorización. Este link es solo contenido si un sub-recurso de autorización ha sido creado. (Si no hay autorización explícita este enlace debe venir obligatoriamente)",
"additionalProperties": {
"$ref": "#\/definitions\/Links"
}
},
"psuMessage": {
"type": "string",
"description": "Texto enviado al TPP a través del HUB para ser mostrado al PSU.",
"example": "Informacion para PSU",
"x-ibm-languages": {
"description": {
"en": "Text sent to the TPP through the HUB to be displayed to the PSU."
}
}
},
"tppMessage": {
"type": "object",
"description": "Mensaje para el TPP enviado a través del HUB.",
"additionalProperties": {
"$ref": "#\/definitions\/TppMessage"
},
"x-ibm-languages": {
"description": {
"en": "Message for the TPP sent through the HUB."
}
}
}
},
"additionalProperties": true
}
{
"required": [
"category",
"code"
],
"properties": {
"category": {
"type": "string",
"example": "OK"
},
"code": {
"properties": [],
"type": "string",
"example": "ACCESS_OK"
},
"text": {
"properties": [],
"type": "string",
"example": "Acceso OK"
},
"path": {
"properties": [],
"type": "string",
"example": "\/example\/path"
}
},
"additionalProperties": false
}