API de Redsys para PSD2
Attachment | Size |
---|---|
![]() | 28.88 KB |
![]() | 231.02 KB |
![]() | 15.05 KB |
Endpoint entorno Integracion
Paths
/api-entrada-xs2a/services/{aspsp}/v1/{payment-service}/{payment-product}/{payment-id}/authorisations
Start of the authorization process in case of Start of Payment
The process of initiating authorization is a process required to create a new authorization sub-resource (if it has not been created implicitly).
Identificador consumidor APIS
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
application/json
Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456
Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5
Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443
Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json
Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8
Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip
Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES
Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: 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)
Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST
{
"default": "POST"
}
UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963
Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.
URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb
Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"
Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==
Firma de la petición por el TPP.
Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
Respuesta a la operación
Obtain sub-resources of the authorization in case of Cancellation of Payment
Will provide an array of resource identifiers for all generated authorization sub-resources
Identificador consumidor APIS
Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
Identificador del recurso que referencia a la iniciación de pago o consentimiento.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
application/json
Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456
Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5
Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443
Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json
Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8
Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip
Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES
Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: 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)
Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST
{
"default": "POST"
}
UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963
Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.
URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb
Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"
Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==
Firma de la petición por el TPP.
Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
Respuesta a la operación
/api-entrada-xs2a/services/{aspsp}/v1/{payment-service}/{payment-product}/{payment-id}/authorisations/{authorisation-id}
Update PSU data in case of Payment Initiation
This message is sent by the TPP to the ASPSP through the HUB to inform the SCA method selected by the PSU.
Identificador consumidor APIS
Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)
{
"enum": [
"redsys",
"bankia",
"BBVA",
"BBVAPT",
"BBVABE",
"BBVAFR",
"BBVAEUK",
"caixabank",
"BancSabadell",
"bancosantander",
"bancamarch",
"bankoa",
"cajamar",
"arquia",
"BFF",
"colonya",
"eurocajarural",
"evobanco",
"fiarebancaetica",
"bancopichincha",
"unicajabanco",
"cajasur",
"kutxabank",
"bankinter",
"renta4",
"BCE",
"laboralkutxa",
"mediolanum",
"openbank",
"ibercaja",
"selfbank",
"inversis",
"andbank",
"wizink"
]
}
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
application/json
Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456
Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5
Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443
Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json
Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8
Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip
Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES
Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: 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)
Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST
{
"default": "POST"
}
UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963
Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.
URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb
Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"
Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==
Firma de la petición por el TPP.
Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
Respuesta a la operación
Endpoint in case of Start of Payment
Message sent by the TPP to the ASPSP through the Hub to request the SCA status of an authorization sub-resource
Identificador consumidor APIS
Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)
{
"enum": [
"redsys",
"bankia",
"BBVA",
"BBVAPT",
"BBVABE",
"BBVAFR",
"BBVAEUK",
"caixabank",
"BancSabadell",
"bancosantander",
"bancamarch",
"bankoa",
"cajamar",
"arquia",
"BFF",
"colonya",
"eurocajarural",
"evobanco",
"fiarebancaetica",
"bancopichincha",
"unicajabanco",
"cajasur",
"kutxabank",
"bankinter",
"renta4",
"BCE",
"laboralkutxa",
"mediolanum",
"openbank",
"ibercaja",
"selfbank",
"inversis",
"andbank",
"wizink"
]
}
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
application/json
Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}
Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456
Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5
Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443
Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json
Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8
Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip
Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES
Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: 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)
Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST
{
"default": "POST"
}
UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963
Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.
URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb
Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"
Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==
Firma de la petición por el TPP.
Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
Respuesta a la operación
/api-entrada-xs2a/services/{aspsp}/v1/payments/{payment-product}
Payment start
This message is sent by the TPP to the HUB for the realization of initiation of a payment.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
application / json
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"
}
This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456
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
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
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"
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
/api-entrada-xs2a/services/{aspsp}/v1/bulk-payments/{payment-product}
Bulk payment start
This message is sent by the TPP to the HUB for the realization of bulk payment initiation
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"domestic-faster-payments-uk",
"domestic-bacs-payments-uk"
]
}
application / json
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"
}
This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456
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
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
/api-entrada-xs2a/services/{aspsp}/v1/periodic-payments/{payment-product}
Payment start
Message sent by the TPP to the ASPSP through the Hub to create a recurring / periodic payment start. The recurring payment initiation functionality is covered by the Berlin Group specification as the initiation of a specific permanent order. A TPP can send a recurring payment start where the start date, frequency and, conditionally, end date are provided. Once authorized by the PSU, the payment will be executed by the ASPSP, if possible, following the “permanent order” as sent by the TPP. No additional actions are required by the TPP. In this context, this payment is considered a periodic payment to differentiate payment from other types of recurring payments where third parties are initiating the same amount of money. Note: for permanent orders for payment initiation, the ASPSP will always request SCA with Dynamic linking. Exemptions are not allowed.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
application / json
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"
}
This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456
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
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
/api-entrada-xs2a/services/{aspsp}/v1/payments/{payment-product}/{payment-id}/status
status - Payment status information
This message is sent by the TPP to the HUB to request information on the status of the payment initiation requested by the TPP
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Payment product to use.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB.
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"
}
Supported response format.
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-Encoding: 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: GET. Ex: PSU-Http-Method: GET
{
"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
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
OK
/api-entrada-xs2a/services/{aspsp}/v1/bulk-payments/{payment-product}/{payment-id}/status
statusBulk - Payment status information
This message is sent by the TPP to the HUB to request information on the status of the payment initiation requested by the TPP
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Payment product to use.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB.
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"
}
Supported response format.
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-Encoding: 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: GET. Ex: PSU-Http-Method: GET
{
"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
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
OK
/api-entrada-xs2a/services/{aspsp}/v1/periodic-payments/{payment-product}/{payment-id}/status
statusPeriodic - Payment status information
This message is sent by the TPP to the HUB to request information on the status of the payment initiation requested by the TPP
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Payment product to use.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB.
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"
}
Supported response format.
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-Encoding: 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: GET. Ex: PSU-Http-Method: GET
{
"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
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
OK
/api-entrada-xs2a/services/{aspsp}/v1/payments/{payment-product}/{payment-id}
Payment information
This message is sent by the TPP to the HUB to request information about a payment start
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Payment product to use.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB.
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"
}
Supported response format.
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-Encoding: 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: GET. Ex: PSU-Http-Method: GET
{
"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
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
OK
/api-entrada-xs2a/services/{aspsp}/v1/bulk-payments/{payment-product}/{payment-id}
Payment information
This message is sent by the TPP to the HUB to request information about a payment start
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Payment product to use.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers"
]
}
Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB.
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"
}
Supported response format.
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-Encoding: 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: GET. Ex: PSU-Http-Method: GET
{
"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
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
OK
/api-entrada-xs2a/services/{aspsp}/v1/periodic-payments/{payment-product}/{payment-id}
Payment information