openapi: 3.0.1 info: title: API para PSD2 description: API de Redsys para PSD2 version: '1.1' servers: - url: /api-entrada-xs2a tags: - name: PSD2 description: Endpoints disponibles para HUB PSD2 paths: /api-entrada-xs2a/services/{aspsp}/v1.1/consents: post: tags: - Consentimiento de información sobre cuentas de pago (AIS) summary: Solicitud de consentimiento AIS description: >- Con este servicio, un TPP a través del HUB puede solicitar un consentimiento para acceder a las cuentas del PSU. Esta solicitud puede ser sobre unas cuentas indicadas o no. operationId: postConsents parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: PSU-ID in: header 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. schema: type: string 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. 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 description: >- Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. schema: type: string x-ibm-languages: description: en: >- PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. 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 description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: Company" identifier in the Online Channels. x-ibm-languages: description: en: Company" identifier in the Online Channels. - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string default: www.example.com x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string default: www.exampleNOK.com x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: TPP-Brand-Logging-Information in: header description: >- Este campo podría ser usado por el TPP para informar al ASPSP acerca de la marca (Brand) usada por el TPP de cara al PSU. Esta información puede ser usada para mejorar la comunicación entre el ASPSP y el PSU o el ASPSP y el TPP. schema: type: string x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA requestBody: description: >- Accesos solicitados a los servicios. Solo los sub atributos con tags “accounts”, “balances” y “transactions” son aceptados. Adicionalmente el ASPSP puede soportar los sub atributos "availableAccounts" o "allPsd2" con valor “all-accounts”. content: '*/*': schema: $ref: '#/components/schemas/Request_GetConsent' required: true x-ibm-languages: description: en: >- Access requested to services. Only sub attributes with tags "accounts", "balances" and "transactions" are accepted. Additionally, the ASPSP can support the "availableAccounts" or "allPsd2" sub attributes with the value "all-accounts". responses: default: description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT Location: description: Contiene el link al recurso generado. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_GetConsent' x-ibm-languages: summary: en: Request for AIS consent description: en: >- With this service, a TPP through the HUB can request a consent to access the PSU accounts. This request can be about indicated accounts or not. x-codegen-request-body-name: body /api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}/status: get: tags: - Obtener estado de consentimiento summary: Estado de consentimiento AIS description: >- Este servicio permite al TPP conocer el estado de una solicitud de consentimiento iniciada previamente. operationId: getConsentStatus parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: string x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string default: www.example.com x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string default: www.exampleNOK.com x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header description: >- Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea, sin cabeceras ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA required: true schema: type: string default: TestTPPCertificate x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la petición asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_StatusConsent' x-ibm-languages: summary: en: AIS Consent Status description: en: >- This service allows the TPP to know the status of a previously initiated consent request. /api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}: get: tags: - Recuperar información de consentimiento summary: Recuperar información de consentimiento AIS description: >- Este servicio permite al TPP conocer el estado de una solicitud de consentimiento iniciada previamente. operationId: getConsentIdDetails parameters: - name: consent-id in: path required: true schema: type: string - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string default: www.example.com x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string default: www.example.com x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la petición asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_GetInfoConsent' x-ibm-languages: summary: en: Retrieve AIS consent information description: en: >- This service allows the TPP to know the status of a previously initiated consent request. delete: tags: - Eliminar consentimiento summary: Eliminar consentimiento AIS description: Este servicio permite al TPP eliminar una solicitud de consentimiento operationId: deleteConsentId parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: DELETE x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: string x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string default: www.example.com x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string default: www.exampleNOK.com x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 204 Ok headers: X-Request-ID: description: Identificador único de la petición asignado por el TPP. schema: type: string content: {} x-ibm-languages: description: en: This service allows the TPP to eliminate a request for consent summary: en: Remove AIS consent /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds: post: tags: - Consentimiento de confirmación de fondos (FCS) summary: Solicitud de consentimiento FCS description: >- Con este servicio, un TPP a través del HUB puede solicitar un consentimiento para acceder a las cuentas del PSU. Esta solicitud puede ser sobre unas cuentas indicadas o no. operationId: postConsentsConfirmationOfFunds parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: PSU-ID in: header 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. schema: type: string 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. 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 description: >- Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. schema: type: string x-ibm-languages: description: en: >- PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. 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 description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: Company" identifier in the Online Channels. x-ibm-languages: description: en: Company" identifier in the Online Channels. - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string default: www.example.com x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string default: www.exampleNOK.com x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: TPP-Brand-Logging-Information in: header description: >- Este campo podría ser usado por el TPP para informar al ASPSP acerca de la marca (Brand) usada por el TPP de cara al PSU. Esta información puede ser usada para mejorar la comunicación entre el ASPSP y el PSU o el ASPSP y el TPP. schema: type: string x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA requestBody: description: Cuerpo del mensaje content: '*/*': schema: $ref: '#/components/schemas/Request_PostConsentFundsConfirmation' required: true x-ibm-languages: description: en: Message body responses: '201': description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT Location: description: Contiene el link al recurso generado. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_PostConsentFundsConfirmation' x-ibm-languages: summary: en: FCS Consent request description: en: >- With this service, a TPP through the HUB can request a consent to access the PSU accounts. This request can be about indicated accounts or not. x-codegen-request-body-name: Body /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}/status: get: tags: - Obtener estado de consentimiento summary: Estado de consentimiento FCS description: >- Este servicio permite al TPP, a través del Hub, conocer el estado en el que se encuentra un recurso de consentimiento de confirmación de fondos en el ASPSP. operationId: getConsentsConfirmationOfFunds parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path description: Consent-id de la peticion required: true schema: type: string x-ibm-languages: description: en: Consent-id of the request x-ibm-languages: description: en: Consent-id of the request - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: string x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string default: www.example.com x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string default: www.example.com x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '201': description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la petición asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_StatusConsent' x-ibm-languages: summary: en: Status of the fund confirmation consent description: en: >- This service allows the TPP, through the Hub, to know the status in which a resource for confirming funds is in the ASPSP. /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}: get: tags: - Recuperar información de consentimiento summary: Recuperar información de consentimiento FCS description: >- Este servicio permite al TPP, a través del Hub, conocer el estado en el que se encuentra un recurso de consentimiento de confirmación de fondos en el ASPSP. operationId: getConsentsConfirmationOfFundsInfo parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path description: Consent-id de la peticion required: true schema: type: string x-ibm-languages: description: en: Consent-id of the request x-ibm-languages: description: en: Consent-id of the request - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: string x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string default: www.example.com x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string default: www.example.com x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '201': description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la petición asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_PostConsentFundsConfirmation' x-ibm-languages: summary: en: Retrieve FCS consent information description: en: >- This service allows the TPP, through the Hub, to know the status in which a resource for confirming funds is in the ASPSP. delete: tags: - Eliminar consentimiento summary: Eliminar consentimiento FCS description: >- Este servicio permite al TPP, a través del Hub, conocer el estado en el que se encuentra un recurso de consentimiento de confirmación de fondos en el ASPSP. operationId: deleteConsentsConfirmationOfFunds parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path description: Consent-id de la peticion required: true schema: type: string x-ibm-languages: description: en: Consent-id of the request x-ibm-languages: description: en: Consent-id of the request - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: string x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string default: www.example.com x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string default: www.example.com x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '204': description: HTTP/1.1 204 Ok content: {} x-ibm-languages: summary: en: Delete FCS consent description: en: >- This service allows the TPP, through the Hub, to know the status in which a resource for confirming funds is in the ASPSP. /api-entrada-xs2a/services/{aspsp}/v1.1/accounts: get: tags: - Lectura de listado de cuentas summary: Lectura de listado de cuentas description: >- Este servicio permite obtener un listado de cuentas del PSU, incluyendo los balances de las cuentas si ha sido requerido. Como requisito, se asume que el PSU ha dado su consentimiento para este acceso y ha sido almacenado por el ASPSP. El funcionamiento del servicio según el tipo de acceso indicado en el consentimiento. operationId: getAccountListv11 parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: withBalance in: query description: >- Si está incluido, esta función incluye los balances. Esta petición será rechazada si el acceso a balances no lo recoge el consentimiento o el ASPSP no soporta este parámetro. schema: type: boolean default: false x-ibm-languages: description: en: >- If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. x-ibm-languages: description: en: >- If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Consent-ID in: header description: >- Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321 required: true schema: type: string default: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-Accept-Encoding in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string default: TestTPPCertificate x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_AccountsList' application/json: example: accounts: - resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e80f iban: ES1111111111111111111111 currency: EUR product: Girokonto cashAccountType: CACC name: Main Account _links: balances: href: >- /v1.1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances transactions: href: >- /v1.1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions - resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e81g iban: ES2222222222222222222222 currency: USD cashAccountType: CACC name: US Dollar Account _links: balances: href: >- /v1.1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances x-ibm-languages: description: en: HTTP/1.1 200 Ok x-ibm-languages: summary: en: Obtaining list of accounts description: en: >- This service allows you to obtain a list of PSU accounts, including account balances if required. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. The operation of the service according to the type of access indicated in the consent. /api-entrada-xs2a/services/{aspsp}/v1.1/accounts/{account-id}: get: tags: - Lectura de detalles de cuenta summary: Lectura de detalles de una cuenta description: >- Este servicio permite leer los detalles de una cuenta con los balances si son requeridos.Como requisito, se asume que el PSU ha dado su consentimiento para este acceso y ha sido almacenado por el ASPSP. El funcionamiento del servicio según el tipo de acceso indicado en el consentimiento. operationId: getAccountIdv11 parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: account-id in: path required: true schema: type: string - name: withBalance in: query description: >- Si está incluido, esta función incluye los balances. Esta petición será rechazada si el acceso a balances no lo recoge el consentimiento o el ASPSP no soporta este parámetro. schema: type: boolean default: false x-ibm-languages: description: en: >- If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. x-ibm-languages: description: en: >- If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Consent-ID in: header description: >- Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321 required: true schema: type: string default: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-Accept-Encoding in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string default: TestTPPCertificate x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_AccountDetail' application/json: example: account: resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e80f iban: ES1111111111111111111111 currency: EUR ownerName: Heike Mustermann product: Girokonto cashAccountType: CACC name: Main Account _links: balances: href: >- /v1.1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances transactions: href: >- /v1.1/accounts/3dc3d5b3-7023-4848-9853--5400a64e80f/transactions x-ibm-languages: description: en: HTTP/1.1 200 Ok x-ibm-languages: summary: en: Reading account detail description: en: >- This service allows you to read the details of an account with the balances if required. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. The operation of the service according to the type of access indicated in the consent. /api-entrada-xs2a/services/{aspsp}/v1.1/accounts/{account-id}/transactions: get: tags: - Lectura de transacciones summary: Lectura de transacciones de una cuenta description: >- Este servicio permite obtener las transacciones de una cuenta determinada por su identificador. Este servicio permite obtener los balances de una cuenta determinada por su identificador. Como requisito, se asume que el PSU ha dado su consentimiento para este acceso y ha sido almacenado por el ASPSP. operationId: accountsTrasactions parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: account-id in: path description: Id de la cuenta required: true schema: type: string x-ibm-languages: description: en: Account id x-ibm-languages: description: en: Account id - name: dateFrom in: query description: >- Fecha de inicio de consulta. Es incluido si no es requerido un acceso delta. schema: type: string x-ibm-languages: description: en: >- Query start date. It is included if delta access is not required. x-ibm-languages: description: en: >- Query start date. It is included if delta access is not required. - name: dateTo in: query description: >- Fecha de fin de consulta. Su valor por defecto es la facha actual si no es dado. Ej: 2017-11-05 schema: type: string x-ibm-languages: description: en: >- Date of end of consultation. Its default value is the current façade if it is not given. Ex: 2017-11-05 x-ibm-languages: description: en: >- Date of end of consultation. Its default value is the current façade if it is not given. Ex: 2017-11-05 - name: entryReferenceFrom in: query description: >- Al ser indicado, nos daría los resultados desde la llamada con transactionId anterior al dado. Alternativo a dateFrom y dateTo schema: type: string x-ibm-languages: description: en: >- If indicated, it would give us the results from the call with transactionId before the given one. Alternative to dateFrom and dateTo x-ibm-languages: description: en: >- If indicated, it would give us the results from the call with transactionId before the given one. Alternative to dateFrom and dateTo - name: bookingStatus in: query description: >- Estados de las transacciones devueltas. Los codigos de estado permitidos son “booked”, “pending”, "information" y “both”. Los obligatorios para los ASPSPs son “booked”. required: true schema: type: string x-ibm-languages: description: en: >- States of returned transactions. The allowed status codes are "booked", "pending", "information" and "both". Mandatory for ASPSPs are "booked." x-ibm-languages: description: en: >- States of returned transactions. The allowed status codes are "booked", "pending", "information" and "both". Mandatory for ASPSPs are "booked." - name: deltaList in: query description: >- Indica que el AISP está a favor de obtener todas las transacciones después del último acceso de informe para esta PSU y cuenta. Este indicador podría ser rechazado por el ASPSP si esta función no es compatible. schema: type: boolean x-ibm-languages: description: en: >- Indicates that the AISP is in favor of obtaining all transactions after the last report access for this PSU and account. This indicator could be rejected by the ASPSP if this function is not supported. x-ibm-languages: description: en: >- Indicates that the AISP is in favor of obtaining all transactions after the last report access for this PSU and account. This indicator could be rejected by the ASPSP if this function is not supported. - name: withBalance in: query description: >- Si está incluido, esta función incluye los balances. Esta petición será rechazada si el acceso a balances no lo recoge el consentimiento o el ASPSP no soporta este parámetro. schema: type: boolean default: false x-ibm-languages: description: en: >- If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. x-ibm-languages: description: en: >- If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Consent-ID in: header description: >- Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321 required: true schema: type: string default: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-Accept-Encoding in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string default: TestTPPCertificate x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la transacción asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_AccountTransactions' x-ibm-languages: summary: en: Get the transactions of an account description: en: >- This service allows to obtain the transactions of an account determined by its identifier. This service allows to obtain the balances of an account determined by its identifier. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. /api-entrada-xs2a/services/{aspsp}/v1.1/accounts/{account-id}/balances: get: tags: - Lectura de balances summary: Lectura de balances de una cuenta description: >- Este servicio permite obtener los balances de una cuenta determinada por su identificador. Como requisito, se asume que el PSU ha dado su consentimiento para este acceso y ha sido almacenado por el ASPSP. operationId: getAccountBalances parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: account-id in: path description: Id de la cuenta required: true schema: type: string x-ibm-languages: description: en: Account id x-ibm-languages: description: en: Account id - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Consent-ID in: header description: >- Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321 required: true schema: type: string default: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-Accept-Encoding in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string default: TestTPPCertificate x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la transacción asignado por el TPP schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_AccountBalances' application/json: example: account: iban: ES1111111111111111111111 balances: - balanceType: closingBooked balanceAmount: currency: EUR amount: '500.00' referenceDate: 2017-10-25T00:00:00.000Z - balanceType: expected balanceAmount: currency: EUR amount: '900.00' lastChangeDateTime: 2017-10-25T15:30:35.035Z x-ibm-languages: summary: en: Payment balance information description: en: >- This service allows to obtain the balances of an account determined by its identifier. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. /api-entrada-xs2a/services/{aspsp}/v1.1/trusted-beneficiaries: get: tags: - Obtener listado de beneficiarios de confianza summary: Obtener listado de beneficiarios de confianza description: >- Obtiene el listado de los beneficiarios de confianza del PSU, el cual ha dado un consentimiento explícito. operationId: getTrustedBeneficiaries parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: account-id in: query description: >- Referencia a la cuenta específica del PSU sobre la que recuperar el listado de beneficiarios de confianza. Solo si es soportado por el ASPSP schema: type: string default: 'false' x-ibm-languages: description: en: >- Reference to the specific PSU account on which to retrieve the trusted beneficiary listing. Only if supported by the ASPSP. x-ibm-languages: description: en: >- Reference to the specific PSU account on which to retrieve the trusted beneficiary listing. Only if supported by the ASPSP. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Consent-ID in: header description: >- Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321 required: true schema: type: string default: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 x-ibm-languages: description: en: >- Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321 - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-Accept-Encoding in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string default: TestTPPCertificate x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 200 OK headers: X-Request-ID: description: Identificador único de la transacción asignado por el TPP schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_TrustedBeneficiary' x-ibm-languages: description: en: HTTP/1.1 200 OK x-ibm-languages: summary: en: Obtain list of trusted beneficiaries description: en: >- Obtains the list of trusted beneficiaries of the PSU, who have given explicit consent. /api-entrada-xs2a/services/{aspsp}/v1.1/funds-confirmations: post: tags: - Consulta de fondos summary: Consulta de fondos description: >- Este tipo de mensaje es utilizado en el servicio de consulta de fondos. El HUB consulta al ASPSP por la disponibilidad de fondos para una cantidad dada. El HUB se comunica con el ASPSP para preguntar si tiene fondos y, tras consultarlo, devuelve la respuesta al TPP. operationId: fundsConfirmation parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: X-Request-ID in: header description: >- Identificador único para la petición dado por el TPP. Relaciona la petición HTTP entre TPP y HUB. Ejemplo: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier for the request given by the TPP. Match the HTTP request between TPP and HUB. Example: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier for the request given by the TPP. Match the HTTP request between TPP and HUB. Example: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: Firma de la peticion por el TPP. required: true schema: type: string x-ibm-languages: description: en: Signature of the petition by the TPP. x-ibm-languages: description: en: Signature of the petition by the TPP. - name: TPP-Signature-Certificate in: header description: Certificado firmado required: true schema: type: string x-ibm-languages: description: en: Certificate signed x-ibm-languages: description: en: Certificate signed - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre OAuth2. Solo si se ha realizado la gestión del consentimiento a través del API. required: true schema: type: string x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on OAuth2. Only if consent management has been done through the API. x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on OAuth2. Only if consent management has been done through the API. - name: Consent-ID in: header description: >- Identificador del consentimiento obtenido en la transacción de solicitar consentimiento. Solo si se ha realizado la gestión del consentimiento a través del API. required: true schema: type: string x-ibm-languages: description: en: >- Identifier of the consent obtained in the transaction to request consent. Only if consent management has been done through the API. x-ibm-languages: description: en: >- Identifier of the consent obtained in the transaction to request consent. Only if consent management has been done through the API. requestBody: content: '*/*': schema: $ref: '#/components/schemas/Request_fundsConfirmation' required: true responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: >- Identificador único para la petición dado por el TPP. Relaciona la petición HTTP entre TPP y HUB. Ejemplo: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 schema: type: string x-ibm-languages: description: en: >- Unique identifier for the request given by the TPP. Match the HTTP request between TPP and HUB. Example: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 content: '*/*': schema: $ref: '#/components/schemas/Response_fundsConfirmation' application/json: example: fundsAvailable: true x-ibm-languages: summary: en: Funds Confirmation - Funds Confirmation description: en: >- This type of message is used in the fund consultation service. The HUB consults the ASPSP for the availability of funds for a given amount. The HUB communicates with the ASPSP to ask if it has funds and, after consultation, returns the response to the TPP. x-codegen-request-body-name: body /api-entrada-xs2a/services/{asp-name}/v1.1/multibanco/catalogue/{multibanco-payment-type}: get: tags: - Servicios multibanco summary: >- Petición iniciada por el TPP para obtener el catálogo de pagos MULTIBANCO description: >- Petición iniciada por el TPP para obtener el catálogo de pagos MULTIBANCO. operationId: getMultibancoCatalogue parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: multibanco-payment-type in: path description: Tipo de pago multibanco required: true schema: type: string x-ibm-languages: description: en: Multibank payment type x-ibm-languages: description: en: Multibank payment type - name: paymentReference in: query description: Referencia de la operación schema: type: string x-ibm-languages: description: en: Operation reference x-ibm-languages: description: en: Operation reference - name: instructedAmount in: query description: Importe de pago schema: type: string x-ibm-languages: description: en: Payment amount x-ibm-languages: description: en: Payment amount - name: requestedExecutionDate in: query description: Fecha de la ejecución del pago schema: type: string x-ibm-languages: description: en: Payment execution date x-ibm-languages: description: en: Payment execution date - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '200': description: '' content: '*/*': schema: $ref: '#/components/schemas/ResponseGetMultibankCatalogue' x-ibm-languages: description: en: '' x-ibm-languages: summary: en: >- Request initiated by the TPP to obtain the MULTIBANCO payment catalog description: en: >- Request initiated by the TPP to obtain the MULTIBANCO payment catalog. /api-entrada-xs2a/services/{asp-name}/v1.1/multibanco/social-security/withholding: post: tags: - Servicios multibanco summary: >- Mensaje enviado por el TPP al ASPSP a través del Hub para conocer el valor del importe a pagar en la seguridad social description: >- Mensaje enviado por el TPP al ASPSP a través del Hub para conocer el valor del importe a pagar en la seguridad social. parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: Content-Type in: header description: application/json required: true schema: type: string x-ibm-languages: description: en: application / json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-ID in: header description: 'Identificador que el PSU utiliza para identificarse en su ASPSP. ' schema: type: string x-ibm-languages: description: en: 'Identifier that the PSU uses to identify itself in its ASPSP. ' x-ibm-languages: description: en: 'Identifier that the PSU uses to identify itself in its ASPSP. ' - name: PSU-ID-Type in: header description: >- Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. schema: type: string x-ibm-languages: description: en: >- Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. x-ibm-languages: description: en: >- Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. - name: PSU-Corporate-ID in: header description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: Identifier of "company" in the Online Channels. x-ibm-languages: description: en: Identifier of "company" in the Online Channels. - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestSocialSecurityWithholding' required: true responses: '200': description: Respuesta a la operación content: application/json: schema: $ref: '#/components/schemas/ResponseSocialSecurityWithholding' x-ibm-languages: description: en: Operation response x-ibm-languages: summary: en: >- Message sent by the TPP to the ASPSP through the Hub to know the value of the amount to be paid in social security description: en: >- Message sent by the TPP to the ASPSP through the Hub to know the value of the amount to be paid in social security. x-codegen-request-body-name: Body /api-entrada-xs2a/services/{asp-name}/v1.1/multibanco/payments/{multibanco-payment-type}: post: tags: - Servicios multibanco summary: >- Mensaje enviado por el TPP al ASPSP a través del Hub para crear un inicio de pago MULTIBANCO description: >- Mensaje enviado por el TPP al ASPSP a través del Hub para crear un inicio de pago MULTIBANCO parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: multibanco-payment-type in: path description: Tipo de pago multibanco required: true schema: type: string x-ibm-languages: description: en: Multibank payment type x-ibm-languages: description: en: Multibank payment type - name: Content-Type in: header description: application/json required: true schema: type: string x-ibm-languages: description: en: application / json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-ID in: header description: 'Identificador que el PSU utiliza para identificarse en su ASPSP. ' schema: type: string x-ibm-languages: description: en: 'Identifier that the PSU uses to identify itself in its ASPSP. ' x-ibm-languages: description: en: 'Identifier that the PSU uses to identify itself in its ASPSP. ' - name: PSU-ID-Type in: header description: >- Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. schema: type: string x-ibm-languages: description: en: >- Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. x-ibm-languages: description: en: >- Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. - name: PSU-Corporate-ID in: header description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: Identifier of "company" in the Online Channels. x-ibm-languages: description: en: Identifier of "company" in the Online Channels. - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: string x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string default: www.example.com x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string default: www.example.com x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: TPP-Explicit-Authorisation-Preferred in: header description: >- Si es igual a true, el TPP prefiere iniciar el proceso de autorización separadamente, por ej. debido a la necesidad de la autorización de un conjunto de operaciones simultáneamente. Si es false o el parámetro no es usado, no hay preferencia del TPP. El TPP asume una autorización directa de la transacción en el siguiente paso. schema: type: boolean default: false x-ibm-languages: description: en: >- If it is equal to true, the TPP prefers to start the authorization process separately, eg. due to the need to authorize a set of operations simultaneously. If false or the parameter is not used, there is no TPP preference. The TPP assumes a direct authorization of the transaction in the next step. x-ibm-languages: description: en: >- If it is equal to true, the TPP prefers to start the authorization process separately, eg. due to the need to authorize a set of operations simultaneously. If false or the parameter is not used, there is no TPP preference. The TPP assumes a direct authorization of the transaction in the next step. - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestStartMultibankPayment' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ResponseStartMultibankPayment' x-ibm-languages: description: en: Created x-ibm-languages: summary: en: >- Message sent by the TPP to the ASPSP through the Hub to create a MULTIBANK payment start description: en: >- Message sent by the TPP to the ASPSP through the Hub to create a MULTIBANK payment start. x-codegen-request-body-name: Body /api-entrada-xs2a/services/{asp-name}/v1.1/multibanco-payments/{multibanco-payment-type}/{paymentId}/status: get: tags: - Servicios multibanco summary: >- Mensaje enviado por el TPP al ASPSP a través del Hub para solicitar el estado en el que se encuentra una iniciación de pago. description: >- Mensaje enviado por el TPP al ASPSP a través del Hub para solicitar el estado en el que se encuentra una iniciación de pago. parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: multibanco-payment-type in: path description: Tipo de pago multibanco required: true schema: type: string x-ibm-languages: description: en: Multibank payment type x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path description: Identificador del recurso que referencia a la iniciación de pago required: true schema: type: string x-ibm-languages: description: en: Resource identifier that refers to the payment initiation x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Accept in: header description: Formato soportado de la respuesta. required: true schema: type: string x-ibm-languages: description: en: Supported response format. x-ibm-languages: description: en: Supported response format. - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ResponseGetStatusMultibankPayment' x-ibm-languages: description: en: '' x-ibm-languages: summary: en: >- Message sent by the TPP to the ASPSP through the Hub to request the status of a payment initiation. description: en: >- Message sent by the TPP to the ASPSP through the Hub to request the status of a payment initiation. /api-entrada-xs2a/services/{asp-name}/v1.1/multibanco-payments/{multibanco-payment-type}/{paymentId}: get: tags: - Servicios multibanco summary: >- Este mensaje es enviado por el TPP hacia el ASPSP a través del HUB para la recuperación de información del inicio de pago MULTIBANCO. description: >- Este mensaje es enviado por el TPP hacia el ASPSP a través del HUB para la recuperación de información del inicio de pago MULTIBANCO. parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: multibanco-payment-type in: path description: Tipo de pago multibanco required: true schema: type: string x-ibm-languages: description: en: Multibank payment type x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path description: Identificador del recurso que referencia a la iniciación de pago required: true schema: type: string x-ibm-languages: description: en: Resource identifier that refers to the payment initiation x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ResponseGetMultibankPayment' x-ibm-languages: description: en: '' x-ibm-languages: summary: en: >- This message is sent by the TPP to the ASPSP through the HUB to retrieve the information of the MULTIBANCO payment initiation. description: en: >- This message is sent by the TPP to the ASPSP through the HUB to retrieve the information of the MULTIBANCO payment initiation. delete: tags: - Servicios multibanco summary: >- Esta petición permite iniciar la cancelación de un pago. Dependiendo del servicio de pago, el producto de pago y la implementación del ASPSP, esta petición podría ser suficiente para cancelar el pago o podría ser necesario una autorización. Si una autorización de la cancelación de pago es necesaria por el ASPSP, el link correspondiente será contenido en el mensaje de respuesta description: >- Esta petición permite iniciar la cancelación de un pago. Dependiendo del servicio de pago, el producto de pago y la implementación del ASPSP, esta petición podría ser suficiente para cancelar el pago o podría ser necesario una autorización. Si una autorización de la cancelación de pago es necesaria por el ASPSP, el link correspondiente será contenido en el mensaje de respuesta parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: multibanco-payment-type in: path description: Tipo de pago multibanco required: true schema: type: string x-ibm-languages: description: en: Multibank payment type x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path description: Identificador del recurso que referencia a la iniciación de pago required: true schema: type: string x-ibm-languages: description: en: Resource identifier that refers to the payment initiation x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '200': description: Deleted content: application/json: schema: $ref: '#/components/schemas/ResponseDeleteMultibankPayment' x-ibm-languages: description: en: Deleted x-ibm-languages: summary: en: >- This request allows you to initiate the cancellation of a payment. Depending on the payment service, payment product, and ASPSP implementation, this request may be sufficient to cancel the payment or an authorization may be required. If an authorization of the payment cancellation is required by the ASPSP, the corresponding link will be contained in the response message description: en: >- This request allows you to initiate the cancellation of a payment. Depending on the payment service, payment product, and ASPSP implementation, this request may be sufficient to cancel the payment or an authorization may be required. If an authorization of the payment cancellation is required by the ASPSP, the corresponding link will be contained in the response message /api-entrada-xs2a/services/{asp-name}/v1.1/multibanco-payments/{multibanco-payment-type}/{paymentId}/authorisations: get: tags: - Servicios multibanco parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: multibanco-payment-type in: path description: Tipo de pago multibanco required: true schema: type: string x-ibm-languages: description: en: Multibank payment type x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path description: Identificador del recurso que referencia a la iniciación de pago required: true schema: type: string x-ibm-languages: description: en: Resource identifier that refers to the payment initiation x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Corporate-ID in: header description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: Identifier of "company" in the Online Channels. x-ibm-languages: description: en: Identifier of "company" in the Online Channels. - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/ResponseMultibankAuthorizationSubresources x-ibm-languages: description: en: '' post: tags: - Servicios multibanco parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: multibanco-payment-type in: path description: Tipo de pago multibanco required: true schema: type: string x-ibm-languages: description: en: Multibank payment type x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path description: Identificador del recurso que referencia a la iniciación de pago required: true schema: type: string x-ibm-languages: description: en: Resource identifier that refers to the payment initiation x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Corporate-ID in: header description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: Identifier of "company" in the Online Channels. x-ibm-languages: description: en: Identifier of "company" in the Online Channels. - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/ResponseMultibankAuthorizeConsentEstablishment x-ibm-languages: description: en: Created /api-entrada-xs2a/services/{asp-name}/v1.1/multibanco-payments/{multibanco-payment-type}/{paymentId}/authorisations/{authorisationId}: get: tags: - Servicios multibanco parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: multibanco-payment-type in: path description: Tipo de pago multibanco required: true schema: type: string x-ibm-languages: description: en: Multibank payment type x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path description: Identificador del recurso que referencia a la iniciación de pago required: true schema: type: string x-ibm-languages: description: en: Resource identifier that refers to the payment initiation x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - name: authorisationId in: path description: Identificador del sub-recurso asociado al inicio de pago Multibanco required: true schema: type: string x-ibm-languages: description: en: >- Identifier of the sub-resource associated with the Multibanco payment initiation x-ibm-languages: description: en: >- Identifier of the sub-resource associated with the Multibanco payment initiation - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Corporate-ID in: header description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: Identifier of "company" in the Online Channels. x-ibm-languages: description: en: Identifier of "company" in the Online Channels. - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ResponseMultibankGetSCAStatus' x-ibm-languages: description: en: '' put: tags: - Servicios multibanco parameters: - name: asp-name in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: multibanco-payment-type in: path description: Tipo de pago multibanco required: true schema: type: string x-ibm-languages: description: en: Multibank payment type x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path description: Identificador del recurso que referencia a la iniciación de pago required: true schema: type: string x-ibm-languages: description: en: Resource identifier that refers to the payment initiation x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - name: authorisationId in: path description: Identificador del sub-recurso asociado al inicio de pago Multibanco required: true schema: type: string x-ibm-languages: description: en: >- Identifier of the sub-resource associated with the Multibanco payment initiation x-ibm-languages: description: en: >- Identifier of the sub-resource associated with the Multibanco payment initiation - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Corporate-ID in: header description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: Identifier of "company" in the Online Channels. x-ibm-languages: description: en: Identifier of "company" in the Online Channels. - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its content. - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestActualizarDatosPsu' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ResponseMultibankSelectSCAMethod' x-ibm-languages: description: en: '' x-codegen-request-body-name: Body /api-entrada-xs2a/services/{aspsp}/v1.1/payments/{payment-product}: post: tags: - Inicio de pago summary: Inicio de pago Simple o pago Futuro description: >- Mensaje enviado por el TPP al ASPSP a través del HUB para crear un inicio de pago Simple. operationId: initiationPayment parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-product in: path required: true schema: type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: Content-Type in: header description: application/json required: true schema: type: string x-ibm-languages: description: en: application / json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Consent-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456 x-ibm-languages: description: en: >- This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456 - name: PSU-ID in: header 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. schema: type: string 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. 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 description: >- Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. schema: type: string x-ibm-languages: description: en: >- PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. 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 description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: TPP-Explicit-Authorisation-Preferred in: header description: >- Si es igual a true, el TPP prefiere iniciar el proceso de autorización separadamente, por ej. debido a la necesidad de la autorización de un conjunto de operaciones simultáneamente. schema: type: boolean x-ibm-languages: description: en: >- If equal to true, the TPP prefers to initiate the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. x-ibm-languages: description: en: >- If equal to true, the TPP prefers to initiate the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. - name: TPP-Brand-Logging-Information in: header description: >- Este campo podría ser usado por el TPP para informar al ASPSP acerca de la marca (Brand) usada por el TPP de cara al PSU. Esta información puede ser usada para mejorar la comunicación entre el ASPSP y el PSU o el ASPSP y el TPP. schema: type: string x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. - name: TPP-Rejection-NoFunds-Preferred in: header description: >- Nota: Este campo será ignorado en caso de venir informado por el TPP. schema: type: string x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-URI in: header description: >- Nota: Este campo será ignorado en caso de venir informado por el TPP. schema: type: string x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-Content-Preferred in: header description: >- Nota: Este campo será ignorado en caso de venir informado por el TPP. schema: type: string x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA requestBody: content: application/json: schema: $ref: '#/components/schemas/SinglePayment' required: true responses: default: description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT Location: description: Contiene el link al recurso generado. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Response_PaymentInitiation' example: transactionStatus: RCVD paymentId: 123-qwe-456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' self: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456 status: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/status scaStatus: href: >- /v1.1/payments/sepa-credit-transfers/123-qwe-456/authorisations/123auth456 x-ibm-languages: summary: en: Simple payment start description: en: >- Message sent by the TPP to the ASPSP through the HUB to create a Single payment initiation. x-codegen-request-body-name: body /api-entrada-xs2a/services/{aspsp}/v1.1/bulk-payments/{payment-product}: post: tags: - Inicio de pago summary: Inicio de pago Bulk description: >- Este mensaje es enviado por el TPP hacia el HUB para la realización de inicio de pago bulk operationId: initiationBulkPayment parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-product in: path required: true schema: type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: Content-Type in: header description: application/json required: true schema: type: string x-ibm-languages: description: en: application / json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Consent-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456 x-ibm-languages: description: en: >- This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456 - name: PSU-ID in: header 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. schema: type: string 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. 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 description: >- Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. schema: type: string x-ibm-languages: description: en: >- PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. 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 description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: TPP-Explicit-Authorisation-Preferred in: header description: >- Si es igual a true, el TPP prefiere iniciar el proceso de autorización separadamente, por ej. debido a la necesidad de la autorización de un conjunto de operaciones simultáneamente. schema: type: boolean x-ibm-languages: description: en: >- If equal to true, the TPP prefers to initiate the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. x-ibm-languages: description: en: >- If equal to true, the TPP prefers to initiate the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. - name: TPP-Brand-Logging-Information in: header description: >- Este campo podría ser usado por el TPP para informar al ASPSP acerca de la marca (Brand) usada por el TPP de cara al PSU. Esta información puede ser usada para mejorar la comunicación entre el ASPSP y el PSU o el ASPSP y el TPP. schema: type: string x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. - name: TPP-Rejection-NoFunds-Preferred in: header description: >- Nota: Este campo será ignorado en caso de venir informado por el TPP. schema: type: string x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-URI in: header description: >- Nota: Este campo será ignorado en caso de venir informado por el TPP. schema: type: string x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-Content-Preferred in: header description: >- Nota: Este campo será ignorado en caso de venir informado por el TPP. schema: type: string x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA requestBody: content: application/json: schema: $ref: '#/components/schemas/Request_BulkPayment' required: true responses: default: description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT Location: description: Contiene el link al recurso generado. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Response_PaymentInitiation' example: transactionStatus: RCVD paymentId: 123-qwe-456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' self: href: /v1.1/bulk-payments/sepa-credit-transfers/123-qwe-456 status: href: >- /v1.1/bulk-payments/sepa-credit-transfers/123-qwe-456/status scaStatus: href: >- /v1.1/bulk-payments/sepa-credit-transfers/123-qwe-456/authorisations/123auth456 x-ibm-languages: summary: en: Bulk payment start description: en: >- This message is sent by the TPP to the HUB for the realization of bulk payment initiation x-codegen-request-body-name: body /api-entrada-xs2a/services/{aspsp}/v1.1/periodic-payments/{payment-product}: post: tags: - Inicio de pago summary: Inicio de pago Recurrente/Periódico description: >- Mensaje enviado por el TPP al ASPSP a través del Hub para crear un inicio de pago recurrente/periódico. La funcionalidad de inicios de pagos recurrentes es cubierta por la especificación de Berlin Group como la iniciación de una orden específica permanente. Un TPP puede enviar un inicio de pago recurrente donde se proporciona la fecha de inicio, frecuencia y, condicionalmnete, fecha fin. Una vez autorizado por el PSU, el pago será ejecutado por el ASPSP, si es posible, siguiendo la “orden permanente” como fue enviada por el TPP. No se necesitan acciones adicionales por parte del TPP. En este contexto, este pago es considerado un pago periódico para diferenciar el pago de otros tipos de pagos recurrentes donde terceras partes están iniciando la misma cantidad de dinero. Nota: para las órdenes permanentes de inicios de pago, el ASPSP siempre pedirá SCA con Dynamic linking. No se permiten exenciones. operationId: initiateRecurringPayment parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-product in: path required: true schema: type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: Content-Type in: header description: application/json required: true schema: type: string x-ibm-languages: description: en: application / json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Consent-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456 x-ibm-languages: description: en: >- This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456 - name: PSU-ID in: header 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. schema: type: string 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. 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 description: >- Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. schema: type: string x-ibm-languages: description: en: >- PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. 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 description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. x-ibm-languages: description: en: >- If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. - name: TPP-Redirect-URI in: header 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 schema: type: string x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb x-ibm-languages: description: en: >- TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" - name: TPP-Explicit-Authorisation-Preferred in: header description: >- Si es igual a true, el TPP prefiere iniciar el proceso de autorización separadamente, por ej. debido a la necesidad de la autorización de un conjunto de operaciones simultáneamente. schema: type: boolean x-ibm-languages: description: en: >- If equal to true, the TPP prefers to initiate the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. x-ibm-languages: description: en: >- If equal to true, the TPP prefers to initiate the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. - name: TPP-Brand-Logging-Information in: header description: >- Este campo podría ser usado por el TPP para informar al ASPSP acerca de la marca (Brand) usada por el TPP de cara al PSU. Esta información puede ser usada para mejorar la comunicación entre el ASPSP y el PSU o el ASPSP y el TPP. schema: type: string x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. x-ibm-languages: description: en: >- This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. - name: TPP-Rejection-NoFunds-Preferred in: header description: >- Nota: Este campo será ignorado en caso de venir informado por el TPP. schema: type: string x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-URI in: header description: >- Nota: Este campo será ignorado en caso de venir informado por el TPP. schema: type: string x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-Content-Preferred in: header description: >- Nota: Este campo será ignorado en caso de venir informado por el TPP. schema: type: string x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA requestBody: content: application/json: schema: $ref: '#/components/schemas/Request_PeriodicPayment' required: true responses: default: description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT Location: description: Contiene el link al recurso generado. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Response_PaymentInitiation' x-ibm-languages: summary: en: Recurring/Periodic Payment Initiation description: en: >- Message sent by the TPP to the ASPSP through the Hub to create a recurring / periodic payment start. The recurring payment initiation functionality is covered by the Berlin Group specification as the initiation of a specific permanent order. A TPP can send a recurring payment start where the start date, frequency and, conditionally, end date are provided. Once authorized by the PSU, the payment will be executed by the ASPSP, if possible, following the “permanent order” as sent by the TPP. No additional actions are required by the TPP. In this context, this payment is considered a periodic payment to differentiate payment from other types of recurring payments where third parties are initiating the same amount of money. Note: for permanent orders for payment initiation, the ASPSP will always request SCA with Dynamic linking. Exemptions are not allowed. x-codegen-request-body-name: body /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/status: get: tags: - Obtener estado del pago summary: Obtener información del Estado de pago description: >- Este mensaje es enviado por el TPP al HUB para solicitar información del estado en el que se encuentra la iniciación de pago que solicitó el TPP operationId: statusPayment parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-service in: path description: Producto de pago a usar. required: true schema: type: string enum: - payments - bulk-payments - periodic-payments x-ibm-languages: description: en: Payment product to use. x-ibm-languages: description: en: Payment product to use. - name: payment-product in: path description: Producto de pago a usar. required: true schema: type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers x-ibm-languages: description: en: Payment product to use. x-ibm-languages: description: en: Payment product to use. - name: payment-id in: path description: >- Identificador del recurso que referencia a la iniciación de pago. Enviado previamente como respuesta a un mensaje de iniciación de pago del TPP al HUB. required: true schema: type: string x-ibm-languages: description: en: >- Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB. x-ibm-languages: description: en: >- Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Accept in: header description: Formato soportado de la respuesta. required: true schema: type: string x-ibm-languages: description: en: Supported response format. x-ibm-languages: description: en: Supported response format. - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Encoding: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Encoding: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Encoding: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET. Ej: PSU-Http-Method: GET schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET. Ex: PSU-Http-Method: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET. Ex: PSU-Http-Method: GET - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_GetStatusPayment' x-ibm-languages: summary: en: Obtain payment status information description: en: >- This message is sent by the TPP to the HUB to request information on the status of the payment initiation requested by the TPP /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}: get: tags: - Recuperar información del Inicio de pago summary: Recuperar información del Inicio de pago description: >- Este mensaje es enviado por el TPP al HUB para solicitar información de un inicio de pago operationId: getInfoPayment parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-service in: path description: Producto de pago a usar. required: true schema: type: string enum: - payments - bulk-payments - periodic-payments x-ibm-languages: description: en: Payment product to use. x-ibm-languages: description: en: Payment product to use. - name: payment-product in: path description: Producto de pago a usar. required: true schema: type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers x-ibm-languages: description: en: Payment product to use. x-ibm-languages: description: en: Payment product to use. - name: payment-id in: path description: >- Identificador del recurso que referencia a la iniciación de pago. Enviado previamente como respuesta a un mensaje de iniciación de pago del TPP al HUB. required: true schema: type: string x-ibm-languages: description: en: >- Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB. x-ibm-languages: description: en: >- Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: Accept in: header description: 'Formato soportado de la respuesta. ' required: true schema: type: string x-ibm-languages: description: en: 'Supported response format. ' x-ibm-languages: description: en: 'Supported response format. ' - name: PSU-IP-Address in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Encoding: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Encoding: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Encoding: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET. Ej: PSU-Http-Method: GET schema: type: string default: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET. Ex: PSU-Http-Method: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET. Ex: PSU-Http-Method: GET - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_GetInfoPayment' x-ibm-languages: summary: en: Retrieve payment Initiation information description: en: >- This message is sent by the TPP to the HUB to request information about a payment start delete: tags: - Cancelar Inicio de pago summary: Cancelar Inicio de pago description: >- Esta petición es enviada por el TPP al ASPSP a través del Hub y permite iniciar la cancelación de un pago. Dependiendo del servicio de pago, el producto de pago y la implementación del ASPSP, esta petición podríar ser suficiente para cancelar el pago o podría ser necesario una autorización. operationId: deletePayment parameters: - name: aspsp in: path description: Nombre del ASPSP al que desea realizar la petición. required: true schema: type: string x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-service in: path description: Producto de pago a usar. required: true schema: type: string enum: - payments - bulk-payments - periodic-payments x-ibm-languages: description: en: Payment product to use. x-ibm-languages: description: en: Payment product to use. - name: payment-product in: path description: Producto de pago a usar. required: true schema: type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers x-ibm-languages: description: en: Payment product to use. x-ibm-languages: description: en: Payment product to use. - name: payment-id in: path description: >- Identificador del recurso que referencia a la iniciación de pago.Enviado previamente como respuesta a un mensaje de iniciación de pago del HUB al ASPSP. required: true schema: type: string x-ibm-languages: description: en: >- Identifier of the resource that refers to the payment initiation. Previously sent in response to a payment initiation message from the HUB to the ASPSP. x-ibm-languages: description: en: >- Identifier of the resource that refers to the payment initiation. Previously sent in response to a payment initiation message from the HUB to the ASPSP. - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-ibm-languages: description: en: >- Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA - name: TPP-Redirect-Preferred in: header 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. EMBEBIDO NO SOPORTADO EN ESTA VERSIÓN schema: type: boolean x-ibm-languages: description: en: >- If "true", the TPP has communicated to the HUB that it prefers SCA by redirection. If "false", the TPP has communicated to the HUB that it prefers not to be redirected for SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to apply depending on the SCA method chosen by the TPP/PSU. EMBEDDED NOT SUPPORTED IN THIS VERSION x-ibm-languages: description: en: >- If "true", the TPP has communicated to the HUB that it prefers SCA by redirection. If "false", the TPP has communicated to the HUB that it prefers not to be redirected for SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to apply depending on the SCA method chosen by the TPP/PSU. EMBEDDED NOT SUPPORTED IN THIS VERSION - name: TPP-Redirect-URI in: header 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. schema: type: string x-ibm-languages: description: en: >- TPP URI where the transaction flow should be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. x-ibm-languages: description: en: >- TPP URI where the transaction flow should be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. - name: TPP-Nok-Redirect-URI in: header 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. schema: type: string x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. x-ibm-languages: description: en: >- If this URI is contained, the TPP is requesting to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. - name: TPP-Explicit-Authorisation-Preferred in: header description: >- Si es igual a true, el TPP prefiere iniciar el proceso de autorización separadamente, por ej. debido a la necesidad de la autorización de un conjunto de operaciones simultáneamente. Si es false o el parámetro no es usado, no hay preferencia del TPP. El TPP asume una autorización directa de la transacción en el siguiente paso. Nota: el ASPSP podría no tenerlo en cuenta si no lo soporta. schema: type: boolean x-ibm-languages: description: en: >- If true, the TPP prefers to start the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. If false or the parameter is not used, there is no TPP preference. The TPP assumes a direct authorization of the transaction in the next step. Note: ASPSP may not take this into account if it does not support it. x-ibm-languages: description: en: >- If true, the TPP prefers to start the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. If false or the parameter is not used, there is no TPP preference. The TPP assumes a direct authorization of the transaction in the next step. Note: ASPSP may not take this into account if it does not support it. - name: PSU-IP-Address in: header 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 schema: type: string x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 x-ibm-languages: description: en: >- IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 x-ibm-languages: description: en: >- IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json x-ibm-languages: description: en: >- Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 x-ibm-languages: description: en: >- Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Encoding: gzip schema: type: string x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Encoding: gzip x-ibm-languages: description: en: >- Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Encoding: gzip - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES x-ibm-languages: description: en: >- Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES - name: PSU-User-Agent in: header 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) schema: type: string x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) x-ibm-languages: description: en: >- Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET schema: type: string default: DELETE x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET x-ibm-languages: description: en: >- HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET - name: PSU-Device-ID in: header 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 schema: type: string x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 x-ibm-languages: description: en: >- Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == x-ibm-languages: description: en: >- It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA x-ibm-languages: description: en: >- TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA responses: default: description: HTTP/1.1 202 Ok headers: X-Request-ID: description: Identificador único de la petición asignado por el TPP. schema: type: string content: '*/*': schema: $ref: '#/components/schemas/Response_CancelPaymentInitiation' application/json: example: transactionStatus: ACTC _links: self: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456 status: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/status startAuthorisation: href: >- /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations x-ibm-languages: summary: en: Cancel payment start description: en: >- This request is sent by the TPP to the ASPSP through the Hub and allows to initiate the cancellation of a payment. Depending on the payment service, the payment product and the implementation of the ASPSP, this request may be sufficient to cancel the payment or authorization may be necessary. /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/authorisations: get: tags: - Obtener sub-recursos de la autorización 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 schema: 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 schema: type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path description: >- Identificador del recurso que referencia a la iniciación de pago o consentimiento. required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_GetSubResourcesAuthorization' example: cancellationIds: - 123auth456 post: tags: - Inicio del proceso de autorización (explícita) 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 schema: 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 schema: type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT Location: description: Contiene el link al recurso generado. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Response_AuthorizationInitiationPayment' example: 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 /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/authorisations/{authorisation-id}: get: tags: - Obtener estado SCA 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 schema: 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 schema: type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path description: >- Identificador del subrecurso asociado al inicio de pago o consentimiento. required: true schema: type: string - name: payment-id in: path required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_GetSCAStatus' example: scaStatus: ' finalised' put: tags: - Actualizar datos del PSU (seleccionar método SCA) 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 schema: 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 schema: type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path required: true schema: type: string - name: payment-id in: path required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Request_UpdatePSUData' required: true responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_UpdatePSUData' example: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: >- /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 x-codegen-request-body-name: Body /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations: get: tags: - Obtener sub-recursos de la autorización 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 schema: 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 schema: type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path description: >- Identificador del recurso que referencia a la iniciación de pago o consentimiento. required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_GetSubResourcesAuthorization' example: cancellationIds: - 123auth456 post: tags: - Inicio del proceso de autorización (explícita) 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 schema: 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 schema: type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT Location: description: Contiene el link al recurso generado. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Response_AuthorizationInitiationPayment' example: 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 /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations/{authorisation-id}: get: tags: - Obtener estado SCA 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 schema: 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 schema: type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path required: true schema: type: string - name: payment-id in: path description: >- Identificador del recurso que referencia a la iniciación de pago o consentimiento. required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_GetSCAStatus' example: cancellationIds: - 123auth456 put: tags: - Actualizar datos del PSU (seleccionar método SCA) 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 schema: 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 schema: type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path required: true schema: type: string - name: payment-id in: path required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_AuthorizationInitiationPayment' example: 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 /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}/authorisations: get: tags: - Obtener sub-recursos de la autorización 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string - name: consent-id in: path description: >- Identificador del recurso que referencia a la iniciación de pago o consentimiento. required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_GetSubResourcesAuthorization' example: cancellationIds: - 123auth456 post: tags: - Inicio del proceso de autorización (explícita) 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 parameters: - name: aspsp in: path required: true schema: type: string - name: consent-id in: path required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: PSU-ID in: header 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. schema: type: string 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. 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 description: >- Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. schema: type: string x-ibm-languages: description: en: >- PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. 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 description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT Location: description: Contiene el link al recurso generado. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Response_AuthorizationInitiationPayment' example: 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 /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}/authorisations/{authorisation-id}: get: tags: - Obtener estado SCA 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 description: Identificador del subrecurso asociado al ID de autorización required: true schema: type: string - name: consent-id in: path description: Identificador asociado al ID de consentimiento, creado previamente required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_GetSCAStatus' example: scaStatus: ' finalised' put: tags: - Actualizar datos del PSU (seleccionar método SCA) 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 description: Identificador del subrecurso asociado al ID de autorización required: true schema: type: string - name: consent-id in: path description: Identificador asociado al ID de consentimiento, creado previamente required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Request_UpdatePSUData' required: true responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_UpdatePSUData' example: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: >- /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 x-codegen-request-body-name: Body /api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}/authorisations: get: tags: - Obtener sub-recursos de la autorización 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string - name: consent-id in: path description: >- Identificador del recurso que referencia a la iniciación de pago o consentimiento. required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_GetSubResourcesAuthorization' example: cancellationIds: - 123auth456 post: tags: - Inicio del proceso de autorización (explícita) 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 parameters: - name: aspsp in: path required: true schema: type: string - name: consent-id in: path required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: PSU-ID in: header 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. schema: type: string 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. 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 description: >- Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. schema: type: string x-ibm-languages: description: en: >- PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. 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 description: Identificador de "empresa" en los Canales Online. schema: type: string x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header description: >- Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. schema: type: string x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. x-ibm-languages: description: en: >- Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: boolean - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 201 Created headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT Location: description: Contiene el link al recurso generado. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Response_AuthorizationInitiationPayment' example: 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 /api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}/authorisations/{authorisation-id}: get: tags: - Obtener estado SCA 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 description: Identificador del subrecurso asociado al ID de autorización required: true schema: type: string - name: consent-id in: path description: Identificador asociado al ID de consentimiento, creado previamente required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_GetSCAStatus' example: scaStatus: ' finalised' put: tags: - Actualizar datos del PSU (seleccionar método SCA) 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 parameters: - name: aspsp in: path description: >- Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...) required: true schema: type: string 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 description: Identificador del subrecurso asociado al ID de autorización required: true schema: type: string - name: consent-id in: path description: Identificador asociado al ID de consentimiento, creado previamente required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string - name: X-Request-ID in: header description: >- Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 required: true schema: type: string - name: Authorization in: header description: >- Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA required: true schema: type: string default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header 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 schema: type: string - name: PSU-IP-Address in: header 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 required: true schema: type: string - name: PSU-IP-Port in: header description: >- Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443 schema: type: string - name: PSU-Accept in: header description: >- Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json schema: type: string - name: PSU-Accept-Charset in: header description: >- Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8 schema: type: string - name: PSU-Accept-Encoding in: header description: >- Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip schema: type: string - name: PSU-Accept-Language in: header description: >- Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES schema: type: string - name: PSU-User-Agent in: header 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) schema: type: string - name: PSU-Http-Method in: header description: >- Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST schema: type: string default: POST - name: PSU-Device-ID in: header 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 schema: type: string - name: PSU-Geo-Location in: header description: >- Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963 schema: type: string - name: TPP-Redirect-Preferred in: header 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. schema: type: string - name: TPP-Redirect-URI in: header 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 schema: type: string - name: TPP-Nok-Redirect-URI in: header 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" schema: type: string - name: Digest in: header description: >- Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ== required: true schema: type: string - name: Signature in: header description: 'Firma de la petición por el TPP. ' required: true schema: type: string - name: TPP-Signature-Certificate in: header 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 required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Request_UpdatePSUData' required: true responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: description: Identificador único de la operación asignado por el TPP. schema: type: string ASPSP-SCA-Approach: description: >- Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT content: application/json: schema: $ref: '#/components/schemas/Response_UpdatePSUData' example: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: >- /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 x-codegen-request-body-name: Body components: schemas: AuthenticationObject: required: - authenticationMethodId - authenticationType - name type: object properties: authenticationType: type: string description: >- Tipo del método de autenticación. Ver anexo 9.6 Tipos de autenticación para más información. example: SMS_OTP authenticationVersion: type: string description: Versión de la herramienta asociada al authenticationType. example: '1.0' authenticationMethodId: type: string description: Id del método de autenticación proporcionado por el ASPSP. example: SMS_OTP name: type: string description: >- Nombre del método de autenticación definido por el PSU en la banca online del ASPSP. Alternativamente podría ser una descripción proporcionada por el ASPSP. Si el TPP lo tiene disponible, debe presentarlo al PSU. example: SMS OTP al teléfono 666777888 explanation: type: string description: Información detallada acerca del método SCA para el PSU. AdditionalInformationAccess: type: object properties: trustedBeneficiaries: type: object description: >- Está solicitando acceso a los beneficiarios de confianza de la cuenta referenciada y relacionada al PSU. si se informa será ignorado por el ASPSP. x-ibm-languages: description: en: >- You are requesting access to the trusted beneficiaries of the account referenced and related to the PSU. if it is reported it will be ignored by the ASPSP. ownerName: type: object description: Si se informa será ignorado por el ASPSP x-ibm-languages: description: en: If reported it will be ignored by ASPSP additionalProperties: true AccountAccess: type: object properties: accounts: type: object description: >- Indica las cuentas sobre las que pedir información detallada. Si la lista está vacía, el TPP está solicitando todas las cuentas accesibles. x-ibm-languages: description: en: >- Indicates the accounts on which to request detailed information. If the list is empty, the TPP is requesting all accessible accounts. balances: type: object description: >- Indica las cuentas sobre las que pedir saldos. Si la lista está vacía, el TPP está solicitando los saldos de todas las listas de cuentas accesibles y serán preguntadas en un diálogo entre PSU-ASPSP. Además, la lista de accounts y transactions también deben ir vacías si son usadas. x-ibm-languages: description: en: >- Indicates the accounts to request balances. If the list is empty, the TPP is requesting the balances of all lists of accessible accounts. transactions: type: object description: >- Indica las cuentas sobre las que pedir transacciones. Si la lista está vacía, el TPP está solicitando las transacciones de todas las listas de cuentas accesibles y serán preguntadas en un diálogo entre PSU-ASPSP. Además, la lista de balances y accounts también deben ir vacías si son usadas. x-ibm-languages: description: en: >- Indicates the accounts on which to request transactions. If the list is empty, the TPP is requesting transactions from all lists of accessible accounts. availableAccounts: type: string description: Solo el valor 'allAccounts' es admitido example: allAccounts x-ibm-languages: description: en: Only the 'allAccounts' value is supported availableAccountsWithBalance: type: string description: Solo el valor 'allAccounts' es admitido example: allAccounts x-ibm-languages: description: en: Only the 'allAccounts' value is supported allPsd2: type: string description: Solo el valor 'allAccounts' es admitido example: allAccounts x-ibm-languages: description: en: Only the 'allAccounts' value is supported additionalProperties: true AccountDetails: required: - currency type: object properties: resourceId: type: string description: >- Identificador de la cuenta a ser usado en el PATH cuando se solicitan datos sobre una cuenta dedicada. example: 3dc3d5b3702348489853f5400a64e80f x-ibm-languages: description: en: >- Account identifier to be used in the PATH when requesting data about a dedicated account. iban: type: string description: IBAN de la cuenta example: ES1111111111111111111 x-ibm-languages: description: en: Account IBAN bban: type: string description: BBAN de la cuenta, cuando esta no tiene IBAN. example: '20385778983000760236' x-ibm-languages: description: en: Account BBAN, when it does not have IBAN. msisdn: type: string description: >- Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado. x-ibm-languages: description: en: >- Alias to access a payment account through a registered mobile phone number. currency: type: string description: Tipo de moneda de la cuenta example: EUR x-ibm-languages: description: en: Currency type of the account ownerName: type: string description: >- Nombre del propietario legal de la cuenta ,en este caso, el nombre del PSU conectado. Para una cuenta corporativa, el nombre corporativo se usará en este campo. example: Heike Mustermann x-ibm-languages: description: en: >- Name of the legal owner of the account ,in this case, the name of the connected PSU. For a corporate account, the corporate name will be used in this field. name: type: string description: >- Nombre de la cuenta asignado por el ASPSP en el acuerdo con el propietario de la cuenta con el objetivo de proporcionar una nueva forma de identificar la cuenta. example: Nombre asignado por el ASPSP x-ibm-languages: description: en: >- Account name assigned by the ASPSP in the agreement with the account owner for the purpose of providing a new way to identify the account. displayName: type: string description: Nombre de la cuenta definido por el PSU en los Canales Online example: Nombre asignado por el PSU x-ibm-languages: description: en: Account name defined by PSU in Online Channels product: type: string description: Nombre del producto que da el ASPSP a esta cuenta. example: Main Account x-ibm-languages: description: en: Name of the product that gives the ASPSP to this account. cashAccountType: type: string description: Especifica la naturaleza o el uso de la cuenta. example: CACC x-ibm-languages: description: en: Specifies the nature or use of the account. status: type: string description: >- Estado de la cuenta. El valor es uno de los siguientes: enabled: la cuenta está disponible ,deleted: cuenta cerrada, blocked: cuenta bloqueada. example: enabled x-ibm-languages: description: en: >- Account status. The value is one of the following: enabled: account is available ,deleted: account is closed, blocked: account is blocked. bic: type: string description: BIC asociado a la cuenta. example: XSXHXSMMXXX x-ibm-languages: description: en: BIC associated to the account. linkedAccounts: type: string description: >- En este campo el ASPSP puede nombrar una cuenta asociada a transacciones pendientes de tarjeta. x-ibm-languages: description: en: >- In this field the ASPSP can name an account associated with pending card transactions. usage: type: string description: >- Especifica el uso de la cuenta. Valores posibles: PRIV: cuenta personal privada, ORGA: cuenta profesional example: PRIV x-ibm-languages: description: en: >- Specifies the use of the account. Possible values: PRIV: private personal account, ORGA: professional account. details: type: string description: >- Especificaciones que deben ser provistas por el ASPSP. Características de la cuenta. Características de la tarjeta x-ibm-languages: description: en: >- Specifications to be provided by the ASPSP. Account features. Card characteristics balances: type: object description: Balances de la cuenta. x-ibm-languages: description: en: Account balances. _links: type: object description: >- Enlaces a la cuenta para recuperar información de balances y/o transacciones de la cuenta. Links soportados solo cuando se ha dado el consentimiento correspondiente a la cuenta. x-ibm-languages: description: en: >- Links to the account to retrieve account balance and/or transaction information. Links supported only when consent has been given to the account. ownerNames: type: object description: Listado de nombres de propietarios de la cuenta. x-ibm-languages: description: en: List of names of account owners. psuName: type: string description: >- Nombre del PSU conectado.En caso de cuentas corporativas, esto podría ser la persona que actúe en nombre de la empresa. example: Heike Mustermann x-ibm-languages: description: en: >- Name of the connected PSU. In case of corporate accounts, this could be the person acting on behalf of the company. additionalProperties: true AccountReference: type: object properties: iban: type: string description: IBAN de la cuenta example: ES1111111111111111111111 x-ibm-languages: description: en: Account IBAN bban: type: string description: BBAN de la cuenta, cuando esta no tiene IBAN. example: '20385778983000760236' x-ibm-languages: description: en: Account BBAN, when it does not have IBAN. pan: type: string description: >- Número de la tarjeta de la cuenta. Puede ser tokenizado por el ASPSP para cumplir los requerimientos de PCI DSS. example: '1234567891234567' x-ibm-languages: description: en: >- Account card number. It can be tokenized by the ASPSP to meet the requirements of PCI DSS. maskedPan: type: string description: Número de la tarjeta de la cuenta de forma enmascarda. example: 123456******4567 x-ibm-languages: description: en: Account card number masked. msisdn: type: string description: >- Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado. example: '1549951988' x-ibm-languages: description: en: >- Alias to access a payment account through a registered mobile phone number. currency: type: string description: Tipo de moneda. example: EUR x-ibm-languages: description: en: Type of currency. Href: required: - href type: object 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. postConscaOAuth: 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. 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. 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. 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. 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. status: type: object description: >- El enlace para recuperar el estado de la transacción. Por ejemplo, estado de inicio de pago. scaStatus: type: object description: >- Enlace para recuperar el estado de la autorización o sub-recurso de autorización de cancelación. account: type: object description: Link al recurso que proporciona los datos de una cuenta. balances: type: object description: Link al recurso que proporciona los balances de la cuenta. transactions: type: object description: Link al recurso que proporciona las transacciones de la cuenta. cardAccount: type: object description: Link al recurso que proporciona los datos de una cuenta de tarjeta. cardTransactions: type: object description: >- Link al recurso que proporciona las transacciones de la cuenta de tarjeta. transactionDetails: type: object description: >- Enlace al recurso proporcionando detalles de una transacción específica. NO SOPORTADO EN ESTA VERSIÓN first: type: object description: Enlace de navegación para informes de cuentas paginados. next: type: object description: Enlace de navegación para informes de cuentas paginados. previous: type: object description: Enlace de navegación para informes de cuentas paginados. last: type: object description: Enlace de navegación para informes de cuentas paginados. download: type: object description: >- Enlace de descarga para grandes paquetes de datos AIS. Solo para camt-data. additionalProperties: true List_AuthenticationObject: type: array items: $ref: '#/components/schemas/AuthenticationObject' List_AccountDetails: type: array items: $ref: '#/components/schemas/AccountDetails' List_AccountReference: type: array items: $ref: '#/components/schemas/AccountReference' Request_GetConsent: required: - access - combinedServiceIndicator - frequencyPerDay - recurringIndicator - validUntil type: object properties: access: type: object x-ibm-languages: description: en: >- Access requested to services. Only sub attributes with tags "accounts", "balances" and "transactions" are accepted. Additionally, the ASPSP can support the "availableAccounts" or "allPsd2" sub attributes with the value "all-accounts". recurringIndicator: type: boolean description: 'true: acceso recurrente a la cuenta. false: un solo acceso.' example: true x-ibm-languages: description: en: 'true: recurring access to the account. false: a single access. ' validUntil: type: string description: >- Fecha hasta la que el consentimiento solicita acceso. Para crear el consentimiento con el máximo tiempo de acceso posible se debe usar el valor: 9999-12-31 Cuando se recupere el consentimiento, la fecha máxima posible vendrá ajustada. La validez también incluye hasta la fecha solicitada. example: 2020-05-17T00:00:00.000Z x-ibm-languages: description: en: >- Date until the consent requests access. To create the consent with the maximum possible access time the value must be used: 9999-12-31 When the consent is recovered, the maximum possible date will be set. The validity also includes up to the requested date. frequencyPerDay: type: integer description: >- Indica la frecuencia de acceso a la cuenta por día. 1 si es de un solo acceso. example: 4 x-ibm-languages: description: en: >- Indicates the frequency of access to the account per day. 1 if it is single access. combinedServiceIndicator: type: boolean description: >- Indica que un inicio de pago se realizará en la misma sesión. De momento el HUB no implementará servicios combinados por lo que este campo deberá tomar el valor de falso. example: false x-ibm-languages: description: en: >- Indicates that a payment start will be made in the same session. At the moment the HUB will not implement combined services so this field should take the value of false. additionalProperties: true Request_PostConsentFundsConfirmation: required: - account type: object properties: account: type: object description: Cuenta sobre la que se realizará la consulta de fondos. x-ibm-languages: description: en: Account on which the funds inquiry will be carried out. cardNumber: type: string description: >- Número de tarjeta de la tarjeta emitida por el PIISP. Debe ser enviada si está disponible. example: 4548-8100-0000-0001 x-ibm-languages: description: en: >- Card number of the card issued by the PIISP. It must be sent if available. cardExpiryDate: type: string description: >- Fecha de caducidad de la tarjeta emitida por el PIISP. (Formato ISODate) example: 2018-05-17T00:00:00.000Z x-ibm-languages: description: en: >- Expiration date of the card issued by the PIISP. (ISODate format) cardInformation: type: string description: Explicación adicional del producto. example: Informacion adicional x-ibm-languages: description: en: Additional explanation of the product. registrationInformation: type: string description: >- Información adicional acerca del proceso de registro para el PSU. Por ej. una referencia al contrato entre TPP/PSU example: Informacion adicional x-ibm-languages: description: en: >- Additional information about the registration process for the PSU. Eg a reference to the contract between TPP / PSU additionalProperties: false Response_GetConsent: required: - _links - consentId - consentStatus type: object properties: consentStatus: type: string description: >- Estado de autenticación del consentimiento. Valores definidos en anexos. example: ACCP x-ibm-languages: description: en: Consent authentication status. Values defined in annexes. consentId: type: string description: >- Identificador del recurso que referencia al consentimiento. Debe ser contenido si se generó un consentimiento. example: 123-QWE-456 x-ibm-languages: description: en: >- Identifier of the resource that references the consent. It must be contained if a consent was generated. scaMethods: type: object description: >- Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. Si este dato es contenido también se informará el link "startAuthorisationWithAuthenticationMethodSelection”. Esto métodos deberán ser presentados al PSU. Nota: Solo si ASPSP soporta selección del método SCA x-ibm-languages: description: en: >- This element is contained if SCA is required and if the PSU can choose between different authentication methods. If this element is contained the link "startAuthorisationWithAuthenticationMethodSelection" will also be reported. These methods shall be presented to the PSU. Note: Only if ASPSP supports SCA method selection. choosenScaMethod: type: object description: NO SOPORTADO PARA ESTA VERSIÓN x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION _links: type: object description: >- Lista de hipervínculos para ser reconocidos por el HUB. Tipos soportados en esta respuesta: scaRedirect: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el Hub. startAuthorisation: en caso de que un inicio explícito de la autorización de la transacción sea necesario (no hay selección del método SCA) startAuthorisationWithAuthenticationMethodSelection: link al end-point de autorización donde el sub-recurso de autorización tiene que ser generado mientras se selecciona el método SCA. Este enlace es contenido bajo las mismas condiciones que el campo "scaMethods" self: link al recurso de inicio de pago creado por esta petición. status: link para recuperar el estado de la transacción del inicio de pago. scaStatus: link para consultar el estado SCA correspondiente al sub-recurso de autorización. Este link es solo contenido si un sub-recurso de autorización ha sido creado. (Si no hay autorización explícita este enlace debe venir obligatoriamente) psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Texto de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessage: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_StatusConsent: required: - consentStatus type: object properties: consentStatus: type: string description: >- Estado de la transacción (solicitud de consentimiento identificado por consent-id) example: valid x-ibm-languages: description: en: >- Status of the transaction (consent request identified by consent-id) psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Informacion para PSU x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessage: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_GetInfoConsent: required: - access - consentStatus - frequencyPerDay - lastActionDate - recurringIndicator - validUntil type: object properties: access: type: object description: Accesos solicitados a los servicios. x-ibm-languages: description: en: >- Access requested to services. Only sub attributes with tags "accounts", "balances" and "transactions" are accepted. Additionally, the ASPSP can support the "availableAccounts" or "allPsd2" sub attributes with the value "all-accounts". recurringIndicator: type: boolean description: 'true: acceso recurrente a la cuenta. false: un solo acceso.' example: true x-ibm-languages: description: en: 'true: recurring access to the account. false: a single access. ' validUntil: type: string description: >- Fecha hasta la que el consentimiento solicita acceso. Para crear el consentimiento con el máximo tiempo de acceso posible se debe usar el valor: 9999-12-31 Cuando se recupere el consentimiento, la fecha máxima posible vendrá ajustada. example: 2018-05-17T00:00:00.000Z x-ibm-languages: description: en: >- Date until the consent requests access. To create the consent with the maximum possible access time the value must be used: 9999-12-31 When the consent is recovered, the maximum possible date will be set. frequencyPerDay: type: integer description: >- Indica la frecuencia de acceso a la cuenta por día. 1 si es de un solo acceso. example: 4 x-ibm-languages: description: en: >- Indicates the frequency of access to the account per day. 1 if it is single access. lastActionDate: type: string description: Fecha de la última modificación realizada sobre el consentimiento. example: 2018-01-01T00:00:00.000Z x-ibm-languages: description: en: Date of the last modification made on the consent. consentStatus: type: string description: 'Valores permitidos: empty, valid, blocked, expired, deleted' example: valid x-ibm-languages: description: en: 'Allowed values: empty, valid, blocked, expired, deleted' _links: type: object description: >- Tipos de enlaces recomendados para esta respuesta: account y cardAccount. Dependiendo de la naturaleza del consentimiento. x-ibm-languages: description: en: >- Recommended link types for this response: account and cardAccount. Depending on the nature of the consent. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Informacion para PSU x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessage: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_PostConsentFundsConfirmation: required: - _links - consentStatus type: object properties: consentStatus: type: string description: >- Estado de autenticación del consentimiento. Ver valores definidos en 9.5 Estados de consentimiento example: received consentId: type: string description: >- Identificador del recurso que referencia al consentimiento. Debe ser contenido si se generó un consentimiento. scaMethods: type: object description: >- Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. Si este dato es contenido también se informará el link "startAuthorisationWithAuthenticationMethodSelection”. Esto métodos deberán ser presentados al PSU. Nota: Solo si ASPSP soporta selección del método SCA choosenScaMethod: type: object description: NO SOPORTADO PARA ESTA VERSION _links: type: object description: >- Lista de hipervínculos para ser reconocidos por el HUB. Tipos soportados en esta respuesta: scaRedirect: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el Hub. startAuthorisation: en caso de que un inicio explícito de la autorización de la transacción sea necesario (no hay selección del método SCA) startAuthorisationWithAuthenticationMethodSelection: link al end-point de autorización donde el sub-recurso de autorización tiene que ser generado mientras se selecciona el método SCA. Este enlace es contenido bajo las mismas condiciones que el campo "scaMethods". self: link al recurso de inicio de pago creado por esta petición. status: link para recuperar el estado de la transacción. scaStatus: link para consultar el estado SCA correspondiente al sub-recurso de autorización. Este link es solo contenido si un sub-recurso de autorización ha sido creado. (Si no hay autorización explícita este enlace debe venir obligatoriamente) psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Informacion para PSU x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessage: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true TppMessage: required: - category - code type: object properties: category: type: string description: >- Categoría del tipo de mensaje recibido. Posibles valores: ERROR o WARNING example: ERROR code: type: string description: Código de respuesta example: CONSENT_INVALID path: type: string description: Path al campo referenciando el error. example: /example/path text: type: string description: Texto adicional explicativo. example: Ejemplo de texto AccountReport: required: - _links type: object properties: booked: type: object description: >- Últimas transacciones (anotaciones) conocidas de la cuenta. Debe ser incluido si el parámetro bookingStatus está establecido a “booked” o “both”. x-ibm-languages: description: en: >- Last known transactions (bookings) on the account. Must be included if the bookingStatus parameter is set to "booked" or "both". pending: type: object description: >- Transacciones pendientes de la cuenta. No contenido si el parámetro bookinStatus está establecido a “booked”. x-ibm-languages: description: en: >- Pending account transactions. Not contained if the bookinStatus parameter is set to "booked". information: type: object description: >- Listado de órdenes permanentes. Incluido si el parámetro bookingStatus está establecido a "information" x-ibm-languages: description: en: >- List of standing orders. Included if the bookingStatus parameter is set to "information" _links: type: object description: >- Los siguientes links se aceptan en este objeto: account (OB), first (OP), next (OP), previous (OP), last (OP) x-ibm-languages: description: en: >- The following links are accepted in this object: account (OB), first (OP), next (OP), previous (OP), last (OP) AccountOwner: required: - name type: object properties: name: type: object description: Nombre propietario de la cuenta. x-ibm-languages: description: en: Account owner name. role: type: object description: >- Los siguientes códigos de propietarios son usados: "owner","legalRepresentative","authorisedUser" x-ibm-languages: description: en: >- The following owner codes are used: "owner", "legalRepresentative", "authorizedUser". additionalProperties: true Amount: required: - amount - currency type: object properties: currency: type: string description: Moneda del importe. example: EUR amount: type: string description: >- Cantidad del importe. El separador decimal es el punto. Representaciones válidas para EUR: 1056, 5768, 5877.78 example: '150.03' Balance: required: - balanceAmount - balanceType type: object properties: balanceAmount: type: object description: Importe y moneda del balance x-ibm-languages: description: en: Balance amount and currency balanceType: type: string description: >- Transacciones compuestas por las entradas anotadas y las entradas pendientes en el momento de la petición. example: closingBooked x-ibm-languages: description: en: >- Transactions composed of the entries entered and the pending entries at the time of the request. creditLimitIncluded: type: boolean description: >- Flag indicando si el límite de crédito de la cuenta correspondiente está incluido en el cálculo del balance, cuando aplique. example: true x-ibm-languages: description: en: >- Flag indicating if the credit limit of the corresponding account is included in the balance calculation, when applicable. lastChangeDateTime: type: string description: Fecha de la última acción realizada sobre la cuenta. example: 2017-10-25T15:30:35.035Z x-ibm-languages: description: en: Date of the last action performed on the account. referenceDate: type: string description: Fecha de referencia del balance example: 2017-10-25T00:00:00.000Z x-ibm-languages: description: en: Balance sheet reference date lastCommittedTransaction: type: string description: >- entryReference de la última transacción para ayudar al TPP a identificar si ya se conocen todas las transacciones del PSU. example: 1234-asd-567 x-ibm-languages: description: en: >- entryReference of the last transaction to help the TPP identify if all transactions of the PSU are already known. additionalProperties: true List_Transactions: type: array items: $ref: '#/components/schemas/Transactions' List_Balances: type: array items: $ref: '#/components/schemas/Balance' PaymentExchangeRate: type: object properties: unitCurrency: type: string description: >- Moneda en la que el tipo de intercambio es expresado en moneda extranjera. En el siguiente ejemplo 1EUR = xxxCUR, la unidad monetaria es el EUR. example: USD x-ibm-languages: description: en: >- Currency in which the exchange rate is expressed in foreign currency. In the following example 1EUR = xxxCUR, the currency unit is EUR. exchangeRate: type: string description: >- Factor usado para convertir un importe en una moneda a otra. Refleja el precio en el cual una moneda fue comprada con otra moneda. example: '0.8' x-ibm-languages: description: en: >- Factor used to convert an amount in one currency to another. Reflects the price at which one currency was purchased with another currency. contractIdentification: type: string description: >- Identificación única para identificar el contrato de cambio de divisas example: 1234-qeru-23 x-ibm-languages: description: en: Unique identification to identify the foreign exchange contract rateType: type: string description: >- Especifica el tipo usado para completar el cambio de moneda. Valores permitidos: SPOT, SALE, AGRD. x-ibm-languages: description: en: >- Specifies the type used to complete the currency exchange. Allowed values: SPOT, SALE, AGRD. Response_TrustedBeneficiary: required: - trustedBeneficiaries type: object properties: trustedBeneficiaries: type: object description: >- Este reporte contiene todos los beneficarios de confianza del PSU para aquellas cuentas que fueron consentidas. Este array podría devolverse vacío. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Informacion para PSU x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessage: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_AccountsList: required: - accounts type: object properties: accounts: type: object description: Listado de cuentas disponibles. x-ibm-languages: description: en: List of available accounts. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Informacion para PSU x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessage: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_AccountTransactions: type: object properties: accounts: type: object description: >- Identificador de la cuenta que se está consultando. Nota: recomendado usarlo ya que podría pasar a parámetro obligatorio en futuras versiones. x-ibm-languages: description: en: >- Identifier of the account being queried. Note: recommended to use it as it could become a mandatory parameter in future versions. transactions: type: object description: >- Devolución de los datos en formato JSON, cuando los datos devueltos tienen un tamaño pequeño. Este reporte contiene las transacciones resultantes de los parámetros de consulta. x-ibm-languages: description: en: >- Return of data in JSON format, when the returned data has a small size. This report contains the transactions resulting from the query parameters. balances: type: object description: Una lista de balances con respecto a una cuenta. x-ibm-languages: description: en: A list of balances regarding an account. _links: type: object description: >- Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta: download: Enlace de descarga de los datos de la consulta realizada, cuando los datos devueltos tienen un tamaño grande. Solo para camt-data. x-ibm-languages: description: en: >- List of hyperlinks to be recognized by the TPP. Types supported in this response: download: Link to download the data of the query performed, when the returned data has a large size. Only for camt-data. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Informacion para PSU x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessage: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_AccountBalances: required: - balances type: object properties: account: type: object description: Identificador de la cuenta que se está consultando. x-ibm-languages: description: en: Identifier of the account being consulted. balances: type: object description: Balances de la cuenta x-ibm-languages: description: en: Account balances psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Informacion para PSU x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessage: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_AccountDetail: required: - account type: object properties: account: type: object description: Información detallada de la cuenta x-ibm-languages: description: en: Detailed account information psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Informacion para PSU x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessage: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true StandingOrderDetails: required: - frequency - startDate type: object properties: startDate: type: string description: >- El primer día aplicable de ejecución desde esta fecha es el primer pago example: 2018-12-20T00:00:00.000Z endDate: type: string description: >- El último día aplicable dStandingOrderDetailse ejecución. Si no viene se trata de una orden permanente sin fin. example: 2019-01-20T00:00:00.000Z executionRule: type: string description: >- Valores soportados: following y preceding. Define el comportamiento cuando las fechas del pago recurrente caen en fin de semana o festivo. Entonces el pago se ejecuta el día laboral anterior o posterior. El ASPSP puede rechazar la petición debido al valor comunicado si las reglas de la Banca Online no soportan esta regla de ejecución. example: following withinAMonthFlag: type: boolean description: >- Este elemento es solo usado en caso de que la frecuencia sea igual a "Monthly". Si este elemento es igual a false, este no tiene efecto. Si es igual a true, entonces la regla de ejecución es anulada si el día de ejecución cae en un mes diferente. Nota: este atributo es usado raramente. example: true frequency: type: string description: >- La frecuencia del pago recurrente resultante de esta orden permanente. Valores permitidos: Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual. example: Monthly monthsOfExecution: type: array description: >- El formato sigue la expresión regular \d{1,2}. El array está restringido a 11 entradas. Los valores contenidos en el array deben ser todos diferentes y el valor máximo de una entrada es 12. El atributo es contenido si y solo si la frecuencia es igual a "MonthlyVariable". items: type: string multiplicator: type: integer description: >- Multiplicador de la frecuencia. Por ejemplo, frecuencia = semanal y muliplicador = 3 significa cada 3 semanas. example: 3 dayOfExecution: type: string description: >- "31" es último. Sigue la expresión regular \d{1,2} La fecha se refiere a la zona horaria del ASPSP. Solo si soportado en Banca Online. example: '1' limitAmount: type: object description: >- Importe límite para la extracción de fondos. Por ejemplo, extraer todos los fondos por encima de este límite a una cuenta de ahorro. Restricciones: transactionAmount debe ser cero y bankTransactionCode debe especificar PMNT-MCOP-OTHR para la extracción de fondos. additionalProperties: true StructuredAdditionalInformationDataType: required: - standingOrderDetails type: object properties: standingOrderDetails: type: object description: Detalles de la orden permanente additionalProperties: true TrustedBeneficiary: required: - creditorAccount - creditorName - trustedBeneficiaryId type: object properties: trustedBeneficiaryId: type: string description: Recurso identificador de la entrada en la lista. example: 'trustedBeneficiaryId: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' debtorAccount: type: object description: >- Proporcionado por el ASPSP si la entrada del beneficiario de confianza es aplicable solo a una cuenta específica. creditorAccount: type: object description: Cuenta del beneficiario creditorAgent: type: string description: >- Obligatorio cuando la información es obligatoria para la transferencia de crédito relacionada. Por ej. pagos fuera de la zona SEPA. creditorName: type: string description: Nombre del beneficiario como lo proporcionó el PSU. example: Nombre del beneficiario creditorAlias: type: string description: >- Alias definido por el PSU que es mostrado en mostrado en el listado de beneficiarios de confianza de los canales online del ASPSP. creditorId: type: string description: Dato a informar si existen en los canales online. example: '12345' creditorAddress: type: object description: Dirección del beneficiario si existe en los canales online. additionalProperties: true ReportExchangeRate: required: - exchangeRate - quotationDate - sourceCurrency - targetCurrency - unitCurrency type: object properties: sourceCurrency: type: string description: >- Moneda desde la que un importe será convertido en una conversión de moneda exchangeRate: type: string description: >- Factor usado para convertir un importe en una moneda a otra. Refleja el precio en el cual una moneda fue comprada con otra moneda. unitCurrency: type: string description: >- Moneda en la que el tipo de intercambio es expresado en moneda extranjera. En el siguiente ejemplo 1EUR = xxxCUR, la unidad monetaria es el EUR. targetCurrency: type: string description: >- Moneda en la cual un importe va a ser convertido en una conversión de moneda. quotationDate: type: string description: Fecha en que se cotiza un tipo de cambio. contractionIdentification: type: string description: >- Identificación única para identificar el contrato de cambio de divisas List_ReportExchangeRate: type: array items: $ref: '#/components/schemas/ReportExchangeRate' Transactions: required: - transactionAmount type: object properties: transactionId: type: string description: >- Identificador de la transacción. Puede ser usado como access-ID en la API, donde más detalles sobre la transación pueden ser ofrecidos. Si este dato es proporcionado se puede tener acceso a la petición de detalles de transacción. example: 123-asdf-456 x-ibm-languages: description: en: >- Transaction identifier. It can be used as access-ID in the API, where more details about the transaction can be provided. If this data is provided you can access the transaction details request. entryReference: type: string description: >- Identificación de la transacción que puede ser usada, por ejemplo, en las consultas delta. example: 1234-asdf-456 x-ibm-languages: description: en: >- Identification of the transaction that can be used, for example, in delta queries. endToEndId: type: string description: Identificador único end to end x-ibm-languages: description: en: Unique identifier end to end mandateId: type: string description: Identificación del mandato. Por ejemplo, un ID de un mandato SEPA. example: e733223hge7 x-ibm-languages: description: en: >- Identification of the mandate. For example, an ID of a SEPA command. checkId: type: string description: Identificador de un cheque x-ibm-languages: description: en: Identifier of a check creditorId: type: string description: >- Identificación del beneficiario. Por ejemplo, un ID de beneficiario SEPA. example: e7363987hge7 x-ibm-languages: description: en: 'Beneficiary identification. For example, a SEPA beneficiary ID. ' bookingDate: type: string description: Fecha de anotación de la transacción example: 2017-10-23T00:00:00.000Z x-ibm-languages: description: en: Transaction annotation date valueDate: type: string description: >- Fecha en la cual el asentamiento llega a estar disponible para el propietario de la cuenta en caso de un crédito. example: 2017-10-23T00:00:00.000Z x-ibm-languages: description: en: >- Date on which the settlement becomes available to the account owner in the event of a credit. transactionAmount: type: object description: Cantidad de la transaccion x-ibm-languages: description: en: Transaction amount currencyExchange: type: object description: Tasa de intercambio x-ibm-languages: description: en: Exchange rate creditorName: type: string description: Nombre del beneficiario si la transacción es un cargo. example: NombreEjemplo x-ibm-languages: description: en: Name of the beneficiary if the transaction is a charge. creditorAccount: type: object description: Cuenta del beneficiario. x-ibm-languages: description: en: Beneficiary account. creditorAgent: type: string description: BIC de la cuenta del beneficiario. example: '"creditorAgent": "XXXSDH"' x-ibm-languages: description: en: BIC of the beneficiary's account. ultimateCreditor: type: string description: Beneficiario final. x-ibm-languages: description: en: Final beneficiary. debtorName: type: string description: Nombre del ordenante example: NombreEjemplo x-ibm-languages: description: en: Name of the payer debtorAccount: type: object description: Cuenta del ordenante. x-ibm-languages: description: en: Account of the payer. debtorAgent: type: string description: BIC asociado al ASPSP ordenante. example: BIC x-ibm-languages: description: en: BIC associated to the ordering ASPSP. ultimateDebtor: type: string description: Nombre ordenante final. example: NombreEjemplo x-ibm-languages: description: en: Final ordering name. remittanceInformationUnstructured: type: string description: Campo para incluir información adicional del envío. example: Informacion adicional x-ibm-languages: description: en: Field to include additional shipping information. remittanceInformationUnstructuredArray: type: array description: >- Nota: en la versión 2 del estándar los dos remittanceUnstructured podrían unirse en uno solo items: type: string x-ibm-languages: description: en: >- Note: in version 2 of the standard the two remittanceUnstructured could be merged into one remittanceInformationStructured: type: string description: Campo para incluir una referencia example: 1234-asdf-456 x-ibm-languages: description: en: Field to include a reference remittanceInformationStructuredArray: type: array description: >- Nota: en la versión 2 del estándar los dos remittanceUnstructured podrían unirse en uno solo items: type: string x-ibm-languages: description: en: >- Note: in version 2 of the standard the two remittanceUnstructured could be merged into one additionalInformation: type: string description: Usado por el TPP para transportar información adicional del PSU x-ibm-languages: en: Used by the TPP to carry additional PSU information additionalInformationStructured: type: object description: >- Es usado solo si el campo bookingStatus contiene el valor "information". Cada orden permanente activa relacionada a la cuenta de pago resulta en una entrada. x-ibm-languages: description: en: >- It is used only if the bookingStatus field contains the value "information". Each active standing order related to the payment account results in one entry. purposeCode: type: string description: ExternalPurpose1Code ISO 20022 bankTransactionCode: type: string description: >- Códigos de transacción bancaria usados por el ASPSP y usando los sub-elementos de los códigos estructurados definidos en ISO 20022 x-ibm-languages: description: en: >- Bank transaction codes used by the ASPSP and using the sub-elements of the structured codes defined in ISO 20022 proprietaryBankTransactionCode: type: string description: Código de transacción propietario del banco x-ibm-languages: en: Bank proprietary transaction code balanceAfterTransaction: type: object description: >- Saldo después de la transacción. Balance recomendado es interimBooked x-ibm-languages: en: Balance after transaction. Recommended balance is interimBooked _links: type: object description: 'Valores posibles: • transactionDetails' x-ibm-languages: en: 'Possible values: - transactionDetails' additionalProperties: true Request_fundsConfirmation: required: - account - instructedAmount type: object properties: cardNumber: type: string description: >- Numeración de la tarjeta emitida por el PIISP. Debe ser enviada si está disponible. example: 1111-1111-1111-1111 x-ibm-languages: description: en: Card number issued by the PIISP. It must be sent if available. account: type: object description: Número de cuenta del PSU. x-ibm-languages: description: en: PSU account number. payee: type: string description: Comercio donde la tarjeta es aceptada como información para el PSU. example: Comercio x-ibm-languages: description: en: Commerce where the card is accepted as information for the PSU. instructedAmount: type: object description: Contiene la cantidad y moneda a consultar. x-ibm-languages: description: en: Contains the quantity and currency to consult. additionalProperties: true Response_fundsConfirmation: required: - fundsAvailable type: object properties: fundsAvailable: type: boolean description: >- Toma el valor "true" si hay suficientes fondos disponibles en el momento de la petición. "false" en otro caso. example: true x-ibm-languages: description: en: >- It takes the value "true" if there are enough funds available at the time of the request. "false" in another tppMessage: type: object description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP case. additionalProperties: true List_TppMessage: type: array items: $ref: '#/components/schemas/TppMessage' _SpecialServicePaymentEntity: required: - chargeType - entityCode - maximumAmount - paymentType - productName - servicePaymentName type: object properties: servicePaymentName: type: string description: Nombre del servicio de pago x-ibm-languages: description: en: Payment service name entityCode: type: integer description: Código de entidad. example: 12345 x-ibm-languages: description: en: Entity Code. paymentType: type: integer description: Tipo de pago. Vendrá con valor 2. example: 2 x-ibm-languages: description: en: Payment type. It will come with value 2. chargeType: type: integer description: Tipo de cargo. example: 1 x-ibm-languages: description: en: Type of charge. productName: type: string description: Nombre del producto que ofrece la entidad. example: productName x-ibm-languages: description: en: Name of the product offered by the entity. specialServicePaymentParameters: type: object additionalProperties: $ref: '#/components/schemas/ListSpecialServicePaymentEntityParameter' description: Lista de posibles importes admitidos x-ibm-languages: description: en: List of possible amounts admitted minimumAmount: type: object description: >- Indica el importe mínimo del Servicio de Pago. Importe mínimo acppetado es 0.01. x-ibm-languages: description: en: >- Indicates the minimum amount of the Payment Service. Minimum amount accepted is 0.01 maximumAmount: type: object description: >- Indica el importe máximo del Servicio de Pago. Importe máximo aceptado es 99999.99. x-ibm-languages: description: en: >- Indicates the maximum amount of the Payment Service. Maximum accepted amount is 99999.99 entitiesCorporateData: type: object description: Entity Corporate Capital Currency.. x-ibm-languages: description: en: Entity Corporate Capital Currency. additionalProperties: true ListSpecialServicePaymentEntity: type: array items: $ref: '#/components/schemas/_SpecialServicePaymentEntity' _EntityCorporateData: type: object properties: fiscalName: type: string description: Nombre fiscal de la entidad example: Van Egmond x-ibm-languages: description: en: Fiscal name of entity fiscalNumber: type: string description: Número fiscal de la entidad example: '6017337891225600' x-ibm-languages: description: en: Fiscal number of entity fiscalAddress: type: string description: Direccion fiscal de la entidad example: 362 Pocmos Highway x-ibm-languages: description: en: Fiscal address of entity fiscalRegister: type: string description: Registro fiscal de la entidad example: wupvucl x-ibm-languages: description: en: Fiscal register of entity corporateCapital: type: string description: Entity Corporate Capital Amount x-ibm-languages: description: en: Entity Corporate Capital Amount reference: type: string description: Descripcion referencia para factura example: Telemóvel x-ibm-languages: description: en: Description reference for invoice iva: type: string description: IVA factura x-ibm-languages: description: en: VAT invoice message: type: string description: Mensaje de la entidad al PSU example: OBRIGADO POR PREFERIR A companyName. CASO NECESSITE x-ibm-languages: description: en: Entity message to the PSU additionalProperties: true ListEntityCorporateData: type: array items: $ref: '#/components/schemas/_EntityCorporateData' _SpecialServicePaymentEntityParameter: required: - amount - code type: object properties: code: type: integer description: Código asociado al importe example: 1 x-ibm-languages: description: en: Code associated with the amount amount: type: string description: Importe. x-ibm-languages: description: en: Amount additionalProperties: true ListSpecialServicePaymentEntityParameter: type: array items: $ref: '#/components/schemas/_SpecialServicePaymentEntityParameter' _ServicePaymentEntity: required: - entityCode - maximumAmount - minimumAmount - paymentType - servicePaymentName type: object properties: servicePaymentName: type: string description: Nombre del servicio de pago x-ibm-languages: description: en: Payment service name minimumAmount: type: object description: >- Indica el importe mínimo del Servicio de Pago. Importe mínimo acppetado es 0.01. x-ibm-languages: description: en: >- Indicates the minimum amount of the Payment Service. Minimum amount accepted is 0.01 maximumAmount: type: object description: >- Indica el importe máximo del Servicio de Pago. Importe máximo aceptado es 99999.99. x-ibm-languages: description: en: >- Indicates the maximum amount of the Payment Service. Maximum accepted amount is 99999.99 entityCode: type: integer description: Código de entidad. example: 12345 x-ibm-languages: description: en: Entity Code. paymentType: type: integer description: Tipo de pago. Vendrá con valor 1. example: 1 x-ibm-languages: description: en: Payment type. It will come with value 1. additionalProperties: true ListServicePaymentEntity: type: array items: $ref: '#/components/schemas/_ServicePaymentEntity' _PaymentLiquidation: required: - code - name type: object properties: code: type: integer description: Código de liquidación example: 11 x-ibm-languages: description: en: Settlement code name: type: string description: Descripcion de la liquidacion example: ProdutoresAgricolas x-ibm-languages: description: en: Settlement description entityCode: type: integer description: Código de entidad example: 12345 x-ibm-languages: description: en: Entity code branch: type: integer description: >- Rama de liquidación de pago relacionada a la Entidad de liquidación de pago example: 54169188 x-ibm-languages: description: en: >- Payment settlement branch related to the payment settlement entity _PublicSectorPaymentEntity: required: - entityCode - paymentLiquidation type: object properties: entityCode: type: integer description: Codigo de entidad x-ibm-languages: description: en: Entity code paymentLiquidation: type: object description: Datos para la liquidación del pago x-ibm-languages: description: en: Data for payment settlement additionalProperties: true ListPublicSectorPaymentEntity: type: array items: $ref: '#/components/schemas/_PublicSectorPaymentEntity' _PaymentUnit: required: - maximun - minimun type: object properties: minimun: type: integer description: Unidad mínima naturaleza del pago example: 1 x-ibm-languages: description: en: Minimum unit nature of payment maximun: type: integer description: Unidad maxima naturaleza del pago example: 25 x-ibm-languages: description: en: Maximum unit nature of payment _Remuneration: required: - code - maximumAmount - minimumAmount - name type: object properties: code: type: integer description: Código de la remuneracion. example: 1 x-ibm-languages: description: en: Remuneration code. name: type: string description: Descripcion de la remuneracion. example: Mensal-MesCompleto x-ibm-languages: description: en: Remuneration description. minimumAmount: type: object description: Valor remuneración mensual efectiva mínima x-ibm-languages: description: en: Minimum effective monthly remuneration value maximumAmount: type: object description: Valor remuneración mensual efectiva máxima x-ibm-languages: description: en: Maximum effective monthly remuneration value additionalProperties: true _SocialSecurityPaymentParameters: type: object properties: paymentNature: type: object description: Naturaleza del pago para Seguridad Social de particulares x-ibm-languages: description: en: Nature of payment for Social Security of individuals tsuCenter: type: object description: Datos de los centros de la Seguridad Social TSU. x-ibm-languages: description: en: Data from the TSU Social Security centers. paymentUnit: type: object description: Unidad de pago. x-ibm-languages: description: en: Payment unit. remuneration: type: object description: Información relativa al tipo de remuneración. x-ibm-languages: description: en: Information regarding the type of remuneration. additionalProperties: true ListSocialSecurityPaymentParameters: type: array items: $ref: '#/components/schemas/_SocialSecurityPaymentParameters' _PublicSectorPaymentType: required: - code - name type: object properties: code: type: string description: Codigo de pago example: '01' x-ibm-languages: description: en: Payment code name: type: string description: Descripcion de tipo de pago example: PAGAMENTOPORCONTA1 x-ibm-languages: description: en: Payment type description ListPublicSectorPaymentType: type: array items: $ref: '#/components/schemas/_PublicSectorPaymentType' _PaymentPeriod: required: - year type: object properties: year: type: integer description: Año de pago example: 2020 x-ibm-languages: description: en: Year of payment month: type: integer description: Mes de pago example: 10 x-ibm-languages: description: en: Month of payment _Challenge: type: object description: NO SOPORTADO PARA ESTA VERSIÓN ResponseGetMultibankCatalogue: type: object properties: servicePaymentEntities: type: object description: >- Conjunto de parámetros genéricos del servicio de pago a tener en cuenta en la definición de interfaz del TPP. x-ibm-languages: description: en: >- Set of generic payment service parameters to take into account in the definition of the TPP interface. specialServicePaymentEntities: type: object description: >- Comprende todos los datos de pago relevantes de los servicios especiales x-ibm-languages: description: en: It includes all relevant payment details for special services. publicSectorPaymentEntities: type: object description: Comprende todos los datos relevantes de los pagos del sector público x-ibm-languages: description: en: It includes all relevant data of payments of the public sector. socialSecurityPaymentEntities: type: object description: >- Comprende todos los datos de pago relevantes de los servicios de pago a la seguridad social x-ibm-languages: description: en: >- It includes all the relevant payment data of the social security payment services. publicSectorPaymentTypes: type: object description: Comprende lo tipos de pago al sector público. x-ibm-languages: description: en: It includes the types of payment to the public sector.. _links: type: object description: >- Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta: x-ibm-languages: description: en: >- List of hyperlinks to be recognized by the TPP. Types supported in this answer: psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true RequestSocialSecurityWithholding: required: - debtorAccount - number - paymentDate - paymentNature - paymentUnit - remunerationAmount - remunerationCode type: object properties: debtorAccount: type: object description: Cuenta del ordenante x-ibm-languages: description: en: Payer's account paymentNature: type: integer description: Identifica la categoría profesional a la que pertenece el trabajador example: 4613978645 x-ibm-languages: description: en: Identify the professional category to which the worker belongs number: type: integer description: Numero de la seguridad social example: 10000000003 x-ibm-languages: description: en: Social security number remunerationCode: type: integer description: Unidad de pago en función del tipo de remuneración example: 1 x-ibm-languages: description: en: Payment unit according to the type of remuneration paymentUnit: type: integer description: Unidad de pago en función del tipo de remuneración example: 1 x-ibm-languages: description: en: Payment unit according to the type of remuneration remunerationAmount: type: object description: Salario generado en esa unidad de pago x-ibm-languages: description: en: Salary generated in that pay unit niss: type: integer description: >- Identificador de la empresa empleadora. Solo vendrá relleno opcionalmente cuando paymentNature es 3. Para el resto de casos no existe. example: 65136589331 x-ibm-languages: description: en: >- Employer company identifier. It will only optionally fill in when paymentNature is 3. For the rest of the cases it does not exist. paymentDate: type: string description: Fecha de realización del pago example: 2020-03-04T00:00:00.000Z x-ibm-languages: description: en: Payment date additionalProperties: true ResponseSocialSecurityWithholding: required: - entityName - operationReference - paymentState - withholding type: object properties: paymentState: type: integer description: Estado en el que se encuentra el pago example: 1 x-ibm-languages: description: en: State in which the payment is located invoiceNumber: type: string description: Número de factura example: '1234' x-ibm-languages: description: en: Invoice number entityName: type: string description: Nombre de la entidad example: company-name x-ibm-languages: description: en: Entity name withholding: type: object description: Importe a pagar x-ibm-languages: description: en: Payment amount operationReference: type: string description: Identificador único de la operación example: company-name x-ibm-languages: description: en: Unique operation id psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true RequestStartMultibankPayment: type: object properties: instructedAmount: type: object description: Importe de la transferencia x-ibm-languages: description: en: Transfer amount debtorAccount: type: object description: Cuenta del ordenante x-ibm-languages: description: en: Payer's account paymentReference: type: string description: Referencia del pago multibanco example: '123456789' x-ibm-languages: description: en: Multibank payment reference operationReference: type: string description: >- Referencia obtenida en la consulta de valor a pagar a la Seguridad Social example: 1501ab4e-6904-11ea-bc55-0242ac130003 x-ibm-languages: description: en: >- Reference obtained in the consultation of the value to be paid to Social Security paymentType: type: integer description: Tipo de pago a la seguridad social example: 1 x-ibm-languages: description: en: Type of payment to social security entityCode: type: integer description: Entidad del pago Multibanco example: 10003 x-ibm-languages: description: en: Entity of multibank payment parameterCode: type: integer description: >- Código de parámetro asociado al importe. Obtenido en la consulta de catálogo de special-service-payments example: 3 x-ibm-languages: description: en: >- Parameter code associated with the amount. Obtained from the special-service-payments catalog query taxpayerIdentificationNumber: type: integer description: Número de identificación del contribuyente example: 6244688226942976 x-ibm-languages: description: en: Taxpayer identification number paymentPeriod: type: object description: Periodo por el que se realiza el pago x-ibm-languages: description: en: Period for which the payment is made tsuCenterCode: type: integer description: Código del centro TSU example: 2698 x-ibm-languages: description: en: TSU center code requestedExecutionDate: type: string description: Fecha de ejecución futura example: 2018-05-17T00:00:00.000Z x-ibm-languages: description: en: Future execution date paymentTypeCode: type: string description: >- Código del tipo de pago. Devuelto en el catalogo de tipos pagos al sector público example: '05' x-ibm-languages: description: en: >- Payment type code. Returned in the catalog of types paid to the public sector additionalProperties: true ResponseStartMultibankPayment: required: - paymentId - transactionStatus type: object properties: transactionStatus: type: string description: Estado de la transacción. example: RCVD x-ibm-languages: description: en: Transaction status. paymentId: type: string description: Identificador del recurso que referencia a la iniciación de pago. example: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: Resource identifier that refers to the payment initiation. transactionFees: type: object description: Comisiones asociadas al pago. x-ibm-languages: description: en: Fees associated with payment. 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. example: false x-ibm-languages: description: en: >- If it is equal to "true", the transaction will incur a commission according to the ASPSP or as agreed between the ASPSP and PSU. invoiceNumber: type: boolean description: Número de factura/recibo example: false x-ibm-languages: description: en: Invoice / receipt number scaMethods: type: object description: >- Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. Si este dato es contenido también se informará el link "selectAuthenticationM ethod”. Estos métodos deberán ser presentados al PSU. Nota: Solo si ASPSP soporta selección del método SCA x-ibm-languages: description: en: >- This element is content if SCA is required and if the PSU can choose between different authentication methods. If this data is content, the link selectAuthenticationMethod will also be reported. These methods must be presented to the PSU. Note: Only if ASPSP supports selection of the SCA method chosenScaMethod: type: object description: NO SOPORTADO EN ESTA VERSIÓN. SOLO EMBEBIDO x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION. _links: type: object description: Lista de hipervínculos para ser reconocidos por el TPP x-ibm-languages: description: en: List of hyperlinks to be recognized by the TPP psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true ResponseGetStatusMultibankPayment: required: - transactionStatus type: object properties: transactionStatus: type: string description: Estado de la transacción. example: ACCP x-ibm-languages: description: en: Transaction status. fundsAvailable: type: boolean description: >- Este dato es contenido si es soportado por el ASPSP, si una confirmación de fondos ha sido realizada y si el "transactionStatus" es alguno de los siguientes •ACTC• ACWC• ACCP example: true x-ibm-languages: description: en: >- This data is contained if it is supported by the ASPSP, if a funds confirmation has been made and if the "transactionStatus" is any of the following • ACTC • ACWC • ACCP psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true ResponseGetMultibankPayment: type: object properties: instructedAmount: type: object description: Importe de la transferencia . x-ibm-languages: description: en: Transfer amount. debtorAccount: type: object description: Cuenta del ordenante . x-ibm-languages: description: en: Payer's account. paymentReference: type: string description: Referencia del pago Multibanco . example: '123456789' x-ibm-languages: description: en: Multibank payment reference. operationReference: type: string description: >- Referencia obtenida en la consulta de valor a pagar a la Seguridad Social. example: 1501ab4e-6904-11ea-bc55-0242ac130003 x-ibm-languages: description: en: >- Reference obtained in the consultation of the value to be paid to Social Security. paymentType: type: integer description: >- Valores posibles para service-payments 1- Servicios 2 – Compras Valores posibles para special-service-payments - Devueltos en catálogo example: 1 x-ibm-languages: description: en: >- Reference obtained in the consultation of the value to be paid to Social Security. entityCode: type: integer description: Entidad del pago Multibanco example: 1 x-ibm-languages: description: en: Multibanco payment entity. parameterCode: type: integer description: >- Código de parámetro asociado al importe. Obtenido en la consulta de catálogo de special-service-payments example: 3 x-ibm-languages: description: en: >- Parameter code associated with the amount. Obtained from the special-service-payments catalog query. taxpayerIdentificationNumber: type: integer description: Número de identificación del contribuyente example: 6244688226942976 x-ibm-languages: description: en: Taxpayer identification number. paymentPeriod: type: object description: Periodo por el que se realiza el pago x-ibm-languages: description: en: Period for which the payment is made. tsuCenterCode: type: integer description: Código del centro TSU example: 2698 x-ibm-languages: description: en: TSU center code. requestedExecutionDate: type: string description: Fecha de ejecución futura example: 2018-05-17T00:00:00.000Z x-ibm-languages: description: en: Future execution date. paymentTypeCode: type: string description: >- Código del tipo de pago. Devuelto en el catalogo de tipos pagos al sector público example: '05' x-ibm-languages: description: en: >- Payment type code. Returned in the catalog of types paid to the public sector. transactionStatus: type: string description: Estado de la transacción example: ACCP x-ibm-languages: description: en: Transaction status. invoiceNumber: type: string description: Número de factura/recibo example: '12345678901234567890' x-ibm-languages: description: en: Invoice / receipt number. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true ResponseDeleteMultibankPayment: required: - transactionStatus type: object properties: transactionStatus: type: string description: Estado de la transacción example: ACCP x-ibm-languages: description: en: Transaction status. scaMethods: type: object description: >- Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. x-ibm-languages: description: en: >- This element is contained if SCA is required and if the PSU can choose between different authentication methods. chosenScaMethod: type: object description: NO SOPORTADO PARA ESTA VERSIÓN x-ibm-languages: description: en: NOT SUPPORTED FOR THIS VERSION challengeData: type: object description: NO SOPORTADO PARA ESTA VERSIÓN x-ibm-languages: description: en: NOT SUPPORTED FOR THIS VERSION _links: type: object description: Lista de hipervinculos x-ibm-languages: description: en: Hyperlink list psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true ResponseMultibankAuthorizeConsentEstablishment: required: - _links - authorisationId - scaStatus type: object properties: scaStatus: type: string description: Estado SCA example: received x-ibm-languages: description: en: SCA status. authorisationId: type: string description: >- Identificador del recurso que referencia al sub-recurso de autorización creado example: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Resource identifier that refers to the authorization sub-resource created. scaMethods: type: object description: >- Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. Si este dato es contenido también se informará el link "selectAuthenticationM ethod”. Estos métodos deberán ser presentados al PSU. Nota: Solo si ASPSP soporta selección del método SCA x-ibm-languages: description: en: >- This element is content if SCA is required and if the PSU can choose between different authentication methods. If this data is content, the link selectAuthenticationMethod will also be reported. These methods must be presented to the PSU. Note: Only if ASPSP supports selection of the SCA method chosenScaMethod: type: object description: NO SOPORTADO EN ESTA VERSIÓN x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION challengeData: type: object description: NO SOPORTADO EN ESTA VERSIÓN x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION _links: type: object description: Lista de hipervínculos para ser reconocidos por el TPP x-ibm-languages: description: en: List of hyperlinks to be recognized by the TPP psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true RequestActualizarDatosPsu: type: object properties: authenticationMethodId: type: string description: Identificador del método de autenticación. example: '123' x-ibm-languages: description: en: Authentication method identifier. ResponseMultibankSelectSCAMethod: required: - _links - scaStatus type: object properties: chosenScaMethod: type: object description: NO SOPORTADO EN ESTA VERSIÓN x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION challengeData: type: object description: NO SOPORTADO EN ESTA VERSIÓN x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION _links: type: object description: Lista de hipervínculos para ser reconocidos por el TPP x-ibm-languages: description: en: List of hyperlinks to be recognized by the TPP scaStatus: type: string description: Estado SCA. example: received x-ibm-languages: description: en: SCA status. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true ResponseMultibankAuthorizationSubresources: type: object properties: authorisationIds: type: array description: Array de authorisationIds. items: type: string cancellationIds: type: array description: >- Array de cancellationIds conectados al recurso de pago. Nota: obligatorio si se trata de una cancelación items: type: string psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true ResponseMultibankGetSCAStatus: required: - scaStatus type: object properties: scaStatus: type: string description: Estado SCA example: finalised x-ibm-languages: description: en: SCA status. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Address: required: - country type: object properties: streetName: type: string description: Calle example: Ejemplo de Calle x-ibm-languages: description: en: Street buildingNumber: type: string description: Numero example: '5' x-ibm-languages: description: en: Number townName: type: string description: Ciudad example: Cordoba x-ibm-languages: description: en: City postCode: type: string description: Codigo Postal example: '14100' x-ibm-languages: description: en: Postal Code country: type: string description: Pais example: ES x-ibm-languages: description: en: Country List_Other: type: array items: $ref: '#/components/schemas/Other' List_SingleBulkPayment: type: array items: $ref: '#/components/schemas/SingleBulkPayment' OrganisationIdentification: type: object properties: others: type: object description: Lista de "others" x-ibm-languages: description: en: List of "others" Other: required: - identification type: object properties: identification: type: string description: Entrada proporcionada por una lista de códigos ISO externa x-ibm-languages: description: en: Input provided by an external ISO code list PartyIdentification: type: object properties: organisationId: type: object description: Entrada proporcionada por una lista de códigos ISO externa x-ibm-languages: description: en: Input provided by an external ISO code list Request_BulkPayment: required: - debtorAccount - payments type: object properties: batchBookingPreferred: type: boolean description: >- Si este elemento es true, el PSU prefiere solo una anotación. Si este elemento es igual a false, el PSU prefiere anotaciones individuales de todas las transacciones individuales contenidas. El ASPSP seguirá esta preferencia de acuerdo al contrato con el PSU. example: true x-ibm-languages: description: en: >- If this element is true, the PSU prefers only one annotation. If this element is equal to false, the PSU prefers individual annotations of all the individual transactions contained. The ASPSP will follow this preference according to the contract with the PSU. debtorAccount: type: object description: Cuenta del ordenante. x-ibm-languages: description: en: Account of the payer. paymentInformationId: type: string description: >- Identificador único asignado por la parte iniciadora para identificar el pago bulk. Este atributo puede ser usado por el ASPSP como un campo opcional. x-ibm-languages: description: en: >- Unique identifier assigned by the initiating party to identify the bulk payment. This attribute can be used by the ASPSP as an optional field. requestedExecutionDate: type: string description: >- Si es contenido, los pagos contenidos en el lote serán ejecutados en la fecha indicada. Este campo podría no ser usado junto con el campo requestedExecutionTime x-ibm-languages: description: en: >- If it is content, the payments contained in the lot will be executed on the indicated date. This field may not be used together with the requestedExecutionTime field requestedExecutionTime: type: string description: >- Si es contenido, los pagos contenidos en el lote serán ejecutados en la fecha/hora indicada. Este campo podría no ser usado junto con el campo requestedExecutionDate x-ibm-languages: description: en: >- If it is content, the payments contained in the lot will be executed on the date / time indicated. This field may not be used together with the requestedExecutionDate field payments: type: array description: >- Este elemento es un array de inicios de pago en notación JSON para los productos de pago soportados. Excluyendo los datos: • debtorAccount • requestedExecutionDate • requestedExecutionTime items: type: object x-ibm-languages: description: en: >- This element is an array of payment starts in JSON notation for supported payment products. Excluding data: • debtorAccount • requestedExecutionDate • requestedExecutionTime additionalProperties: true Request_PeriodicPayment: required: - startDate type: object properties: startDate: type: string description: >- El primer día aplicable de ejecución desde esta fecha es el primer pago x-ibm-languages: description: en: >- The first applicable day of execution from this date is the first payment executionRule: type: string description: >- Define el comportamiento cuando las fechas del pago recurrente caen en fin de semana o festivo. Entonces el pago se ejecuta el día laboral anterior o posterior x-ibm-languages: description: en: >- Define the behavior when recurring payment dates fall on weekends or holidays. Then the payment is executed the previous or subsequent business day endDate: type: string description: >- El último día aplicable de ejecución. Si no viene se trata de una orden permanente sin fin. x-ibm-languages: description: en: >- The last applicable day of execution. If it does not come, it is an endless permanent order. frequency: type: string description: >- La frecuencia del pago recurrente resultante de esta orden permanente x-ibm-languages: description: en: >- The frequency of recurring payment resulting from this permanent order dayOfExecution: type: string description: La fecha se refiere a la zona horaria del ASPSP x-ibm-languages: description: en: The date refers to the time zone of the ASPSP Response_PaymentInitiation: required: - paymentId - transactionStatus type: object properties: transactionStatus: type: string description: Estado de la transaccion example: RCVD x-ibm-languages: description: en: Transaction Status paymentId: type: string description: Identificador del recurso que referencia a la iniciación de pago. example: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 x-ibm-languages: description: en: >- Identifier of the resource that refers to the initiation of payment. transactionFees: type: object description: Comisiones asociadas al pago. x-ibm-languages: description: en: Fees associated with payment. 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. x-ibm-languages: description: en: >- It could be used by the ASPSP to carry currency-specific conversion fees associated with the initiated credit transfer. estimatedTotalAmount: type: object 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 estimated to be withdrawn from the payer´s account. Note: this amount includes commissions. estimatedInterbankSettlemenAmount: type: object description: Importe estimado a ser transferido al beneficiario. x-ibm-languages: description: en: Estimated amount to be transferred to the beneficiary. 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", la transacción no implicará ninguna comisión adicional para el PSU. example: false x-ibm-languages: description: en: >- If it is equal to "true", the transaction will involve a commission according to the ASPSP or as agreed between ASPSP and PSU. If it is equal to "false", the transaction will not imply any additional commission for the PSU. scaMethods: type: object description: >- Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. x-ibm-languages: description: en: >- This element is content if SCA is required and if the PSU can choose between different authentication methods. choosenScaMethod: type: object description: NO SOPORTADO EN ESTA VERSIÓN. SOLO EMBEBIDO x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION. EMBEDDED ONLY _links: type: object description: >- Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta: x-ibm-languages: description: en: >- List of hyperlinks to be recognized by the TPP. Types supported in this answer: psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_GetStatusPayment: required: - transactionStatus type: object properties: transactionStatus: type: string description: >- Estado de la transacción de pago. Valores definidos en 9.4 Estados de transacción fundsAvailable: type: boolean description: >- Este dato es contenido si es soportado por el ASPSP, si una confirmación de fondos ha sido realizada y si el “transactionStatus” es ATCT, ACWC, ACCP psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. ownerNames: type: object description: Listado de nombres de propietarios de la cuenta. x-ibm-languages: description: en: List of names of account owners. psuName: type: string description: >- Nombre del PSU conectado.En caso de cuentas corporativas, esto podría ser la persona que actúe en nombre de la empresa. example: Heike Mustermann x-ibm-languages: description: en: >- Name of the connected PSU. In case of corporate accounts, this could be the person acting on behalf of the company. Response_GetInfoPayment: required: - transactionStatus type: object properties: transactionStatus: type: string description: Estado de la transacción. Valores definidos en anexos. Código corto. debtorName: type: string description: >- Nombre del PSU. En caso de que no sea proporcionado por el TPP, el ASPSP puede devolverlo por necesidades regulatorias. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true description: >- Los campos a devolver son los de la petición de inicio de pago original, más los siguientes: Response_CancelPaymentInitiation: required: - transactionStatus type: object properties: transactionStatus: type: string description: Estado de la transacción. scaMethods: type: object description: >- Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. choosenScaMethod: type: object description: NO SOPORTADO EN ESTA VERSIÓN. SOLO EMBEBIDO x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION. EMBEDDED ONLY _links: type: object description: >- Lista de hipervínculos para ser reconocidos por el TPP. Dependen de la decisión que tome el ASPSP dinámicamente al evaluar la operación. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. Remittance: required: - reference type: object properties: reference: type: string description: Refencia actual referenceType: type: string description: Tipo de la refencia referenceIssuer: type: string description: Emisor de la refencia List_Remittance: type: array items: $ref: '#/components/schemas/Remittance' SinglePayment: type: object properties: endToEndIdentification: type: string description: Identificador único end to end. x-ibm-languages: description: en: Unique end to end identifier. instructionIdentification: type: string description: >- Identificación única de la instrucción asignada por la parte instructora x-ibm-languages: description: en: >- Unique identification of the instruction assigned by the instructing party debtorName: type: string description: Nombre del ordenante x-ibm-languages: description: en: Name of payer debtorAccount: type: object description: >- Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk x-ibm-languages: description: en: >- Account of the payer. Note: this field may be optional in some services such as bulk payments. debtorId: type: string ultimateDebtor: type: string instructedAmount: type: object description: Información de la transferencia realizada. x-ibm-languages: description: en: Transfer information made. currencyOfTranfer: type: string exchangeRateInformation: type: object creditorAccount: type: object description: >- Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk x-ibm-languages: description: en: >- Account of the payer. Note: this field may be optional in some services such as bulk payments. creditorAgent: type: string description: BIC de la cuenta del beneficiario example: XXXLESMMXXX x-ibm-languages: description: en: BIC of the beneficiary's account creditorName: type: string description: Nombre del beneficiario example: Nombre x-ibm-languages: description: en: Beneficiary Name creditorId: type: string creditorAddress: type: object description: Direccion Beneficiario x-ibm-languages: description: en: Beneficiary Address creditorNameAndAddress: type: string purposeCode: type: string description: Lista de códigos ISO x-ibm-languages: description: en: List of ISO codes chargeBearer: type: string description: 'Valores permitidos: Valores permitidos: • DEBT • CRED • SHAR • SLEV' example: SLEV x-ibm-languages: description: en: 'Allowed values: Allowed values: • DEBT • CRED • SHAR • SLEV' serviceLevel: type: string description: Nivel de servicio. x-ibm-languages: description: en: Level of service. remittanceInformationUnstructured: type: string description: Informacion Adicional example: Informacion adicional x-ibm-languages: description: en: Additional Information remittanceInformationUnstructuredArray: type: array items: type: string remittanceInformationStructured: type: object remittanceInformationStructuredArray: type: object requestedExecutionDate: type: string description: Fecha de ejecución x-ibm-languages: description: en: Date of execution requestedExecutionTime: type: string description: Fecha/hora de ejecución x-ibm-languages: description: en: Date/time of execution additionalProperties: true SingleBulkPayment: type: object properties: instructedAmount: type: object description: Información de la transferencia realizada. x-ibm-languages: description: en: Transfer information made. creditorName: type: string description: Nombre del beneficiario example: Nombre x-ibm-languages: description: en: Beneficiary Name creditorAccount: type: object description: >- Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk x-ibm-languages: description: en: >- Account of the payer. Note: this field may be optional in some services such as bulk payments. creditorAgent: type: string description: BIC de la cuenta del beneficiario example: XXXLESMMXXX x-ibm-languages: description: en: BIC of the beneficiary's account creditorAddress: type: object description: Direccion Beneficiario x-ibm-languages: description: en: Beneficiary Address remittanceInformationUnstructured: type: string description: Informacion Adicional example: Informacion adicional x-ibm-languages: description: en: Additional Information endToEndIdentification: type: string description: >- Identificador único de la operación asignado por la parte iniciadora (TPP) chargeBearer: type: string description: 'Valores permitidos: Valores permitidos: • DEBT • CRED • SHAR • SLEV' example: SLEV x-ibm-languages: description: en: 'Allowed values: Allowed values: • DEBT • CRED • SHAR • SLEV' Request_UpdatePSUData: required: - authenticationMethodId type: object properties: authenticationMethodId: type: string description: Identificador del método de autenticación Response_GetSubResourcesAuthorization: type: object properties: authorisationIds: type: array description: Array de authorisationIds. items: type: string psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_AuthorizationInitiationPayment: required: - _links - authorisationId - scaStatus type: object 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. 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. estimatedTotalAmount: type: object description: >- Importe el cual se estima que será retirado de la cuenta del ordenante. Este importe incluye comisiones. estimatedInterbankSettlementAmount: type: object description: Importe estimado a ser transferido al beneficiario. scaStatus: type: string description: Estado SCA authorisationId: type: string description: >- Identificador del recurso que referencia al sub-recurso de autorización creado scaMethods: type: object additionalProperties: $ref: '#/components/schemas/List_AuthenticationObject' 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 choosenScaMethod: type: object description: NO SOPORTADO EN ESTA VERSIÓN. SOLO EMBEBIDO x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION. EMBEDDED ONLY _links: type: object 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. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_UpdatePSUData: required: - _links - scaStatus type: object 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. 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. currencyCoversionFees: 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. x-ibm-languages: description: en: >- It could be used by the ASPSP to carry currency-specific conversion fees associated with the initiated credit transfer. estimatedTotalAmount: type: object 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. estimatedInterbankSettlementAmount: type: object description: Importe estimado a ser transferido al beneficiario. x-ibm-languages: description: en: Estimated amount to be transferred to the beneficiary. 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. choosenScaMethod: type: object description: NO SOPORTADO EN ESTA VERSIÓN. SOLO EMBEBIDO x-ibm-languages: description: en: NOT SUPPORTED IN THIS VERSION. EMBEDDED ONLY _links: type: object description: >- Lista de hipervínculos para ser reconocidos por el HUB. Tipos soportados en esta respuesta: • scaRedirect: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el 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: type: string description: Estado SCA psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Response_GetSCAStatus: required: - scaStatus type: object properties: scaStatus: 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: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: type: object description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. additionalProperties: true Aspsp: required: - bic type: object properties: bic: type: string description: Código BIC del ASPSP example: XXXXXXXXXXX name: type: string description: Nombre del ASPSP example: Nombre ASPSP apiName: type: string description: >- Nombre del ASPSP usado en el PATH de la petición. Nota: Solo disponible para versión 2 del listado de ASPSPs disponibles. example: nombreBanco List_Aspsp: type: array items: $ref: '#/components/schemas/Aspsp' Request_PeriodicPaymentInitiation: allOf: - $ref: '#/components/schemas/SinglePayment' - required: - frequency - startDate type: object properties: startDate: type: string description: >- El primer día aplicable de ejecución desde esta fecha es el primer pago x-ibm-languages: description: en: >- The first applicable day of execution from this date is the first payment executionRule: type: string description: >- Define el comportamiento cuando las fechas del pago recurrente caen en fin de semana o festivo. Entonces el pago se ejecuta el día laboral anterior o posterior x-ibm-languages: description: en: >- Define the behavior when recurring payment dates fall on weekends or holidays. Then the payment is executed the previous or subsequent business day endDate: type: string description: >- El último día aplicable de ejecución. Si no viene se trata de una orden permanente sin fin. x-ibm-languages: description: en: >- The last applicable day of execution. If it does not come, it is an endless permanent order. frequency: type: string description: >- La frecuencia del pago recurrente resultante de esta orden permanente x-ibm-languages: description: en: >- The frequency of recurring payment resulting from this permanent order dayOfExecution: type: string description: La fecha se refiere a la zona horaria del ASPSP x-ibm-languages: description: en: The date refers to the time zone of the ASPSP Response_AvailableASPSPs: required: - aspsps - tppMessages type: object properties: aspsps: type: array items: $ref: '#/components/schemas/List_Aspsp' tppMessages: type: object x-original-swagger-version: '2.0'