--- swagger: "2.0" info: description: API de Redsys para PSD2 version: 1.1.0 title: Servicio para establecer consentimientos AIS y FCS x-ibm-name: api-110dc52c contact: name: Soporte PSD2 email: psd2.sandbox.soporte@redsys.es x-ibm-languages: title: en: Service for establishing AIS and FCS consents x-ibm-configuration: enforced: true testable: true phase: realized produces: - application/json consumes: - application/json schemes: - https securityDefinitions: RedsysClientSecret: type: apiKey description: Clave acceso consumidor APIS in: header name: X-IBM-Client-Secret RedsysClientId: type: apiKey description: Identificador consumidor APIS in: header name: X-IBM-Client-Id security: - RedsysClientId: [] basePath: / definitions: AuthenticationObject: properties: authenticationType: type: string authenticationVersion: type: string authenticationMethodId: type: string name: type: string explanation: type: string AdditionalInformationAccess: properties: trustedBeneficiaries: description: Está solicitando acceso a los beneficiarios de confianza de la cuenta referenciada y relacionada al PSU. si se informa será ignorado por el ASPSP. x-ibm-languages: description: en: You are requesting access to the trusted beneficiaries of the account referenced and related to the PSU. if it is reported it will be ignored by the ASPSP. $ref: '#/definitions/List_AccountReference' ownerName: description: Si se informa será ignorado por el ASPSP x-ibm-languages: description: en: If reported it will be ignored by ASPSP $ref: '#/definitions/List_AccountReference' AccountAccess: properties: accounts: $ref: '#/definitions/List_AccountReference' description: Indica las cuentas sobre las que pedir información detallada. Si la lista está vacía, el TPP está solicitando todas las cuentas accesibles. x-ibm-languages: description: en: 'Indicates the accounts on which to request detailed information. If the list is empty, the TPP is requesting all accessible accounts. ' balances: properties: [] $ref: '#/definitions/List_AccountReference' description: Indica las cuentas sobre las que pedir saldos. Si la lista está vacía, el TPP está solicitando los saldos de todas las listas de cuentas accesibles. x-ibm-languages: description: en: 'Indicates the accounts to request balances. If the list is empty, the TPP is requesting the balances of all lists of accessible accounts. ' transactions: properties: [] $ref: '#/definitions/List_AccountReference' description: Indica las cuentas sobre las que pedir transacciones. Si la lista está vacía, el TPP está solicitando las transacciones de todas las listas de cuentas accesibles. x-ibm-languages: description: en: 'Indicates the accounts on which to request transactions. If the list is empty, the TPP is requesting transactions from all lists of accessible accounts. ' additionalInformation: properties: [] $ref: '#/definitions/AdditionalInformationAccess' description: la información contenida en este objeto será ignorada por el ASPSP. x-ibm-languages: description: en: the information contained in this object will be ignored by the ASPSP. availableAccounts: properties: [] type: string description: Solo el valor “allAccounts” es admitido x-ibm-languages: description: en: Only the "allAccounts" value is supported example: allAccounts availableAccountsWithBalance: properties: [] type: string description: Solo el valor “allAccounts” es admitido x-ibm-languages: description: en: Only the "allAccounts" value is supported example: allAccounts allPsd2: properties: [] type: string example: allAccounts description: Solo el valor “allAccounts” es admitido x-ibm-languages: description: en: Only the "allAccounts" value is supported additionalProperties: false AccountDetails: properties: iban: properties: [] type: string description: IBAN de la cuenta x-ibm-languages: description: en: Account IBAN bban: properties: [] type: string description: BBAN de la cuenta, cuando esta no tiene IBAN. x-ibm-languages: description: en: Account BBAN, when it does not have IBAN. msisdn: properties: [] type: string description: Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado. x-ibm-languages: description: en: Alias ​​to access a payment account through a registered mobile phone number. currency: properties: [] type: string description: Tipo de moneda x-ibm-languages: description: en: Currency type additionalProperties: false example: "" AccountReference: type: object properties: iban: type: string example: ES1111111111111111111111 description: IBAN de la cuenta x-ibm-languages: description: en: Account IBAN bban: type: string description: BBAN de la cuenta, cuando esta no tiene IBAN. x-ibm-languages: description: en: Account BBAN, when it does not have IBAN. example: "20385778983000760236" pan: type: string description: Número de la tarjeta de la cuenta. Puede ser tokenizado por el ASPSP para cumplir los requerimientos de PCI DSS.Campo no soportado por el HUB. x-ibm-languages: description: en: Account card number. It can be tokenized by the ASPSP to meet the requirements of PCI DSS. Field not supported by the HUB. example: "1234567891234567" maskedPan: type: string description: Número de la tarjeta de la cuenta de forma enmascarda. Campo no soportado por el HUB. x-ibm-languages: description: en: Account card number masked. Field not supported by the HUB. example: 123456******4567 msisdn: type: string description: Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado. x-ibm-languages: description: en: Alias ​​to access a payment account through a registered mobile phone number. example: "1549951988" currency: type: string description: Tipo de moneda. x-ibm-languages: description: en: Type of currency. example: EUR Href: properties: href: type: string description: Contiene un enlace a un recurso example: /v1.1/payments/sepa-credit-transfers/asd-1234-jkl Links: properties: scaRedirect: $ref: '#/definitions/Href' scaOAuth: $ref: '#/definitions/Href' startAuthorisation: $ref: '#/definitions/Href' startAuthorisationWithAuthenticationMethodSelection: $ref: '#/definitions/Href' selectAuthenticationMethod: $ref: '#/definitions/Href' self: $ref: '#/definitions/Href' status: $ref: '#/definitions/Href' scaStatus: $ref: '#/definitions/Href' account: $ref: '#/definitions/Href' balances: $ref: '#/definitions/Href' transactions: $ref: '#/definitions/Href' first: $ref: '#/definitions/Href' next: $ref: '#/definitions/Href' previous: $ref: '#/definitions/Href' last: $ref: '#/definitions/Href' download: $ref: '#/definitions/Href' List_AuthenticationObject: type: array items: $ref: '#/definitions/AuthenticationObject' List_AccountDetails: type: array items: $ref: '#/definitions/AccountDetails' List_AccountReference: type: array items: $ref: '#/definitions/AccountReference' Request_GetConsent: type: object properties: access: x-ibm-languages: description: en: 'Access requested to services. Only sub attributes with tags "accounts", "balances" and "transactions" are accepted. Additionally, the ASPSP can support the "availableAccounts" or "allPsd2" sub attributes with the value "all-accounts". ' $ref: '#/definitions/AccountAccess' recurringIndicator: type: boolean description: 'true: acceso recurrente a la cuenta. false: un solo acceso.' x-ibm-languages: description: en: 'true: recurring access to the account. false: a single access. ' example: "true" validUntil: type: string description: 'Fecha hasta la que el consentimiento solicita acceso. Para crear el consentimiento con el máximo tiempo de acceso posible se debe usar el valor: 9999-12-31 Cuando se recupere el consentimiento, la fecha máxima posible vendrá ajustada. La validez también incluye hasta la fecha solicitada.' x-ibm-languages: description: en: 'Date until the consent requests access. To create the consent with the maximum possible access time the value must be used: 9999-12-31 When the consent is recovered, the maximum possible date will be set. The validity also includes up to the requested date.' example: "2020-05-17" frequencyPerDay: type: integer description: Indica la frecuencia de acceso a la cuenta por día. 1 si es de un solo acceso. x-ibm-languages: description: en: Indicates the frequency of access to the account per day. 1 if it is single access. example: "4" combinedServiceIndicator: type: boolean description: Indica que un inicio de pago se realizará en la misma sesión. De momento el HUB no implementará servicios combinados por lo que este campo deberá tomar el valor de falso. x-ibm-languages: description: en: Indicates that a payment start will be made in the same session. At the moment the HUB will not implement combined services so this field should take the value of false. example: "false" additionalProperties: true required: - access - recurringIndicator - validUntil - frequencyPerDay - combinedServiceIndicator Request_PostConsentFundsConfirmation: properties: account: $ref: '#/definitions/AccountReference' description: Cuenta sobre la que se realizará la consulta de fondos. x-ibm-languages: description: en: Account on which the funds inquiry will be carried out. cardNumber: type: string description: Número de tarjeta de la tarjeta emitida por el PIISP. Debe ser enviada si está disponible. x-ibm-languages: description: en: Card number of the card issued by the PIISP. It must be sent if available. example: 4548-8100-0000-0001 cardExpiryDate: type: string description: Fecha de caducidad de la tarjeta emitida por el PIISP. (Formato ISODate) x-ibm-languages: description: en: Expiration date of the card issued by the PIISP. (ISODate format) example: "2018-05-17" cardInformation: type: string description: Explicación adicional del producto. x-ibm-languages: description: en: Additional explanation of the product. example: Informacion adicional registrationInformation: type: string description: Información adicional acerca del proceso de registro para el PSU. Por ej. una referencia al contrato entre TPP/PSU x-ibm-languages: description: en: Additional information about the registration process for the PSU. Eg a reference to the contract between TPP / PSU example: Informacion adicional additionalProperties: false required: - account Response_GetConsent: properties: psuMessage: type: string example: Texto de ejemplo description: Texto a mostrar al PSU. x-ibm-languages: description: en: Text to display to the PSU. tppMessage: description: Mensaje para el TPP. x-ibm-languages: description: en: Message for the TPP. $ref: '#/definitions/TppMessage' consentStatus: type: string description: Estado de la transacción. Valores definidos en anexos. x-ibm-languages: description: en: Status of the transaction. Values ​​defined in annexes. example: ACCP consentId: type: string description: Identificador del recurso que referencia al consentimiento. Debe ser contenido si se generó un consentimiento. x-ibm-languages: description: en: Identifier of the resource that references the consent. It must be contained if a consent was generated. example: 123-QWE-456 scaMethods: $ref: '#/definitions/List_AuthenticationObject' description: Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. x-ibm-languages: description: en: This element is content if SCA is required and if the PSU can choose between different authentication methods. _links: description: 'Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta: redirect, oAuth, self, status' x-ibm-languages: description: en: 'List of hyperlinks to be recognized by the TPP. Types supported in this response: redirect, oAuth, self, status' $ref: '#/definitions/Links' required: - consentStatus - consentId - _links Response_StatusConsent: properties: psuMessage: type: string description: Mensaje para mostrar x-ibm-languages: description: en: Message to display example: Informacion para PSU tppMessage: description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP $ref: '#/definitions/TppMessage' consentStatus: type: string description: Estado de la transacción (solicitud de consentimiento identificado por consent-id) x-ibm-languages: description: en: Status of the transaction (consent request identified by consent-id) example: AcceptedTechnicalValidation required: - consentStatus Response_GetInfoConsent: properties: psuMessage: type: string description: Texto a mostrar al PSU x-ibm-languages: description: en: Text to display to the PSU example: Informacion PSU tppMessage: $ref: '#/definitions/TppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP access: x-ibm-languages: description: en: 'Access requested to services. Only sub attributes with tags "accounts", "balances" and "transactions" are accepted. Additionally, the ASPSP can support the "availableAccounts" or "allPsd2" sub attributes with the value "all-accounts". ' $ref: '#/definitions/AccountAccess' recurringIndicator: type: boolean description: 'true: acceso recurrente a la cuenta. false: un solo acceso.' x-ibm-languages: description: en: 'true: recurring access to the account. false: a single access. ' example: "true" validUntil: type: string description: 'Fecha hasta la que el consentimiento solicita acceso. Para crear el consentimiento con el máximo tiempo de acceso posible se debe usar el valor: 9999-12-31 Cuando se recupere el consentimiento, la fecha máxima posible vendrá ajustada.' x-ibm-languages: description: en: 'Date until the consent requests access. To create the consent with the maximum possible access time the value must be used: 9999-12-31 When the consent is recovered, the maximum possible date will be set. ' example: "2018-05-17" frequencyPerDay: type: integer description: Indica la frecuencia de acceso a la cuenta por día. 1 si es de un solo acceso. x-ibm-languages: description: en: Indicates the frequency of access to the account per day. 1 if it is single access. example: "4" lastActionDate: type: string description: Fecha de la última modificación realizada sobre el consentimiento. x-ibm-languages: description: en: Date of the last modification made on the consent. example: "2018-01-01" consentStatus: type: string example: valid description: 'Valores permitidos: empty, valid, blocked, expired, deleted' x-ibm-languages: description: en: 'Allowed values: empty, valid, blocked, expired, deleted' _links: description: 'Tipos de enlaces recomendados para esta respuesta: account. Dependiendo de la naturaleza del consentimiento.' x-ibm-languages: description: en: 'Recommended link types for this response: account. Depending on the nature of the consent.' $ref: '#/definitions/Links' transactionStatus: type: string description: Estado de la transacción. Valores definidos en anexos. x-ibm-languages: description: en: Status of the transaction. Values ​​defined in annexes. example: ACCP required: - access - recurringIndicator - validUntil - transactionStatus - lastActionDate - frequencyPerDay - consentStatus Response_PostConsentFundsConfirmation: allOf: - $ref: '#/definitions/Request_PostConsentFundsConfirmation' - properties: consentStatus: type: string description: Estado de autenticación del consentimiento. Ver valores definidos en 6.5 Estados de consentimiento tppMessages: description: Mensaje para el TPP enviado a través del HUB. $ref: '#/definitions/TppMessage' psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. required: - consentStatus TppMessage: properties: category: type: string example: OK code: properties: [] type: string example: ACCESS_OK text: properties: [] type: string example: Acceso OK path: properties: [] type: string example: /example/path additionalProperties: false paths: /api-entrada-xs2a/services/{aspsp}/v1.1/consents: post: 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. 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. ' operationId: postConsents parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' 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 required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' 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 required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: 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 required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-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 required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' 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 required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: 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 ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' 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 required: false type: string description: Identificador que el PSU utiliza para identificarse en su ASPSP. Puede ser informado incluso si se está usando un token de OAuth y, en tal caso, el ASPSP podría comprobar que el PSU-ID y el token se corresponden. x-ibm-languages: description: en: Identifier that the PSU uses to identify itself to its ASPSP. It can be reported even if an OAuth token is being used and, in such a case, the ASPSP could check that the PSU-ID and token match. - name: PSU-ID-Type in: header required: false type: string description: Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. x-ibm-languages: description: en: PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. - name: PSU-Corporate-ID in: header required: false type: string description: Identificador de "empresa" en los Canales Online. x-ibm-languages: description: en: Company" identifier in the Online Channels. - name: PSU-Corporate-ID-Type in: header required: false type: string description: Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. x-ibm-languages: description: en: Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: TPP-Redirect-Preferred in: header required: false type: boolean description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. 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 required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' 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 ' default: www.example.com - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" 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" ' default: www.exampleNOK.com - name: TPP-Brand-Logging-Information in: header required: false type: string 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. 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 required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: 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 required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' 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 ' - name: body in: body required: true 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”. 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". ' schema: $ref: '#/definitions/Request_GetConsent' responses: default: description: HTTP/1.1 201 Created headers: Location: type: string description: Contiene el link al recurso generado. X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_GetConsent' tags: - Consentimiento de información sobre cuentas de pago (AIS) /api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}/status: get: summary: Estado de consentimiento AIS description: Este servicio permite al TPP conocer el estado de una solicitud de consentimiento iniciada previamente. 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. operationId: getConsentStatus parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path required: true type: string - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' 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 required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' 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 required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: 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 required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-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 required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' 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 required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: 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 ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' 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 required: false type: string description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. 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 required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' 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 ' default: www.example.com - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" 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" ' default: www.exampleNOK.com - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: 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 required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea, sin cabeceras ni saltos de linea. Ej: 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 ' default: TestTPPCertificate responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la petición asignado por el TPP. schema: $ref: '#/definitions/Response_StatusConsent' tags: - Obtener estado de consentimiento /api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}: get: summary: Recuperar información de consentimiento AIS description: Este servicio permite al TPP conocer el estado de una solicitud de consentimiento iniciada previamente. 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. operationId: getConsentIdDetails parameters: - name: consent-id in: path required: true type: string - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' 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 required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' 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 required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: 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 required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-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 required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' 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 required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: 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 ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' 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 required: false type: boolean description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. 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 required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' 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 ' default: www.example.com - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" 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" ' default: www.example.com - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: 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 required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' 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: type: string description: Identificador único de la petición asignado por el TPP. schema: $ref: '#/definitions/Response_GetInfoConsent' tags: - Recuperar información de consentimiento delete: summary: Eliminar consentimiento AIS description: Este servicio permite al TPP eliminar una solicitud de consentimiento x-ibm-languages: description: en: This service allows the TPP to eliminate a request for consent summary: en: Remove AIS consent operationId: deleteConsentId parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path required: true type: string - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' 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 required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' 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 required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: 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 required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-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 required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' 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 required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: 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 ' default: DELETE - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' 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 required: false type: string description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. 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 required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' 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 ' default: www.example.com - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" 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" ' default: www.exampleNOK.com - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: 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 required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' 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: type: string description: Identificador único de la petición asignado por el TPP. tags: - Eliminar consentimiento /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds: post: 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. 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. ' operationId: postConsentsConfirmationOfFunds parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' 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 required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' 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 required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: 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 required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-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 required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' 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 required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: 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 ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' 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 required: false type: string description: Identificador que el PSU utiliza para identificarse en su ASPSP. Puede ser informado incluso si se está usando un token de OAuth y, en tal caso, el ASPSP podría comprobar que el PSU-ID y el token se corresponden. x-ibm-languages: description: en: Identifier that the PSU uses to identify itself to its ASPSP. It can be reported even if an OAuth token is being used and, in such a case, the ASPSP could check that the PSU-ID and token match. - name: PSU-ID-Type in: header required: false type: string description: Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. x-ibm-languages: description: en: PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. - name: PSU-Corporate-ID in: header required: false type: string description: Identificador de "empresa" en los Canales Online. x-ibm-languages: description: en: Company" identifier in the Online Channels. - name: PSU-Corporate-ID-Type in: header required: false type: string description: Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. x-ibm-languages: description: en: Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: TPP-Redirect-Preferred in: header required: false type: boolean description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. 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 required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' 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 ' default: www.example.com - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" 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" ' default: www.exampleNOK.com - name: TPP-Brand-Logging-Information in: header required: false type: string 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. 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 required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: 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 required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' 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 ' - name: Body required: true in: body schema: $ref: '#/definitions/Request_PostConsentFundsConfirmation' description: Cuerpo del mensaje x-ibm-languages: description: en: Message body responses: 201: description: HTTP/1.1 201 Created headers: Location: type: string description: Contiene el link al recurso generado. X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_PostConsentFundsConfirmation' tags: - Consentimiento de confirmación de fondos (FCS) /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}/status: get: 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. 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. operationId: getConsentsConfirmationOfFunds parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path required: true type: string description: Consent-id de la peticion x-ibm-languages: description: en: Consent-id of the request - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' 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 required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' 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 required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: 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 required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-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 required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' 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 required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: 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 ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' 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 required: false type: string description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. 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 required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' 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 ' default: www.example.com - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" 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" ' default: www.example.com - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: 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 required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' 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: type: string description: Identificador único de la petición asignado por el TPP. schema: $ref: '#/definitions/Response_StatusConsent' tags: - Obtener estado de consentimiento /api-entrada-xs2a/services/{aspsp}/v2.1/consents/confirmation-of-funds/{consent-id}: get: 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. 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. operationId: getConsentsConfirmationOfFundsInfo parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path required: true type: string description: Consent-id de la peticion x-ibm-languages: description: en: Consent-id of the request - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' 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 required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' 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 required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: 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 required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-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 required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' 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 required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: 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 ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' 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 required: false type: string description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. 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 required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' 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 ' default: www.example.com - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" 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" ' default: www.example.com - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: 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 required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' 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: type: string description: Identificador único de la petición asignado por el TPP. schema: $ref: '#/definitions/Response_PostConsentFundsConfirmation' tags: - Recuperar información de consentimiento delete: 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. 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. operationId: deleteConsentsConfirmationOfFunds parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: consent-id in: path required: true type: string description: Consent-id de la peticion x-ibm-languages: description: en: Consent-id of the request - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' 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 required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' 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 required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: 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 required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el 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 required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-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 required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' 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 required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: 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 ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' 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 required: false type: string description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. 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 required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' 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 ' default: www.example.com - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" 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" ' default: www.example.com - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: 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 required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' 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 tags: - Eliminar consentimiento x-ibm-endpoints: - endpointUrl: https://apis-i.redsys.es:20443/psd2/xs2a description: Endpoint entorno Integracion type: - production - development ...