--- swagger: "2.0" info: x-ibm-name: procesos-comunes-xs2a-110 title: Procesos comunes a los servicios version: 1.1.0 contact: name: Soporte PSD2 email: psd2.sandbox.soporte@redsys.es description: "" schemes: - https basePath: / consumes: - application/json produces: - application/json securityDefinitions: RedsysClientSecret: type: apiKey description: Clave acceso consumidor APIS in: header name: X-IBM-Client-Secret RedsysClientId: type: apiKey description: Identificador consumidor APIS in: header name: X-IBM-Client-Id security: - RedsysClientId: [] x-ibm-configuration: testable: true enforced: true phase: realized paths: /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/authorisations: post: summary: Endpoint en caso de Inicio del proceso de Autorización explícita para Inicio de Pago description: Endpoint en caso de Inicio del proceso de Autorización explícita para Inicio de Pago operationId: postAutorizacionInicioPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: boolean description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 201 Created headers: Location: type: string description: Contiene el link al recurso generado. X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_AuthorizationInitiationPayment' examples: application/json: scaStatus: received authorisationId: 123auth456 _links: scaRedirect: href: https://hub.example.es/authorize scaStatus: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Inicio del proceso de autorización (explícita) get: summary: Endpoint en caso de obtener sub-recursos de la Autorización para Inicio de Pago description: Endpoint en caso de obtener sub-recursos de la Autorización para Inicio de Pago operationId: getSubRecursosAutorizacionInicioPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago o consentimiento. - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_GetSubResourcesAuthorization' examples: application/json: cancellationIds: - 123auth456 tags: - Obtener sub-recursos de la autorización /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/authorisations/{authorisation-id}: put: summary: Endpoint en caso de actualizacion de datos PSU (seleccionar método SCA) - Autorización de Inicio de Pago description: Endpoint en caso de actualizacion de datos PSU (seleccionar método SCA) - Autorización de Inicio de Pago operationId: putSeleccionarSCAAutorizacionInicioPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path required: true type: string - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: boolean description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - name: Body required: true in: body schema: $ref: '#/definitions/Request_UpdatePSUData' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_UpdatePSUData' examples: application/json: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Actualizar datos del PSU (seleccionar método SCA) get: summary: Endpoint en caso de obtener el Estado SCA para Autorización de Inicio de Pago description: Endpoint en caso de obtener el Estado SCA para Autorización de Inicio de Pago operationId: getEstadoSCAAutorizacionInicioPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path required: true type: string description: Identificador del subrecurso asociado al inicio de pago o consentimiento. - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_GetSCAStatus' examples: application/json: scaStatus: ' finalised' tags: - Obtener estado SCA /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations: post: summary: Endpoint en caso de Inicio del proceso de Autorización explícita para Cancelación de Pago description: Endpoint en caso de Inicio del proceso de Autorización explícita para Cancelación de Pago operationId: postAutorizacionCancelacionPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: boolean description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 201 Created headers: Location: type: string description: Contiene el link al recurso generado. X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_AuthorizationInitiationPayment' examples: application/json: scaStatus: received authorisationId: 123auth456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Inicio del proceso de autorización (explícita) get: summary: Endpoint en caso de obtener sub-recursos de la Autorización para Cancelación de Pago description: Endpoint en caso de obtener sub-recursos de la Autorización para Cancelación de Pago operationId: getSubRecursosAutorizacionCancelacionPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago o consentimiento. - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_GetSubResourcesAuthorization' examples: application/json: cancellationIds: - 123auth456 tags: - Obtener sub-recursos de la autorización ? /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations/{authorisation-id} : put: summary: Endpoint en caso de actualizacion de datos PSU (seleccionar método SCA) - Autorización de Cancelación de Pago description: Endpoint en caso de actualizacion de datos PSU (seleccionar método SCA) - Autorización de Cancelación de Pago operationId: putSeleccionarSCAAutorizacionCancelaciónPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path required: true type: string - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: boolean description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_AuthorizationInitiationPayment' examples: application/json: scaStatus: received authorisationId: 123auth456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Actualizar datos del PSU (seleccionar método SCA) get: summary: Endpoint en caso de obtener el Estado SCA para Autorización de Cancelación de Pago description: Endpoint en caso de obtener el Estado SCA para Autorización de Cancelación de Pago operationId: getEstadoSCAAutorizacionCancelacionPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path required: true type: string - name: payment-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago o consentimiento. - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_GetSCAStatus' examples: application/json: cancellationIds: - 123auth456 tags: - Obtener estado SCA /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}/authorisations: post: summary: Endpoint en caso de Inicio del proceso de Autorización explícita para Consentimientos FCS description: Endpoint en caso de Inicio del proceso de Autorización explícita para Consentimientos FCS operationId: postAutorizacionConsentimientosFCS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string - name: consent-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: PSU-ID in: header required: false type: string description: Identificador que el PSU utiliza para identificarse en su ASPSP. Puede ser informado incluso si se está usando un token de OAuth y, en tal caso, el ASPSP podría comprobar que el PSU-ID y el token se corresponden. x-ibm-languages: description: en: 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. - name: PSU-ID-Type in: header required: false type: string description: Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. x-ibm-languages: description: en: PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. - name: PSU-Corporate-ID in: header required: false type: string description: Identificador de "empresa" en los Canales Online. x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header required: false type: string description: Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. x-ibm-languages: description: en: Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: boolean description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 201 Created headers: Location: type: string description: Contiene el link al recurso generado. X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_AuthorizationInitiationPayment' examples: application/json: scaStatus: received authorisationId: 123auth456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Inicio del proceso de autorización (explícita) get: summary: Endpoint en caso de obtener sub-recursos de la Autorización para Consentimientos FCS description: Endpoint en caso de obtener sub-recursos de la Autorización para Consentimientos FCS operationId: getSubRecursosAutorizacionConsentimientosFCS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) - name: consent-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago o consentimiento. - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_GetSubResourcesAuthorization' examples: application/json: cancellationIds: - 123auth456 tags: - Obtener sub-recursos de la autorización /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}/authorisations/{authorisation-id}: put: summary: Endpoint en caso de actualizacion de datos PSU (seleccionar método SCA) - Autorización de Consentimientos FCS description: Endpoint en caso de actualizacion de datos PSU (seleccionar método SCA) - Autorización de Consentimientos FCS operationId: putSeleccionarSCAAutorizacionConsentimientosFCS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: authorisation-id in: path required: true type: string description: Identificador del subrecurso asociado al ID de autorización - name: consent-id in: path required: true type: string description: Identificador asociado al ID de consentimiento, creado previamente - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - name: Body required: true in: body schema: $ref: '#/definitions/Request_UpdatePSUData' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_UpdatePSUData' examples: application/json: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Actualizar datos del PSU (seleccionar método SCA) get: summary: Endpoint en caso de obtener el Estado SCA para Autorización de Consentimientos FCS description: Endpoint en caso de obtener el Estado SCA para Autorización de Consentimientos FCS operationId: getEstadoSCAAutorizacionConsentimientosFCS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: authorisation-id in: path required: true type: string description: Identificador del subrecurso asociado al ID de autorización - name: consent-id in: path required: true type: string description: Identificador asociado al ID de consentimiento, creado previamente - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_GetSCAStatus' examples: application/json: scaStatus: ' finalised' tags: - Obtener estado SCA /api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}/authorisations: post: summary: Endpoint en caso de Inicio del proceso de Autorización explícita para Consentimientos AIS description: Endpoint en caso de Inicio del proceso de Autorización explícita para Consentimientos AIS operationId: postAutorizacionConsentimientosAIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string - name: consent-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: PSU-ID in: header required: false type: string description: Identificador que el PSU utiliza para identificarse en su ASPSP. Puede ser informado incluso si se está usando un token de OAuth y, en tal caso, el ASPSP podría comprobar que el PSU-ID y el token se corresponden. x-ibm-languages: description: en: 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. - name: PSU-ID-Type in: header required: false type: string description: Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. x-ibm-languages: description: en: PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. - name: PSU-Corporate-ID in: header required: false type: string description: Identificador de "empresa" en los Canales Online. x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header required: false type: string description: Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. x-ibm-languages: description: en: Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: boolean description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 201 Created headers: Location: type: string description: Contiene el link al recurso generado. X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_AuthorizationInitiationPayment' examples: application/json: scaStatus: received authorisationId: 123auth456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Inicio del proceso de autorización (explícita) get: summary: Endpoint en caso de obtener sub-recursos de la Autorización para Consentimientos AIS description: Endpoint en caso de obtener sub-recursos de la Autorización para Consentimientos AIS operationId: getSubRecursosAutorizacionConsentimientosAIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) - name: consent-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago o consentimiento. - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_GetSubResourcesAuthorization' examples: application/json: cancellationIds: - 123auth456 tags: - Obtener sub-recursos de la autorización /api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}/authorisations/{authorisation-id}: put: summary: Endpoint en caso de actualizacion de datos PSU (seleccionar método SCA) - Autorización de Consentimientos AIS description: Endpoint en caso de actualizacion de datos PSU (seleccionar método SCA) - Autorización de Consentimientos AIS operationId: putSeleccionarSCAAutorizacionConsentimientosAIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: authorisation-id in: path required: true type: string description: Identificador del subrecurso asociado al ID de autorización - name: consent-id in: path required: true type: string description: Identificador asociado al ID de consentimiento, creado previamente - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - name: Body required: true in: body schema: $ref: '#/definitions/Request_UpdatePSUData' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_UpdatePSUData' examples: application/json: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Actualizar datos del PSU (seleccionar método SCA) get: summary: Endpoint en caso de obtener el Estado SCA para Autorización de Consentimientos AIS description: Endpoint en caso de obtener el Estado SCA para Autorización de Consentimientos AIS operationId: getEstadoSCAAutorizacionConsentimientosAIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) enum: - redsys - 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 - name: authorisation-id in: path required: true type: string description: Identificador del subrecurso asociado al ID de autorización - name: consent-id in: path required: true type: string description: Identificador asociado al ID de consentimiento, creado previamente - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: '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' - name: PSU-IP-Address in: header required: true type: string description: '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' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: '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) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: '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' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: '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' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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" - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_GetSCAStatus' examples: application/json: scaStatus: ' finalised' tags: - Obtener estado SCA definitions: Amount: required: - amount - currency type: object properties: currency: type: string example: EUR amount: type: string example: "150.03" AuthenticationObject: properties: authenticationType: type: string description: Tipo del método de autenticación. Ver anexo 6.6 Tipos de autenticación para más información. enum: - SMS_OTP - CHIP_OTP - PHOTO_OTP - PUSH_OTP authenticationVersion: properties: [] type: string description: Versión de la herramienta asociada al authenticationType. authenticationMethodId: properties: [] type: string description: Id del método de autenticación proporcionado por el ASPSP. name: properties: [] type: string description: Nombre del método de autenticación definido por el PSU en la banca online del ASPSP. explanation: type: string description: Información detallada acerca del método SCA para el PSU required: - authenticationType - authenticationMethodId - name additionalProperties: false List_TppMessage: type: array items: $ref: '#/definitions/TppMessage' List_AuthenticationObject: type: array items: $ref: '#/definitions/AuthenticationObject' Href: required: - href properties: href: type: string description: Contiene un enlace a un recurso example: /v1.1/payments/sepa-credit-transfers/asd-1234-jkl Links: 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 Request_UpdatePSUData: properties: authenticationMethodId: type: string description: Identificador del método de autenticación required: - authenticationMethodId additionalProperties: false Response_GetSubResourcesAuthorization: properties: authorisationIds: type: array items: type: string description: Array de authorisationIds. psuMessage: properties: [] type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. tppMessages: properties: [] $ref: '#/definitions/List_TppMessage' description: Mensaje para el TPP items: type: string additionalProperties: false Response_AuthorizationInitiationPayment: properties: transactionFees: type: object description: Podría ser usado por el ASPSP para transportar la comisión total de la transacción. Este campo incluye el currencyConversiónFees, si es de aplicación. additionalProperties: $ref: '#/definitions/Amount' currencyConversionFee: type: object description: Podría ser usado por el ASPSP para transportar comisiones por conversión específica de la moneda asociada a la transferencia de crédito iniciada. additionalProperties: $ref: '#/definitions/Amount' estimatedTotalAmount: type: object description: Importe el cual se estima que será retirado de la cuenta del ordenante. Este importe incluye comisiones. additionalProperties: $ref: '#/definitions/Amount' estimatedInterbankSettlementAmount: type: object description: Importe estimado a ser transferido al beneficiario. additionalProperties: $ref: '#/definitions/Amount' scaStatus: type: string description: Estado SCA authorisationId: properties: [] type: string description: Identificador del recurso que referencia al sub-recurso de autorización creado scaMethods: properties: [] 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 "selectAuthenticationM ethod”. Estos métodos deberán ser presentados al PSU. Nota: Solo si ASPSP soporta selección del método SCA' $ref: '#/definitions/List_AuthenticationObject' _links: properties: [] description: 'Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta: scaRedirect: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el TPP. selectAuthenticatio nMethod: link al sub-recurso de autorización o de autorización de cancelación donde el método SCA seleccionado será informado. • scaStatus: link para consultar el estado SCA correspondiente al sub-recurso de autorización.' $ref: '#/definitions/Links' psuMessage: properties: [] type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. tppMessages: properties: [] description: Mensaje para el TPP enviado a través del HUB. $ref: '#/definitions/List_TppMessage' additionalProperties: false required: - scaStatus - authorisationId - _links Response_UpdatePSUData: properties: transactionFees: properties: [] description: Podría ser usado por el ASPSP para transportar la comisión total de la transacción. Este campo incluye el currencyConversiónFees, si es de aplicación. x-ibm-languages: description: en: It could be used by the ASPSP to carry the total commission of the transaction. This field includes the currencyConversionFees, if applicable. example: "" $ref: '#/definitions/Amount' currencyCoversionFees: properties: [] description: Podría ser usado por el ASPSP para transportar comisiones por conversión específica de la moneda asociada a la transferencia de crédito iniciada. x-ibm-languages: description: en: It could be used by the ASPSP to carry currency-specific conversion fees associated with the initiated credit transfer. example: "" $ref: '#/definitions/Amount' estimatedTotalAmount: properties: [] description: 'Importe el cual se estima que será retirado de la cuenta del ordenante. Nota: este importe incluye comisiones.' x-ibm-languages: description: en: 'Amount which is estimated to be withdrawn from the payer account. Note: this amount includes commissions.' example: "" $ref: '#/definitions/Amount' estimatedInterbankSettlementAmount: properties: [] description: Importe estimado a ser transferido al beneficiario. x-ibm-languages: description: en: Estimated amount to be transferred to the beneficiary. example: "" $ref: '#/definitions/Amount' transactionFeeIndicator: 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" o no es usado, la transacción no implicará ninguna comisión adicional para el PSU. Si este elemento no es usado, entonces no hay información acerca de comisiones de la transacción, a no ser que el importe de la comisión venga explícitamente en el campo transactionFees y/o currencyConversionFees. x-ibm-languages: description: en: If equal to "true", the transaction will involve a fee as per ASPSP or as agreed between ASPSP and PSU. If it is set to "false" or is not used, the transaction will not involve any additional commission for the PSU. If this element is not used, then there is no information about transaction fees, unless the fee amount comes explicitly in the transactionFees and/or currencyConversionFees field. _links: $ref: '#/definitions/Links' 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 TPP. • 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.' scaStatus: properties: [] type: string description: Estado SCA psuMessage: properties: [] type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. tppMessages: properties: [] $ref: '#/definitions/List_TppMessage' description: Mensaje para el TPP required: - _links - scaStatus additionalProperties: false Response_GetSCAStatus: properties: scaStatus: properties: [] type: string description: Estado SCA trustedBeneficiaryFlag: type: boolean description: Con este flag el ASPSP opcionalmente podría comunicar al TPP que el creditor formaba parte del listado de beneficiarios de confianza. Este atributo solo se contiene en caso de un estado final del scaStatus. psuMessage: properties: [] type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. tppMessages: properties: [] $ref: '#/definitions/List_TppMessage' description: Mensaje para el TPP required: - scaStatus TppMessage: properties: category: type: string description: 'Categoría del tipo de mensaje recibido. Posibles valores: ERROR o WARNING' example: ERROR code: properties: [] type: string description: Código de respuesta. example: CONSENT_INVALID path: properties: [] type: string description: Path al campo referenciando el error. text: properties: [] type: string description: Texto adicional explicativo. example: Ejemplo additionalProperties: false required: - code - category x-ibm-endpoints: - endpointUrl: https://apis-i.redsys.es:20443/psd2/xs2a description: Endpoint entorno Integracion type: - production - development ...