Endpoint entorno Integracion
Paths
/api-entrada-xs2a/services/v1.1/sva/aspsps
Versión 1 ASPSPs disponibles
Este mensaje es enviado por el TPP hacia el HUB para recibir la información acerca de que ASPSP están disponibles en el sistema.
Identificador consumidor APIS
Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
HTTP/1.1 200 Ok
/api-entrada-xs2a/services/v2.1/sva/aspsps
Versión 2 ASPSPs disponibles
Este mensaje es enviado por el TPP hacia el HUB para recibir la información acerca de que ASPSP están disponibles en el sistema.
Identificador consumidor APIS
Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
HTTP/1.1 200 Ok
/api-entrada-xs2a/services/{aspsp}/v1.1/sva/payments/{payment-product}
Realización inicio de pago
Este servicio permite al TPP la realización de un inicio de un pago sin informar la cuenta del ordenante “debtorAccount” y proporciona el listado de cuentas durante el flujo SCA para que el PSU seleccione una.
Identificador consumidor APIS
URL del hub donde se publica el servicio
Producto de pago a usar.
{
"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
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.
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
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
{
"default": "http:\/\/www.example.com"
}
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"
{
"default": "http:\/\/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.
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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
Body de la petición
HTTP/1.1 201 Created
/api-entrada-xs2a/services/{aspsp}/v1.1/sva/periodic-payments/{payment-product}
Realización de inicio de pago periódico
Este servicio permite al TPP la realización de un inicio de un pago periódico sin informar la cuenta del ordenante “debtorAccount” y proporciona el listado de cuentas durante el flujo SCA para que el PSU seleccione una.
Identificador consumidor APIS
URL del hub donde se publica el servicio
Producto de pago a usar.
{
"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
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.
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
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
{
"default": "http:\/\/www.example.com"
}
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"
{
"default": "http:\/\/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.
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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
Body de la petición
HTTP/1.1 201 Created
Definitions
{
"properties": {
"authenticationType": {
"type": "string"
},
"authenticationVersion": {
"type": "string"
},
"authenticationMethodId": {
"type": "string"
},
"name": {
"type": "string"
},
"explanation": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"iban": {
"properties": [],
"type": "string",
"example": "ES2640000418401234567599",
"description": "IBAN de la cuenta"
},
"bban": {
"properties": [],
"type": "string",
"description": "BBAN de la cuenta, cuando esta no tiene IBAN.",
"example": "20385778983000760236"
},
"pan": {
"properties": [],
"type": "string",
"description": "Primary Account Number de la tarjeta. Puede ser tokenizada por el ASPSP para cumplir los requerimientos de PCI DSS.",
"example": "1234567891234567"
},
"maskedPan": {
"properties": [],
"type": "string",
"description": "Primary Account Number de la tarjeta en forma enmascarda.",
"example": "123456******4567"
},
"msisdn": {
"properties": [],
"type": "string",
"description": "Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado.",
"example": "27821234567"
},
"currency": {
"properties": [],
"type": "string",
"example": "EUR",
"description": "Moneda"
}
}
}
{
"type": "object",
"properties": {
"bic": {
"type": "string",
"description": "Código BIC del ASPSP",
"example": "XXXXXXXXXXX"
},
"name": {
"type": "string",
"description": "Nombre del ASPSP",
"example": "Nombre ASPSP"
},
"apiName": {
"type": "string",
"description": "Nombre del ASPSP usado en el PATH de la petición. Nota: Solo disponible para versión 2 del listado de ASPSPs disponibles.",
"example": "nombreBanco"
}
},
"required": [
"bic"
]
}
{
"type": "object",
"properties": {
"streetName": {
"type": "string",
"description": "Calle",
"example": "Ejemplo de Calle"
},
"buildingNumber": {
"type": "string",
"description": "Numero",
"example": "5"
},
"townName": {
"type": "string",
"description": "Ciudad",
"example": "Cordoba"
},
"postCode": {
"type": "string",
"description": "Codigo Postal",
"example": "14100"
},
"country": {
"type": "string",
"description": "Pais",
"example": "ES"
}
},
"required": [
"country"
]
}
{
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Moneda del importe",
"example": "EUR"
},
"amount": {
"type": "string",
"description": "Cantidad del importe",
"example": "500.00"
}
},
"required": [
"currency",
"amount"
]
}
{
"properties": {
"href": {
"type": "string",
"description": "Contiene un enlace a un recurso",
"example": "\/v1.1\/payments\/sepa-credit-transfers\/asd-1234-jkl"
}
}
}
{
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/Href"
},
"scaOAuth": {
"$ref": "#\/definitions\/Href"
},
"startAuthorisation": {
"$ref": "#\/definitions\/Href"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/Href"
},
"selectAuthenticationMethod": {
"$ref": "#\/definitions\/Href"
},
"self": {
"$ref": "#\/definitions\/Href"
},
"status": {
"$ref": "#\/definitions\/Href"
},
"scaStatus": {
"$ref": "#\/definitions\/Href"
},
"account": {
"$ref": "#\/definitions\/Href"
},
"balances": {
"$ref": "#\/definitions\/Href"
},
"transactions": {
"$ref": "#\/definitions\/Href"
},
"first": {
"$ref": "#\/definitions\/Href"
},
"next": {
"$ref": "#\/definitions\/Href"
},
"previous": {
"$ref": "#\/definitions\/Href"
},
"last": {
"$ref": "#\/definitions\/Href"
},
"download": {
"$ref": "#\/definitions\/Href"
}
}
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Aspsp"
}
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/AuthenticationObject"
}
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/TppMessage"
}
}
{
"allOf": [
{
"$ref": "#\/definitions\/SinglePayment"
},
{
"properties": {
"startDate": {
"type": "string",
"description": "El primer día aplicable de ejecución desde esta fecha es el primer pago",
"x-ibm-languages": {
"description": {
"en": "The first applicable day of execution from this date is the first payment"
}
}
},
"executionRule": {
"type": "string",
"description": "Define el comportamiento cuando las fechas del pago recurrente caen en fin de semana o festivo. Entonces el pago se ejecuta el día laboral anterior o posterior",
"x-ibm-languages": {
"description": {
"en": "Define the behavior when recurring payment dates fall on weekends or holidays. Then the payment is executed the previous or subsequent business day"
}
}
},
"endDate": {
"type": "string",
"description": "El último día aplicable de ejecución. Si no viene se trata de una orden permanente sin fin.",
"x-ibm-languages": {
"description": {
"en": "The last applicable day of execution. If it does not come, it is an endless permanent order."
}
}
},
"frequency": {
"type": "string",
"description": "La frecuencia del pago recurrente resultante de esta orden permanente",
"x-ibm-languages": {
"description": {
"en": "The frequency of recurring payment resulting from this permanent order"
}
}
},
"dayOfExecution": {
"type": "string",
"description": "La fecha se refiere a la zona horaria del ASPSP",
"x-ibm-languages": {
"description": {
"en": "The date refers to the time zone of the ASPSP"
}
}
}
},
"required": [
"frequency",
"startDate"
]
}
]
}
{
"type": "object",
"properties": {
"aspsps": {
"type": "array",
"items": {
"$ref": "#\/definitions\/List_Aspsp"
}
},
"tppMessages": {
"$ref": "#\/definitions\/TppMessage"
}
},
"required": [
"aspsps",
"tppMessages"
]
}
{
"properties": {
"transactionStatus": {
"type": "string",
"description": "Estado de la transaccion",
"x-ibm-languages": {
"description": {
"en": "Transaction Status"
}
},
"example": "RCVD"
},
"paymentId": {
"properties": [],
"type": "string",
"description": "Identificador del recurso que referencia a la iniciación de pago.",
"x-ibm-languages": {
"description": {
"en": "Identifier of the resource that refers to the initiation of payment."
}
},
"example": "1b3ab8e8-0fd5-43d2-946e-d75958b172e7"
},
"transactionFees": {
"properties": [],
"description": "Comisiones asociadas al pago.",
"x-ibm-languages": {
"description": {
"en": "Fees associated with payment."
}
},
"example": "",
"$ref": "#\/definitions\/Amount"
},
"transactionFeeIndicator": {
"properties": [],
"type": "boolean",
"description": "Si es igual a \"true\", la transacción implicará una comisión según el ASPSP o según lo acordado entre ASPSP y PSU. Si es igual a \"false\", la transacción no implicará ninguna comisión adicional para el PSU.",
"x-ibm-languages": {
"description": {
"en": "If it is equal to \"true\", the transaction will involve a commission according to the ASPSP or as agreed between ASPSP and PSU. If it is equal to \"false\", the transaction will not imply any additional commission for the PSU. "
}
},
"example": "\"transactionFeeIndicator\": true"
},
"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": {
"properties": [],
"description": "Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta:",
"x-ibm-languages": {
"description": {
"en": "List of hyperlinks to be recognized by the TPP. Types supported in this answer: "
}
},
"$ref": "#\/definitions\/Links"
},
"psuMessage": {
"properties": [],
"type": "string",
"example": "Informacion para el PSU",
"description": "Texto a mostrar al PSU.",
"x-ibm-languages": {
"description": {
"en": "Text to display to the PSU."
}
}
},
"tppMessages": {
"properties": [],
"$ref": "#\/definitions\/List_TppMessage",
"description": "Mensaje para el TPP",
"x-ibm-languages": {
"description": {
"en": "Message for the TPP"
}
}
}
},
"required": [
"transactionStatus",
"paymentId",
"_links"
],
"additionalProperties": false
}
{
"type": "object",
"properties": {
"instructedAmount": {
"$ref": "#\/definitions\/Amount",
"description": "Información de la transferencia realizada.",
"x-ibm-languages": {
"description": {
"en": "Transfer information made."
}
}
},
"creditorName": {
"type": "string",
"description": "Nombre del beneficiario",
"x-ibm-languages": {
"description": {
"en": "Beneficiary Name"
}
},
"example": "Nombre"
},
"creditorAccount": {
"$ref": "#\/definitions\/AccountReference",
"description": "Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk",
"x-ibm-languages": {
"description": {
"en": "Account of the payer. Note: this field may be optional in some services such as bulk payments."
}
}
},
"creditorAgent": {
"type": "string",
"description": "BIC de la cuenta del beneficiario",
"x-ibm-languages": {
"description": {
"en": "BIC of the beneficiary's account"
}
},
"example": "XXXLESMMXXX"
},
"creditorAddress": {
"$ref": "#\/definitions\/Address",
"description": "Direccion Beneficiario",
"x-ibm-languages": {
"description": {
"en": "Beneficiary Address"
}
}
},
"remittanceInformationUnstructured": {
"type": "string",
"description": "Informacion Adicional",
"x-ibm-languages": {
"description": {
"en": "Additional Information"
}
},
"example": "Informacion adicional"
},
"chargeBearer": {
"type": "string",
"description": "Valores permitidos: Valores permitidos: • DEBT • CRED • SHAR • SLEV",
"x-ibm-languages": {
"description": {
"en": "Allowed values: Allowed values: • DEBT • CRED • SHAR • SLEV"
}
},
"example": "SLEV"
},
"debtorName": {
"type": "string",
"description": "Nombre del ordenante",
"x-ibm-languages": {
"description": {
"en": "Name of payer"
}
}
},
"requestedExecutionDate": {
"type": "string",
"description": "Fecha de ejecución",
"x-ibm-languages": {
"description": {
"en": "Date of execution"
}
}
},
"requestedExecutionTime": {
"type": "string",
"description": "Fecha\/hora de ejecución",
"x-ibm-languages": {
"description": {
"en": "Date\/time of execution"
}
}
}
}
}
{
"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"
}
},
"required": [
"category",
"code"
]
}