swagger: "2.0" basePath: "/api-entrada-xs2a" info: title: API para PSD2 description: API de Redsys para PSD2 version: "1.0" tags: - name: PSD2 description: Endpoints disponibles para el hub PSD2 definitions: ResponseAuthorization: properties: authorisationIds: type: array items: type: string description: Array de authorisationIds. cancellationIds: properties: {} type: array description: 'Array de cancellationIds conectados al recurso de pago. Nota: obligatorio si se trata de una cancelación' items: type: string additionalProperties: false Links_ActualizarDatosPSU: properties: scaRedirect: type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 selectAuthenticationMethod: properties: {} type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 scaStatus: properties: {} type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 additionalProperties: false ResponseAutorizarDatosPsu: properties: tppMessage: additionalProperties: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP _links: additionalProperties: $ref: '#/definitions/Links_ActualizarDatosPSU' description: 'Lista de hipervínculos para ser reconocidos por el HUB. Tipos soportados en esta respuesta: • scaRedirect: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el TPP. • scaStatus: link para consultar el estado SCA correspondiente al sub-recurso de autorización. Este link es solo contenido si un sub-recurso de autorización ha sido creado.' scaStatus: properties: {} type: string description: Estado SCA psuMessage: properties: {} type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. additionalProperties: true required: - _links - scaStatus RequestActualizarDatosPsu: properties: authenticationMethodId: type: string description: Identificador del método de autenticación additionalProperties: false Links_AutorizacionInicioPago: properties: scaRedirect: type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 selectAuthenticationMethod: properties: {} type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 scaStatus: properties: {} type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 AuthenticationObject: properties: authenticationType: type: string description: 'Tipo del método de autenticación. Valores posibles: • SMS_OTP • CHIP_OTP • PHOTO_OTP • PUSH_OTP Ver anexo 6.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. 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 required: - authenticationType - authenticationMethodId - name ListAuthenticationObject: type: array items: $ref: '#/definitions/AuthenticationObject' ResponseAutorizacionInicioPago: properties: scaStatus: type: string description: Estado SCA authorisationId: properties: {} type: string description: Identificador del recurso que referencia al sub-recurso de autorización creado scaMethods: properties: {} description: 'Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. Si este dato es contenido también se informará el link "selectAuthenticationM ethod”. Estos métodos deberán ser presentados al PSU. Nota: Solo si ASPSP soporta selección del método SCA' additionalProperties: $ref: '#/definitions/ListAuthenticationObject' _links: properties: {} description: 'Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta: scaRedirect: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el TPP. selectAuthenticatio nMethod: link al sub-recurso de autorización o de autorización de cancelación donde el método SCA seleccionado será informado. • scaStatus: link para consultar el estado SCA correspondiente al sub-recurso de autorización.' additionalProperties: $ref: '#/definitions/Links_AutorizacionInicioPago' psuMessage: properties: {} type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. tppMessages: properties: {} type: string description: Mensaje para el TPP enviado a través del HUB. additionalProperties: true required: - scaStatus - authorisationId - _links _access: properties: accounts: items: type: string $ref: '#/definitions/_accountList' additionalProperties: false _accountList: type: array items: $ref: '#/definitions/_AccountDetails' _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. additionalProperties: $ref: '#/definitions/_accountReferenceList' ownerName: description: Si se informa será ignorado por el ASPSP x-ibm-languages: description: en: If reported it will be ignored by ASPSP additionalProperties: $ref: '#/definitions/_accountReferenceList' additionalProperties: true _accountReferenceList: type: array items: $ref: '#/definitions/_AccountReference' _AccountAccess: properties: accounts: additionalProperties: $ref: '#/definitions/ListAccountReference' 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: {} additionalProperties: $ref: '#/definitions/ListAccountReference' 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: {} additionalProperties: $ref: '#/definitions/ListAccountReference' 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: {} additionalProperties: $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 availableAccountsWithBalances: 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: true _AccountDetails: properties: resourceId: properties: {} type: string description: Identificador de la cuenta a ser usado en el PATH cuando se solicitan datos sobre una cuenta dedicada. x-ibm-languages: description: en: Account identifier to be used in the PATH when requesting data about a dedicated account. 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 ownerName: properties: {} 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. 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: properties: {} type: string description: Nombre dado por el banco o el PSU a la cuenta en la banca online. x-ibm-languages: description: en: Name given by the bank or PSU to the account in online banking. product: properties: {} type: string description: Nombre del producto que da el ASPSP a esta cuenta. x-ibm-languages: description: en: Name of the product that gives the ASPSP to this account. cashAccountType: properties: {} type: string description: Especifica la naturaleza o el uso de la cuenta. x-ibm-languages: description: en: Specifies the nature or use of the account. status: properties: {} type: string description: Estado de la cuenta. x-ibm-languages: description: en: Account status. bic: properties: {} type: string description: BIC asociado a la cuenta. x-ibm-languages: description: en: BIC associated to the account. linkedAccounts: properties: {} 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: properties: {} type: string description: Especifica el uso de la cuenta. x-ibm-languages: description: en: Specifies the use of the account. details: properties: {} type: string description: Especificaciones que deben ser provistas por el ASPSP. x-ibm-languages: description: en: Specifications to be provided by the ASPSP. balances: properties: {} additionalProperties: $ref: '#/definitions/ListAccountReference' 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. ' _links: properties: {} additionalProperties: $ref: '#/definitions/_links' description: 'Enlaces a la cuenta para recuperar información de balances y/o transacciones de la cuenta.' x-ibm-languages: description: en: 'Links to the account for retrieving account balance and/or transaction information. ' additionalProperties: true required: - currency example: '' _Amount: type: object properties: currency: type: string example: EUR amount: type: string example: '150.03' required: - currency - amount _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 _tppMessage: properties: category: type: string description: 'Categoría del tipo de mensaje recibido. Posibles valores: ERROR o WARNING' example: ERROR code: description: Código de respuesta. En el anexo 6.3 Códigos de retorno se listan todos los códigos de retorno por servicio. type: string example: CONSENT_INVALID text: description: Texto adicional explicativo. type: string example: Ejemplo de texto path: description: Path al campo referenciando el error type: string example: /example/path additionalProperties: false required: - category - code requestGetConsent: type: object properties: access: 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". ' additionalProperties: $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: '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. 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. 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 responseGetConsent: properties: psuMessage: type: string example: Texto de ejemplo description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. tppMessages: 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: $ref: '#/definitions/ListTppMessages' consentStatus: type: string description: Estado de autenticación del consentimiento. Ver valores definidos en 6.5 Estados de consentimiento 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: additionalProperties: $ref: '#/definitions/_authentication_object_list' 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' additionalProperties: $ref: '#/definitions/_links' additionalProperties: true required: - consentStatus - consentId - _links responseStatusConsent: properties: psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Informacion para PSU tppMessages: 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: $ref: '#/definitions/ListTppMessages' 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 additionalProperties: true required: - consentStatus responseGetInfoConsent: properties: psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Informacion PSU tppMessages: additionalProperties: $ref: '#/definitions/ListTppMessages' description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. 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". ' additionalProperties: $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' additionalProperties: true required: - access - recurringIndicator - validUntil - frequencyPerDay - lastActionDate - consentStatus responseDeleteConsent: properties: psuMessage: type: string description: Texto a mostrar al PSU x-ibm-languages: description: en: Text to display to the PSU example: Mensaje PSU tppMessage: description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP additionalProperties: $ref: '#/definitions/_tppMessage' example: Mensaje para el TPP additionalProperties: true Link_scaRedirect: properties: href: type: string description: URL para el link x-ibm-languages: description: en: URL for the link example: 'https://hub.example.es/authorize' additionalProperties: false Link_self: properties: href: type: string description: URL asociada al link x-ibm-languages: description: en: URL associated with the link example: /v1/payments/sepa-credit-transfers/123-qwe-456 additionalProperties: false href: properties: href: type: string description: URL asociada al link x-ibm-languages: description: en: URL associated with the link additionalProperties: false Link_status: properties: href: type: string example: /v1/payments/sepa-credit-transfers/123-qwe-456/status description: URL del link x-ibm-languages: description: en: URL of the link additionalProperties: false Link_scaStatus: properties: href: type: string example: /v1/payments/sepa-credit-transfers/123-qwe-456/authorisations/123auth456 additionalProperties: false Link_StartAuthorisation: properties: href: type: string example: 'https://hub.example.es/authorize' description: URL asociada al link x-ibm-languages: description: en: URL associated with the link additionalProperties: false Link_StartAuthorisationWithAuthenticationMethodSelection: properties: href: type: string example: 'https://hub.example.es/authorize' description: URL asociada al link x-ibm-languages: description: en: URL associated with the link additionalProperties: false Link_SelectAuthenticationMethod: properties: href: type: string example: 'https://hub.example.es/authorize' description: URL asociada al link x-ibm-languages: description: en: URL associated with the link additionalProperties: false _links: properties: scaRedirect: example: '' additionalProperties: $ref: '#/definitions/Link_scaRedirect' description: En caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el TPP. x-ibm-languages: description: en: In case of SCA by redirection. Link where the PSU browser must be redirected by the TPP. scaOAuth: example: '' additionalProperties: $ref: '#/definitions/Link_scaRedirect' description: El enlace para recuperar un documento JSON que especifica los detalles del servidor de autorizaciones de ASPSP. x-ibm-languages: description: en: The link to retrieve a JSON document specifying the details of the ASPSP authorization server. startAuthorisation: properties: {} example: '' additionalProperties: $ref: '#/definitions/Link_StartAuthorisation' description: 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) x-ibm-languages: description: en: In case an explicit start of the transaction authorization is necessary (there is no selection of the SCA method) startAuthorisationWithAuthenticationMethodSelection: properties: {} example: '' description: 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" x-ibm-languages: description: en: Link to the authorization end-point where the authorization sub-resource has to be generated while selecting the SCA method. This link is contained under the same conditions as the "scaMethods" field additionalProperties: $ref: '#/definitions/Link_StartAuthorisationWithAuthenticationMethodSelection' selectAuthenticationMethod: properties: {} example: '' 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. x-ibm-languages: description: en: Link where the TPP can select the applicable 2nd factor authentication method for the PSU, in case there is more than one. additionalProperties: $ref: '#/definitions/Link_SelectAuthenticationMethod' self: additionalProperties: $ref: '#/definitions/Link_self' description: link al recurso creado por esta petición. x-ibm-languages: description: en: link to the resource created by this request. status: description: Link para recuperar el estado de la transacción. x-ibm-languages: description: en: Link to retrieve the status of the transaction. additionalProperties: $ref: '#/definitions/Link_status' scaStatus: description: 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. x-ibm-languages: description: en: Link to check the SCA status corresponding to the authorization sub-resource. This link is only content if an authorization sub-resource has been created. additionalProperties: $ref: '#/definitions/Link_scaStatus' account: description: 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. x-ibm-languages: description: en: Link to check the SCA status corresponding to the authorization sub-resource. This link is only content if an authorization sub-resource has been created. additionalProperties: $ref: '#/definitions/href' cardAccount: description: Link al recurso que proporciona los datos de una cuenta de tarjeta. x-ibm-languages: description: en: Link to the resource providing card account information. additionalProperties: $ref: '#/definitions/href' balances: description: Link al recurso que proporciona los balances de la cuenta. x-ibm-languages: description: en: Link to the resource that provides account balances. additionalProperties: $ref: '#/definitions/href' transactions: description: Link al recurso que proporciona las transacciones de la cuenta. x-ibm-languages: description: en: Link to the resource that provides the account transactions. additionalProperties: $ref: '#/definitions/href' cardTransactions: description: Link al recurso que proporciona las transacciones de la cuenta de tarjeta. x-ibm-languages: description: en: Link to the resource that provides card account transactions. additionalProperties: $ref: '#/definitions/href' transactionDetails: description: Enlace al recurso proporcionando detalles de una transacción específica NO SOPORTADO EN ESTA VERSIÓN. x-ibm-languages: description: en: Link to resource providing details of a specific transaction NOT SUPPORTED IN THIS VERSION. additionalProperties: $ref: '#/definitions/href' first: description: Enlace de navegación para informes de cuentas paginados. x-ibm-languages: description: en: Navigation link for paginated account reports. additionalProperties: $ref: '#/definitions/href' next: description: Enlace de navegación para informes de cuentas paginados. x-ibm-languages: description: en: Navigation link for paginated account reports. additionalProperties: $ref: '#/definitions/href' previous: description: Enlace de navegación para informes de cuentas paginados. x-ibm-languages: description: en: Navigation link for paginated account reports. additionalProperties: $ref: '#/definitions/href' last: description: Enlace de navegación para informes de cuentas paginados. x-ibm-languages: description: en: Navigation link for paginated account reports. additionalProperties: $ref: '#/definitions/href' download: description: Enlace de descarga para grandes paquetes de datos AIS. Solo para camt-data. x-ibm-languages: description: en: Download link for large AIS data packets. For camt-data only. additionalProperties: $ref: '#/definitions/href' additionalProperties: true requestPostConsentFundsConfirmation: properties: account: additionalProperties: $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: true required: - account responsePostConsentFundsConfirmation: properties: consentStatus: type: string description: Estado de autenticación del consentimiento. Ver valores definidos en 6.5 Estados de consentimiento x-ibm-languages: description: en: Status of consent authentication. See values ​​defined in 6.5 consent states 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. scaMethods: 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. 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 data is contained, the link "startAuthorisationWithAuthenticationMethodSelection" will also be reported. These methods must be submitted to the PSU. Note: Only if ASPSP supports selection of the SCA method ' additionalProperties: $ref: '#/definitions/_authentication_object_list' _links: description: 'Lista de hipervínculos para ser reconocidos por el HUB. Tipos soportados en esta respuesta: • scaRedirect: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el 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)' x-ibm-languages: description: en: 'List of hyperlinks to be recognized by the HUB. Types supported in this response: • scaRedirect: in case of SCA by redirection. Link where the PSU browser must be redirected by the Hub. • startAuthorisation: in case an explicit start of the transaction authorization is necessary (there is no selection of the SCA method) • startAuthorisationWithAuthenticationMethodSelection: link to the authorization end-point where the authorization sub-resource has to be generated while selecting the SCA method. This link is contained under the same conditions as the "scaMethods" • self: link to the payment initiation resource created by this request. • status: link to retrieve the status of the transaction. • scaStatus: link to check the SCA status corresponding to the authorization sub-resource. This link is only content if an authorization sub-resource has been created. (If there is no explicit authorization this link must come mandatory) ' example: '' additionalProperties: $ref: '#/definitions/_links' tppMessages: 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: $ref: '#/definitions/_tppMessage' psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. additionalProperties: true required: - consentStatus - _links - consentId _link: properties: propiedad-nueva-1: type: string additionalProperties: false responseGetConsentFundsConfirmation: properties: consentStatus: type: string description: Estado del consentimiento. Ver valores definidos en 6.5 Estados de consentimiento x-ibm-languages: description: en: Status of consent. See values defined in 6.5 consent states example: valid psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Información para PSU tppMessage: $ref: '#/definitions/_tppMessage' additionalProperties: false responseGetConsentFundsConfirmationInfo: properties: account: 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. additionalProperties: $ref: '#/definitions/_AccountReference' 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 cardInformation: type: string description: Explicación adicional del producto. x-ibm-languages: description: en: Additional explanation of the product. example: Texto de ejemplo 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 consentStatus: type: string description: Estado del consentimiento. Valores definidos en anexos. x-ibm-languages: description: en: Status of consent. Values ​​defined in annexes. example: valid psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: 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: $ref: '#/definitions/_tppMessage' additionalProperties: true required: - account - consentStatus _authentication_object: properties: authenticationType: type: string authenticationVersion: type: string authenticationMethodId: type: string name: type: string explanation : type: string required: - authenticationType - authenticationMethodId - name _authentication_object_list: type: array items: $ref: '#/definitions/_authentication_object' responseAccountsList: properties: psuMessage: type: string description: Mensaje PSU x-ibm-languages: description: en: PSU message example: Mensaje PSU tppMessage: additionalProperties: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP accounts: additionalProperties: $ref: '#/definitions/_accountList' description: Listado de cuentas disponibles. x-ibm-languages: description: en: List of available accounts. additionalProperties: true required: - accounts responseAccountTransactions: type: object properties: psuMessage: type: string description: Mensaje PSU x-ibm-languages: description: en: PSU message example: Mensaje PSU tppMessage: additionalProperties: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP account: additionalProperties: $ref: '#/definitions/_AccountReference' description: Identificador de la cuenta que se está consultando. x-ibm-languages: description: en: Identifier of the account being consulted. transactions: additionalProperties: $ref: '#/definitions/_AccountReport' description: 'Devolución de los datos en formato JSON, cuando los datos devueltos tienen un tamaño pequeño.' x-ibm-languages: description: en: 'Return of data in JSON format, when the returned data has a small size.' balances: additionalProperties: $ref: '#/definitions/_balancesList' description: Una lista de balances con respecto a una cuenta. x-ibm-languages: description: en: A list of balances regarding an account. _links: additionalProperties: $ref: '#/definitions/_Links_Accounts_Transactions' additionalProperties: true responseAccountBalances: properties: psuMessage: type: string description: Mensaje PSU x-ibm-languages: description: en: PSU message example: Mensaje PSU tppMessage: additionalProperties: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP balances: description: Balances de la cuenta x-ibm-languages: description: en: Account balances additionalProperties: $ref: '#/definitions/_balancesList' account: additionalProperties: $ref: '#/definitions/_AccountReference' description: Identificador de la cuenta que se está consultando. x-ibm-languages: description: en: Identifier of the account being consulted. additionalProperties: true required: - balances responseAccountDetail: properties: psuMessage: type: string description: Texto a mostrar al PSU x-ibm-languages: description: en: Text to display to the PSU example: Texto para mostrar tppMessage: additionalProperties: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP account: additionalProperties: $ref: '#/definitions/_AccountDetails' description: Información detallada de la cuenta x-ibm-languages: description: en: Detailed account information additionalProperties: true required: - account _Balances: properties: balanceAmount: additionalProperties: $ref: '#/definitions/_Amount' description: Importe y moneda del balance x-ibm-languages: description: en: Balance amount and currency balanceType: description: Transacciones compuestas por las entradas anotadas y las entradas pendientes en el momento de la petición. x-ibm-languages: description: en: Transactions composed of the entries entered and the pending entries at the time of the request. additionalProperties: $ref: '#/definitions/_SingleBalance' type: string example: closingBooked creditLimitIncluded: description: 'Flag indicando si el límite de crédito de la cuenta correspondiente está incluido en el cálculo del balance, cuando aplicque.' x-ibm-languages: description: en: 'Flag indicating if the credit limit of the corresponding account is included in the balance calculation, when applicable.' additionalProperties: $ref: '#/definitions/_SingleBalance' type: boolean example: 'true' lastChangeDateTime: description: Fecha de la última acción realizada sobre la cuenta. x-ibm-languages: description: en: Date of the last action performed on the account. additionalProperties: $ref: '#/definitions/_SingleBalance' type: string example: '2017-10-25T15:30:35.035Z' interimAvailable: description: Balance disponible provisionalmente. Calculado en base a las anotaciones de ítems de crédito y débito durante el periodo de tiempo especificado. x-ibm-languages: description: en: Balance available provisionally. Calculated based on annotations of credit and debit items during the specified period of time. additionalProperties: $ref: '#/definitions/_SingleBalance' referenceDate: type: string description: Fecha de referencia del balance x-ibm-languages: description: en: Balance sheet reference date example: '2017-10-25' 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. x-ibm-languages: description: en: entryReference of the last transaction to help the TPP identify if all transactions of the PSU are already known. example: 1234-asd-567 additionalProperties: true required: - balanceAmount - balanceType _SingleBalance: properties: amount: description: Cantidad contenida en la cuenta. x-ibm-languages: description: en: Amount contained in the account. additionalProperties: $ref: '#/definitions/_Amount' lastActionDateTime: type: string example: '2017-10-23' description: Fecha de la última anotación encontrada en la cuenta. x-ibm-languages: description: en: Date of the last entry found in the account. date: type: string description: Fecha Actual x-ibm-languages: description: en: Current Date example: '2017-10-23' additionalProperties: true required: - amount _Links_Accounts_Transactions: properties: download: type: string description: '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: 'Download link of the data of the query made, when the returned data is large. Only for camt-data. ' example: '"download/path/example"' account: type: string example: '"account/path/example"' first: type: string description: Enlace usado en la navegación para paginación. Devuelve la primera página de la paginación de las transacciones. x-ibm-languages: description: en: Link used in paging navigation. Returns the first page of the pagination of the transactions. example: '/aspsp-name/v1/accounts/qwer3456tzui7890/transactions?page[number]=1&page[size]=15' next: type: string description: Enlace usado en la navegación por paginación. Devuelve la siguiente página a la actual en la paginación de las transacciones. x-ibm-languages: description: en: Link used in paging navigation. Returns the next page to the current page in the pagination of the transactions. example: 'aspsp-name/v1/accounts/qwer3456tzui7890/transactions?page[number]=2&page[size]=15' previous: type: string description: Enlace usado en la navegación por paginación. Devuelve la página anterior a la actual en la paginación de las transacciones. x-ibm-languages: description: en: Link used in paging navigation. Returns the previous page to the current page in the pagination of the transactions. example: '/aspsp-name/v1/accounts/qwer3456tzui7890/transactions?page[number]=4&page[size]=15' last: type: string description: Enlace usado en la navegación para paginación. Devuelve la última página de la paginación de las transacciones. x-ibm-languages: description: en: Link used in paging navigation. Returns the last page of the pagination of the transactions. example: '/aspsp-name/v1/accounts/qwer3456tzui7890/transactions?page[number]=10&page[size]=15' additionalProperties: false _AccountReport: type: object properties: booked: additionalProperties: $ref: '#/definitions/_transactionsList' description: Últimas transacciones (anotaciones) conocidas de la cuenta. x-ibm-languages: description: en: Last known transactions (annotations) of the account. pending: additionalProperties: $ref: '#/definitions/_transactionsList' description: Transacciones pendientes de la cuenta. x-ibm-languages: description: en: Pending account transactions. information: additionalProperties: $ref: '#/definitions/_transactionsList' 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: 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)' example: '' additionalProperties: $ref: '#/definitions/_Links_Accounts_Transactions' additionalProperties: true required: - _links _StandingOrderDetails: properties: startDate: type: string endDate: type: string executionRule: type: string withinAMonthFlag: type: boolean frequency: type: string monthsOfExecution: type: array items: type: string multiplicator: type: integer dayOfExecution: type: string limitAmount: $ref: '#/definitions/_Amount' required: - startDate - frequency _StructuredAdditionalInformation: properties: standingOrderDetails: $ref: '#/definitions/_StandingOrderDetails' _Transactions: properties: transactionId: type: string description: Identificador de la transacción. x-ibm-languages: description: en: Transaction identifier. endToEndId: type: string description: Identificador único end to end x-ibm-languages: description: en: Unique identifier end to end entryReference: type: string description: 'Identificación de la transacción que puede ser usada, por ejemplo, en las consultas delta.' x-ibm-languages: description: en: 'Identification of the transaction that can be used, for example, in delta queries.' mandateId: type: string description: 'Identificación del mandato. Por ejemplo, un ID de un mandato SEPA.' x-ibm-languages: description: en: 'Identification of the mandate. For example, an ID of a SEPA command. ' example: e733223hge7 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.' x-ibm-languages: description: en: 'Beneficiary identification. For example, a SEPA beneficiary ID. ' example: e7363987hge7 bookingDate: type: string description: Fecha de anotación de la transacción x-ibm-languages: description: en: Transaction annotation date example: '2017-10-23' valueDate: type: string description: Fecha valor de la transacción x-ibm-languages: description: en: Transaction value date example: '2017-10-23' transactionAmount: additionalProperties: $ref: '#/definitions/_Amount' description: Cantidad de la transaccion x-ibm-languages: description: en: Transaction amount currencyExchange: additionalProperties: $ref: '#/definitions/_CurrencyExchange' 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. x-ibm-languages: description: en: Name of the beneficiary if the transaction is a charge. example: NombreEjemplo creditorAccount: description: Cuenta del beneficiario. x-ibm-languages: description: en: Beneficiary account. additionalProperties: $ref: '#/definitions/_AccountReference' ultimateCreditor: type: string description: Beneficiario final. x-ibm-languages: description: en: Final beneficiary. debtorName: type: string description: Nombre del ordenante x-ibm-languages: description: en: Name of the payer example: NombreEjemplo debtorAccount: description: Cuenta del ordenante. x-ibm-languages: description: en: Account of the payer. additionalProperties: $ref: '#/definitions/_AccountReference' ultimateDebtor: type: string description: Nombre ordenante final. x-ibm-languages: description: en: Final ordering name. example: NombreEjemplo remittanceInformationUnstructured: type: string description: Campo para incluir información adicional del envío. x-ibm-languages: description: en: Field to include additional shipping information. example: Informacion adicional remittanceInformationStructured: type: string description: Campo para incluir una referencia x-ibm-languages: description: en: Field to include a reference example: 1234-asdf-456 additionalInformationStructured: 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.' additionalProperties: $ref: '#/definitions/_StructuredAdditionalInformation' purposeCode: type: string description: ExternalPurposeCode ISO 20022 x-ibm-languages: description: en: ExternalPurposeCode ISO 20022 bankTransactionCode: type: string description: Codigo de la transaccion bancaria como es usado por los ASPSP x-ibm-languages: description: en: Bank transaction code as used by the ASPSP proprietaryBankTransactionCode: type: string description: Código de transacción propietario del banco x-ibm-languages: description: en: Bank proprietary transaction code additionalProperties: true required: - transactionAmount _transactionsList: type: array items: $ref: '#/definitions/_Transactions' _balancesList: type: array items: $ref: '#/definitions/_Balances' _CurrencyExchange: properties: currencyFrom: type: string description: Moneda Origen x-ibm-languages: description: en: Currency Origin example: USD rate: type: string description: 'Define la tarifa de intercambio. Ej: currencyFrom=USD, currencyTo=EUR: 1USD =0.8 EUR y 0.8 es la tarifa.' x-ibm-languages: description: en: 'Define the exchange rate. Ex: currencyFrom = USD, currencyTo = EUR: 1USD = 0.8 EUR and 0.8 is the rate. ' example: '0.8' currencyTo: type: string description: Moneda Destino x-ibm-languages: description: en: Destination Currency example: EUR rateDate: type: string description: Fecha de la tarifa. Formato ISODateTime x-ibm-languages: description: en: Rate date. ISODateTime format rateContract: type: string description: Referencia al contrato de la tarifa x-ibm-languages: description: en: Reference to the tariff contract additionalProperties: false required: - currencyFrom - rate - currencyTo - rateDate Amount: type: object properties: currency: type: string example: EUR amount: type: string example: '150.03' required: - currency - amount 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 PCI DSS requirements. Field not supported by the HUB. example: '1234567891234567' maskedPan: type: string description: Primary Account Number de la tarjeta en forma enmascarda. x-ibm-languages: description: en: Primary Account Number of the card in masked for. example: '1234567891234567' 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: '195198741874' currency: type: string description: Tipo de moneda. x-ibm-languages: description: en: Type of currency. example: EUR fundsConfirmationRequest: properties: cardNumber: type: string description: Numeración de la tarjeta emitida por el PIISP. Debe ser enviada si está disponible. Este campo no está soportado para esta versión x-ibm-languages: description: en: Card number issued by the PIISP. It must be sent if available. This field is not supported for this version. example: 1111-1111-1111-1111 account: additionalProperties: $ref: '#/definitions/AccountReference' 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. x-ibm-languages: description: en: Commerce where the card is accepted as information for the PSU. example: Comercio instructedAmount: description: Contiene la cantidad y moneda a consultar. x-ibm-languages: description: en: Contains the quantity and currency to consult. additionalProperties: $ref: '#/definitions/Amount' additionalProperties: true required: - account - instructedAmount fundsConfirmationResponse: type: object properties: tppMessage: additionalProperties: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP fundsAvailable: type: boolean example: 'true' description: Toma el valor "true" si hay suficientes fondos disponibles en el momento de la petición. "false" en otro caso. 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 case. additionalProperties: true required: - fundsAvailable ListTppMessages: type: array items: $ref: '#/definitions/_tppMessage' _SpecialServicePaymentEntity: 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. x-ibm-languages: description: en: Entity Code. example: '12345' paymentType: type: integer description: Tipo de pago. Vendrá con valor 1. x-ibm-languages: description: en: Payment type. It will come with value 1. example: '1' chargeType: type: integer description: Tipo de cargo. x-ibm-languages: description: en: Type of charge. example: '1' productName: type: string description: Nombre del producto que ofrece la entidad. x-ibm-languages: description: en: Name of the product offered by the entity. example: 'productName' specialServicePaymentParameters: properties: {} description: Lista de posibles importes admitidos additionalProperties: $ref: '#/definitions/ListSpecialServicePaymentEntityParameter' x-ibm-languages: description: en: List of possible amounts admitted minimumAmount: properties: {} description: Indica el importe mínimo del Servicio de Pago. Importe mínimo acppetado es 0.01. additionalProperties: $ref: '#/definitions/_Amount' x-ibm-languages: description: en: Indicates the minimum amount of the Payment Service. Minimum amount accepted is 0.01 maximumAmount: properties: {} description: Indica el importe máximo del Servicio de Pago. Importe máximo aceptado es 99999.99. additionalProperties: $ref: '#/definitions/_Amount' x-ibm-languages: description: en: Indicates the maximum amount of the Payment Service. Maximum accepted amount is 99999.99 entitiesCorporateData: properties: {} description: Entity Corporate Capital Currency. additionalProperties: $ref: '#/definitions/ListEntityCorporateData' x-ibm-languages: description: en: Entity Corporate Capital Currency. additionalProperties: true required: - servicePaymentName - entityCode - paymentType - chargeType - productName - minimumAmount - maximumAmount - entitiesCorporateData ListSpecialServicePaymentEntity: type: array items: $ref: '#/definitions/_SpecialServicePaymentEntity' _EntityCorporateData: properties: fiscalName: type: string description: Nombre fiscal de la entidad x-ibm-languages: description: en: Fiscal name of entity example: 'Van Egmond' fiscalNumber: type: string description: Número fiscal de la entidad x-ibm-languages: description: en: Fiscal number of entity example: '6017337891225600' fiscalAddress: type: string description: Direccion fiscal de la entidad x-ibm-languages: description: en: Fiscal address of entity example: '362 Pocmos Highway' fiscalRegister: type: string description: Registro fiscal de la entidad x-ibm-languages: description: en: Fiscal register of entity example: 'wupvucl' corporateCapital: type: string description: Entity Corporate Capital Amount additionalProperties: $ref: '#/definitions/_Amount' x-ibm-languages: description: en: Entity Corporate Capital Amount reference: type: string description: Descripcion referencia para factura x-ibm-languages: description: en: Description reference for invoice example: 'Telemóvel' iva: type: string description: IVA factura additionalProperties: $ref: '#/definitions/_Amount' x-ibm-languages: description: en: VAT invoice message: type: string description: Mensaje de la entidad al PSU x-ibm-languages: description: en: Entity message to the PSU example: 'OBRIGADO POR PREFERIR A companyName. CASO NECESSITE' additionalProperties: true ListEntityCorporateData: type: array items: $ref: '#/definitions/_EntityCorporateData' _SpecialServicePaymentEntityParameter: properties: code: type: integer description: Código asociado al importe x-ibm-languages: description: en: Code associated with the amount example: '1' amount: properties: {} type: string description: Importe. additionalProperties: $ref: '#/definitions/_Amount' x-ibm-languages: description: en: Amount additionalProperties: true required: - code - amount ListSpecialServicePaymentEntityParameter: type: array items: additionalProperties: $ref: '#/definitions/_SpecialServicePaymentEntityParameter' _ServicePaymentEntity: properties: servicePaymentName: type: string description: Nombre del servicio de pago x-ibm-languages: description: en: Payment service name minimumAmount: properties: {} description: Indica el importe mínimo del Servicio de Pago. Importe mínimo acppetado es 0.01. additionalProperties: $ref: '#/definitions/_Amount' x-ibm-languages: description: en: Indicates the minimum amount of the Payment Service. Minimum amount accepted is 0.01 maximumAmount: properties: {} description: Indica el importe máximo del Servicio de Pago. Importe máximo aceptado es 99999.99. additionalProperties: $ref: '#/definitions/_Amount' 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. x-ibm-languages: description: en: Entity Code. example: '12345' paymentType: type: integer description: Tipo de pago. Vendrá con valor 1. x-ibm-languages: description: en: Payment type. It will come with value 1. example: '1' additionalProperties: true required: - servicePaymentName - minimumAmount - maximumAmount - entityCode - paymentType ListServicePaymentEntity: type: array items: $ref: '#/definitions/_ServicePaymentEntity' _PaymentLiquidation: properties: code: type: integer description: Código de liquidación x-ibm-languages: description: en: Settlement code example: '11' name: type: string description: Descripcion de la liquidacion x-ibm-languages: description: en: Settlement description example: 'ProdutoresAgricolas' entityCode: type: integer description: Código de entidad x-ibm-languages: description: en: Entity code example: '12345' branch: type: integer description: Rama de liquidación de pago relacionada a la Entidad de liquidación de pago x-ibm-languages: description: en: Payment settlement branch related to the payment settlement entity example: '54169188' required: - code - name _PublicSectorPaymentEntity: properties: entityCode: type: integer description: Codigo de entidad x-ibm-languages: description: en: Entity code paymentLiquidation: additionalProperties: $ref: '#/definitions/_PaymentLiquidation' description: Datos para la liquidación del pago x-ibm-languages: description: en: Data for payment settlement additionalProperties: true required: - entityCode - paymentLiquidation ListPublicSectorPaymentEntity: type: array items: $ref: '#/definitions/_PublicSectorPaymentEntity' _PaymentUnit: properties: minimun: type: integer description: Unidad mínima naturaleza del pago x-ibm-languages: description: en: Minimum unit nature of payment example: '1' maximun: type: integer description: Unidad maxima naturaleza del pago x-ibm-languages: description: en: Maximum unit nature of payment example: '25' additionalProperties: true required: - minimun - maximun _Remuneration: properties: code: type: integer description: Código de la remuneracion. x-ibm-languages: description: en: Remuneration code. example: '1' name: type: string description: Descripcion de la remuneracion. x-ibm-languages: description: en: Remuneration description. example: 'Mensal-MesCompleto' minimumAmount: description: Valor remuneración mensual efectiva mínima additionalProperties: $ref: '#/definitions/_Amount' x-ibm-languages: description: en: Minimum effective monthly remuneration value maximumAmount: description: Valor remuneración mensual efectiva máxima additionalProperties: $ref: '#/definitions/_Amount' x-ibm-languages: description: en: Maximum effective monthly remuneration value additionalProperties: true required: - code - name - minimumAmount - maximumAmount _SocialSecurityPaymentParameters: properties: paymentNature: description: Naturaleza del pago para Seguridad Social de particulares additionalProperties: $ref: '#/definitions/_PaymentLiquidation' x-ibm-languages: description: en: Nature of payment for Social Security of individuals tsuCenter: description: Datos de los centros de la Seguridad Social TSU. additionalProperties: $ref: '#/definitions/_PaymentLiquidation' x-ibm-languages: description: en: Data from the TSU Social Security centers. paymentUnit: description: Unidad de pago. additionalProperties: $ref: '#/definitions/_PaymentUnit' x-ibm-languages: description: en: Payment unit. remuneration: description: Información relativa al tipo de remuneración. additionalProperties: $ref: '#/definitions/_Remuneration' x-ibm-languages: description: en: Information regarding the type of remuneration. additionalProperties: true ListSocialSecurityPaymentParameters: type: array items: $ref: '#/definitions/_SocialSecurityPaymentParameters' _PublicSectorPaymentType: properties: code: type: string description: Codigo de pago x-ibm-languages: description: en: Payment code example: '01' name: type: string description: Descripcion de tipo de pago x-ibm-languages: description: en: Payment type description example: 'PAGAMENTOPORCONTA1' required: - code - name ListPublicSectorPaymentType: type: array items: $ref: '#/definitions/_PublicSectorPaymentType' _PaymentPeriod: properties: year: type: integer description: Año de pago x-ibm-languages: description: en: Year of payment example: '01' month: type: integer description: Mes de pago x-ibm-languages: description: en: Month of payment example: '10' required: - year - month _Challenge: additionalProperties: false ResponseGetMultibankCatalogue: properties: servicePaymentEntities: 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. $ref: '#/definitions/ListServicePaymentEntity' specialServicePaymentEntities: 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. $ref: '#/definitions/ListSpecialServicePaymentEntity' publicSectorPaymentEntities: 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. $ref: '#/definitions/ListPublicSectorPaymentEntity' socialSecurityPaymentEntities: 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. $ref: '#/definitions/ListSocialSecurityPaymentParameters' publicSectorPaymentTypes: 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.. $ref: '#/definitions/ListPublicSectorPaymentType' _links: properties: {} description: 'Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta:' x-ibm-languages: description: en: 'List of hyperlinks to be recognized by the TPP. Types supported in this answer: ' $ref: '#/definitions/_links' psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. $ref: '#/definitions/ListTppMessages' additionalProperties: false RequestSocialSecurityWithholding: properties: debtorAccount: description: Cuenta del ordenante x-ibm-languages: description: en: Payer's account $ref: '#/definitions/_AccountReference' paymentNature: type: integer description: Identifica la categoría profesional a la que pertenece el trabajador x-ibm-languages: description: en: Identify the professional category to which the worker belongs example: '4613978645' number: type: integer description: Numero de la seguridad social x-ibm-languages: description: en: Social security number example: '10000000003' remunerationCode: type: integer description: Unidad de pago en función del tipo de remuneración x-ibm-languages: description: en: Payment unit according to the type of remuneration example: '1' paymentUnit: type: integer description: Unidad de pago en función del tipo de remuneración x-ibm-languages: description: en: Payment unit according to the type of remuneration example: '1' remunerationAmount: description: Salario generado en esa unidad de pago $ref: '#/definitions/_Amount' 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. 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. example: '65136589331' paymentDate: type: string description: Fecha de realización del pago x-ibm-languages: description: en: Payment date example: '2020-03-04' ResponseSocialSecurityWithholding: properties: paymentState: type: integer description: Estado en el que se encuentra el pago x-ibm-languages: description: en: State in which the payment is located example: '1' invoiceNumber: type: string description: Número de factura x-ibm-languages: description: en: Invoice number example: '1234' entityName: type: string description: Nombre de la entidad x-ibm-languages: description: en: Entity name example: 'company-name' withholding: description: Importe a pagar $ref: '#/definitions/_Amount' x-ibm-languages: description: en: Payment amount operationReference: type: string description: Identificador único de la operación x-ibm-languages: description: en: Unique operation id example: 'company-name' psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: description: Mensaje para el TPP enviado a través del HUB. x-ibm-languages: description: en: Message for the TPP sent through the HUB. $ref: '#/definitions/ListTppMessages' RequestStartMultibankPayment: properties: instructedAmount: description: Importe de la transferencia x-ibm-languages: description: en: Transfer amount additionalProperties: $ref: '#/definitions/_Amount' debtorAccount: description: Cuenta del ordenante x-ibm-languages: description: en: Payer's account additionalProperties: $ref: '#/definitions/_AccountReference' paymentReference: type: string description: Referencia del pago MULTIBANCO x-ibm-languages: description: en: Multibank payment reference example: "123456789" operationReference: type: string description: Referencia obtenida en la consulta de valor a pagar a la Seguridad Social x-ibm-languages: description: en: Reference obtained in the consultation of the value to be paid to Social Security example: "1501ab4e-6904-11ea-bc55-0242ac130003" paymentType: type: integer description: Tipo de pago a la seguridad social x-ibm-languages: description: en: Type of payment to social security example: "1" entityCode: type: integer description: Entidad del pago MULTIBANCO x-ibm-languages: description: en: Entity of multibank payment example: "10003" parameterCode: type: integer description: Código de parámetro asociado al importe. Obtenido en la consulta de catálogo de special-service-payments x-ibm-languages: description: en: Parameter code associated with the amount. Obtained from the special-service-payments catalog query example: "3" taxpayerIdentificationNumber: type: integer description: Número de identificación del contribuyente x-ibm-languages: description: en: Taxpayer identification number example: "6244688226942976" paymentPeriod: description: Periodo por el que se realiza el pago x-ibm-languages: description: en: Period for which the payment is made additionalProperties: $ref: '#/definitions/_PaymentPeriod' tsuCenterCode: type: integer description: Código del centro TSU x-ibm-languages: description: en: TSU center code example: "2698" requestedExecutionDate: type: string description: Fecha de ejecución futura x-ibm-languages: description: en: Future execution date example: "2018-05-17" paymentTypeCode: type: string description: Código del tipo de pago. Devuelto en el catalogo de tipos pagos al sector público x-ibm-languages: description: en: Payment type code. Returned in the catalog of types paid to the public sector example: "05" additionalProperties: true ResponseStartMultibankPayment: properties: transactionStatus: type: string description: Estado de la transacción. x-ibm-languages: description: en: Transaction status. example: "RCVD" paymentId: type: string description: Identificador del recurso que referencia a la iniciación de pago. x-ibm-languages: description: en: Resource identifier that refers to the payment initiation. example: "1b3ab8e8-0fd5-43d2-946e-d75958b172e7" transactionFees: description: Comisiones asociadas al pago. x-ibm-languages: description: en: Fees associated with payment. additionalProperties: $ref: '#/definitions/_Amount' transactionFeeIndicator: type: boolean description: Si es igual a "true", la transacción implicará una comisión según el ASPSP o según lo acordado entre ASPSP y PSU. 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. example: "true" invoiceNumber: type: string description: Número de factura/recibo x-ibm-languages: description: en: "Invoice / receipt number" example: "12345678901234567890" scaMethods: 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" additionalProperties: $ref: '#/definitions/ListAuthenticationObject' chosenScaMethod: description: 'NO SOPORTADO EN ESTA VERSIÓN. SOLO EMBEBIDO ' x-ibm-languages: description: en: "NOT SUPPORTED IN THIS VERSION. EMBEDDED ONLY " additionalProperties: $ref: '#/definitions/AuthenticationObject' challengeData: description: 'NO SOPORTADO EN ESTA VERSIÓN. SOLO EMBEBIDO ' x-ibm-languages: description: en: "NOT SUPPORTED IN THIS VERSION. EMBEDDED ONLY " additionalProperties: $ref: '#/definitions/_Challenge' _links: description: 'Lista de hipervínculos para ser reconocidos por el HUB. ' x-ibm-languages: description: en: "List of hyperlinks to be recognized by the HUB" additionalProperties: $ref: '#/definitions/_links' psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: 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: $ref: '#/definitions/ListTppMessages' additionalProperties: true required: - transactionStatus - paymentId - transactionFees - transactionFeeIndicator - scaMethods - _links - psuMessage - tppMessages ResponseGetStatusMultibankPayment: properties: transactionStatus: type: string description: Estado de la transacción. x-ibm-languages: description: en: Transaction status. example: "ACCP" 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 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 example: "true" psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: 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: $ref: '#/definitions/ListTppMessages' additionalProperties: true required: - transactionStatus ResponseGetMultibankPayment: properties: instructedAmount: description: Importe de la transferencia . x-ibm-languages: description: en: Transfer amount. additionalProperties: $ref: '#/definitions/_Amount' debtorAccount: description: Cuenta del ordenante . x-ibm-languages: description: en: Payer's account. additionalProperties: $ref: '#/definitions/_AccountReference' paymentReference: type: string description: Referencia del pago Multibanco . x-ibm-languages: description: en: Multibank payment reference. example: "123456789" operationReference: type: string description: Referencia obtenida en la consulta de valor a pagar a la Seguridad Social. x-ibm-languages: description: en: Reference obtained in the consultation of the value to be paid to Social Security. example: "1501ab4e-6904-11ea-bc55-0242ac130003" paymentType: type: integer description: Valores posibles para service-payments 1- Servicios 2 – Compras Valores posibles para special-service-payments - Devueltos en catálogo x-ibm-languages: description: en: Reference obtained in the consultation of the value to be paid to Social Security. example: "1" entityCode: type: integer description: Entidad del pago Multibanco x-ibm-languages: description: en: Multibanco payment entity. example: "1" parameterCode: type: integer description: Código de parámetro asociado al importe. Obtenido en la consulta de catálogo de special-service-payments x-ibm-languages: description: en: Parameter code associated with the amount. Obtained from the special-service-payments catalog query. example: "3" taxpayerIdentificationNumber: type: integer description: Número de identificación del contribuyente x-ibm-languages: description: en: Taxpayer identification number. example: "6244688226942976" paymentPeriod: description: Periodo por el que se realiza el pago x-ibm-languages: description: en: Period for which the payment is made. additionalProperties: $ref: '#/definitions/_PaymentPeriod' tsuCenterCode: type: integer description: Código del centro TSU x-ibm-languages: description: en: TSU center code. example: "2698" requestedExecutionDate: type: string description: Fecha de ejecución futura x-ibm-languages: description: en: Future execution date. example: "2018-05-17" paymentTypeCode: type: string description: Código del tipo de pago. Devuelto en el catalogo de tipos pagos al sector público x-ibm-languages: description: en: Payment type code. Returned in the catalog of types paid to the public sector. example: "05" transactionStatus: type: string description: Estado de la transacción x-ibm-languages: description: en: Transaction status. example: "ACCP" invoiceNumber: type: string description: Número de factura/recibo x-ibm-languages: description: en: Invoice / receipt number. example: "12345678901234567890" psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: 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: $ref: '#/definitions/ListTppMessages' additionalProperties: true ResponseDeleteMultibankPayment: properties: transactionStatus: type: string description: Estado de la transacción x-ibm-languages: description: en: Transaction status. example: "ACCP" psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: 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: $ref: '#/definitions/ListTppMessages' additionalProperties: true required: - transactionStatus ResponseMultibankAuthorizeConsentEstablishment: properties: scaStatus: type: string description: Estado SCA x-ibm-languages: description: en: SCA status. example: "received" authorisationId: type: string description: Identificador del recurso que referencia al sub-recurso de autorización creado x-ibm-languages: description: en: Resource identifier that refers to the authorization sub-resource created. example: "1b3ab8e8-0fd5-43d2-946e-d75958b172e7" scaMethods: 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" additionalProperties: $ref: '#/definitions/ListAuthenticationObject' chosenScaMethod: description: '' x-ibm-languages: description: en: "" additionalProperties: $ref: '#/definitions/AuthenticationObject' challengeData: description: '' x-ibm-languages: description: en: "" additionalProperties: $ref: '#/definitions/_Challenge' _links: 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" additionalProperties: $ref: '#/definitions/_links' psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: 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: $ref: '#/definitions/ListTppMessages' additionalProperties: true ResponseMultibankSelectSCAMethod: properties: chosenScaMethod: description: '' x-ibm-languages: description: en: "" additionalProperties: $ref: '#/definitions/AuthenticationObject' challengeData: description: '' x-ibm-languages: description: en: "" additionalProperties: $ref: '#/definitions/_Challenge' _links: 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" additionalProperties: $ref: '#/definitions/_links' scaStatus: type: string description: Estado SCA. x-ibm-languages: description: en: SCA status. example: received psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: 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: $ref: '#/definitions/ListTppMessages' additionalProperties: true ResponseMultibankAuthorizationSubresources: properties: authorisationIds: type: array items: type: string description: Array de authorisationIds. cancellationIds: properties: {} 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. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: 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: $ref: '#/definitions/ListTppMessages' additionalProperties: true ResponseMultibankGetSCAStatus: properties: scaStatus: type: string description: Estado SCA x-ibm-languages: description: en: SCA status. example: "finalised" psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. x-ibm-languages: description: en: Text sent to the TPP through the HUB to be displayed to the PSU. example: Mensaje de ejemplo tppMessages: 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: $ref: '#/definitions/ListTppMessages' required: - scaStatus Address: type: object properties: street: type: string description: Calle x-ibm-languages: description: en: Street example: Ejemplo de Calle buildingNumber: type: string description: Numero x-ibm-languages: description: en: Number example: '5' city: type: string description: Ciudad x-ibm-languages: description: en: City example: Cordoba postalCode: type: string description: Codigo Postal x-ibm-languages: description: en: Postal Code example: '14100' country: type: string description: Pais x-ibm-languages: description: en: Country example: ES required: - country RequestCrearBulk: 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.' 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. ' example: 'true' 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 debtorAccount: additionalProperties: $ref: '#/definitions/_AccountReference' description: Cuenta del ordenante. x-ibm-languages: description: en: Account of the payer. payments: items: $ref: '#/definitions/SinglePaymentBulk' 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' 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: $ref: '#/definitions/ListSinglePaymentBulk' debtorIdentification: additionalProperties: $ref: '#/definitions/PartyIdentification' description: 'Identificación estructurada del debtor' x-ibm-languages: description: en: 'Debtor structured identification' additionalProperties: true required: - debtorAccount - payments PartyIdentification: type: object properties: organisationId: additionalProperties: $ref: '#/definitions/OrganisationIdentification' description: 'Entrada proporcionada por una lista de códigos ISO externa' x-ibm-languages: description: en: 'Input provided by an external ISO code list' additionalProperties: true OrganisationIdentification: type: object properties: others: additionalProperties: $ref: '#/definitions/ListOther' description: 'Lista de "others"' x-ibm-languages: description: en: 'List of "others"' additionalProperties: true ListOther: type: array items: $ref: '#/definitions/Other' Other: 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' SinglePayment: type: object properties: instructedAmount: additionalProperties: $ref: '#/definitions/_Amount' description: Información de la transferencia realizada. x-ibm-languages: description: en: Transfer information made. creditorName: type: string description: Nombre del beneficiario x-ibm-languages: description: en: Beneficiary Name example: Nombre creditorAccount: additionalProperties: $ref: '#/definitions/_AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' x-ibm-languages: description: en: 'Account of the payer. Note: this field may be optional in some services such as bulk payments.' creditorAgent: type: string description: BIC de la cuenta del beneficiario x-ibm-languages: description: en: BIC of the beneficiary's account example: XXXLESMMXXX creditorAddress: additionalProperties: $ref: '#/definitions/Address' description: Direccion Beneficiario x-ibm-languages: description: en: Beneficiary Address remittanceInformationUnstructured: type: string description: Informacion Adicional x-ibm-languages: description: en: Additional Information example: Informacion adicional chargeBearer: type: string description: 'Valores permitidos: Valores permitidos: • DEBT • CRED • SHAR • SLEV' x-ibm-languages: description: en: 'Allowed values: Allowed values: • DEBT • CRED • SHAR • SLEV' example: SLEV debtorAccount: properties: {} additionalProperties: $ref: '#/definitions/_AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' x-ibm-languages: description: en: 'Account of the payer. Note: this field may be optional in some services such as bulk payments.' purposeCode: type: string description: 'Lista de códigos ISO' x-ibm-languages: description: en: 'List of ISO codes' endToEndIdentification: type: string description: 'Identificador asignado por la parte iniciadora' x-ibm-languages: description: en: 'Identifier assigned by the initiating party' additionalProperties: true RequestCrearPeriodico: allOf: - $ref: '#/definitions/SinglePayment' - properties: startDate: type: string description: El primer día aplicable de ejecución desde esta fecha es el primer pago x-ibm-languages: description: en: The first applicable day of execution from this date is the first payment executionRule: type: string description: Define el comportamiento cuando las fechas del pago recurrente caen en fin de semana o festivo. Entonces el pago se ejecuta el día laboral anterior o posterior x-ibm-languages: description: en: Define the behavior when recurring payment dates fall on weekends or holidays. Then the payment is executed the previous or subsequent business day endDate: type: string description: El último día aplicable de ejecución. Si no viene se trata de una orden permanente sin fin. x-ibm-languages: description: en: The last applicable day of execution. If it does not come, it is an endless permanent order. frequency: type: string description: La frecuencia del pago recurrente resultante de esta orden permanente x-ibm-languages: description: en: The frequency of recurring payment resulting from this permanent order dayOfExecution: type: string description: La fecha se refiere a la zona horaria del ASPSP x-ibm-languages: description: en: The date refers to the time zone of the ASPSP RequestInicioPagoConListadoCuentasDisponible: type: object properties: instructedAmount: additionalProperties: $ref: '#/definitions/_Amount' description: Información de la transferencia realizada. x-ibm-languages: description: en: Transfer information made. creditorName: type: string description: Nombre del beneficiario x-ibm-languages: description: en: Beneficiary Name example: Nombre creditorAccount: additionalProperties: $ref: '#/definitions/_AccountReference' description: Cuenta del beneficiario x-ibm-languages: description: en: Beneficiary account creditorAgent: type: string description: BIC de la cuenta del beneficiario. x-ibm-languages: description: en: BIC of the beneficiary's account. example: XSXHXSMMXXX creditorAddress: additionalProperties: $ref: '#/definitions/Address' description: Dirección del beneficiario x-ibm-languages: description: en: Beneficiary address remittanceInformationUnstructured: type: string description: Informacion adicional x-ibm-languages: description: en: Additional information example: Informacion Adicional additionalProperties: true ListSinglePayment: type: array items: $ref: '#/definitions/SinglePayment' ListSinglePaymentBulk: type: array items: $ref: '#/definitions/SinglePaymentBulk' ListAccountReference: type: array items: $ref: '#/definitions/_AccountReference' RequestInicioPago: allOf: - $ref: '#/definitions/SinglePayment' ResponseInicioPago: properties: transactionStatus: type: string description: Estado de la transaccion x-ibm-languages: description: en: Transaction Status example: RCVD paymentId: properties: {} type: string description: Identificador del recurso que referencia a la iniciación de pago. x-ibm-languages: description: en: Identifier of the resource that refers to the initiation of payment. example: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 transactionFees: properties: {} description: Comisiones asociadas al pago. x-ibm-languages: description: en: Fees associated with payment. example: '' additionalProperties: $ref: '#/definitions/_Amount' transactionFeeIndicator: properties: {} type: boolean description: 'Si es igual a "true", la transacción implicará una comisión según el ASPSP o según lo acordado entre ASPSP y PSU. Si es igual a "false", la transacción no implicará ninguna comisión adicional para el PSU.' x-ibm-languages: description: en: 'If it is equal to "true", the transaction will involve a commission according to the ASPSP or as agreed between ASPSP and PSU. If it is equal to "false", the transaction will not imply any additional commission for the PSU. ' example: 'true' scaMethods: additionalProperties: $ref: '#/definitions/_authentication_object_list' description: Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. x-ibm-languages: description: en: This element is content if SCA is required and if the PSU can choose between different authentication methods. _links: properties: {} description: 'Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta:' x-ibm-languages: description: en: 'List of hyperlinks to be recognized by the TPP. Types supported in this answer: ' additionalProperties: $ref: '#/definitions/LinksInicioPago' psuMessage: properties: {} type: string example: Informacion para el PSU description: Texto a mostrar al PSU. x-ibm-languages: description: en: Text to display to the PSU. tppMessages: properties: {} additionalProperties: $ref: '#/definitions/ListTppMessages' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP additionalProperties: true required: - transactionStatus - paymentId - _links LinksInicioPago: properties: scaRedirect: $ref: '#/definitions/Link_scaRedirect' description: En caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el TPP x-ibm-languages: description: en: In case of SCA by redirection. Link where the PSU browser must be redirected by the TPP self: $ref: '#/definitions/Link_self' description: Link al recurso creado por esta petición. x-ibm-languages: description: en: Link to the resource created by this request. status: $ref: '#/definitions/Link_status' description: Link para recuperar el estado de la transacción x-ibm-languages: description: en: Link to retrieve the status of the transaction scaStatus: $ref: '#/definitions/Link_scaStatus' description: 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 x-ibm-languages: description: en: Link to check the SCA status corresponding to the authorization sub-resource. This link is only content if an authorization sub-resource has been created. startAuthorisationWithAuthenticationMethodSelection: description: 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" x-ibm-languages: description: en: link to the authorization end-point where the authorization sub-resource has to be generated while selecting the SCA method. This link is contained under the same conditions as the "scaMethods" field $ref: '#/definitions/Link_StartAuthorisationWithAuthenticationMethodSelection' startAuthorisation: description: 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) x-ibm-languages: description: en: in case an explicit start of the transaction authorization is necessary (there is no selection of the SCA method) $ref: '#/definitions/Link_StartAuthorisation' additionalProperties: false SinglePaymentBulk: type: object properties: instructedAmount: additionalProperties: $ref: '#/definitions/_Amount' description: Información de la transferencia realizada. x-ibm-languages: description: en: Transfer information made. creditorName: type: string description: Nombre del beneficiario x-ibm-languages: description: en: Beneficiary Name example: Nombre creditorAccount: additionalProperties: $ref: '#/definitions/_AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' x-ibm-languages: description: en: 'Account of the payer. Note: this field may be optional in some services such as bulk payments.' creditorAgent: type: string description: BIC de la cuenta del beneficiario x-ibm-languages: description: en: BIC of the beneficiary's account example: XXXLESMMXXX creditorAddress: additionalProperties: $ref: '#/definitions/Address' description: Direccion Beneficiario x-ibm-languages: description: en: Beneficiary Address remittanceInformationUnstructured: type: string description: Informacion Adicional x-ibm-languages: description: en: Additional Information example: Informacion adicional chargeBearer: type: string description: 'Valores permitidos: Valores permitidos: • DEBT • CRED • SHAR • SLEV' x-ibm-languages: description: en: 'Allowed values: Allowed values: • DEBT • CRED • SHAR • SLEV' example: SLEV additionalProperties: true paths: '/api-entrada-xs2a/services/v1/sva/aspsps': get: summary: Servicio de ASPSPs disponibles description: Este mensaje es enviado por el TPP hacia el HUB para recibir la información acerca de que ASPSP están disponibles en el sistema. operationId: getAspsps parameters: - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: OK tags: - Servicio de valor añadido '/api-entrada-xs2a/services/v2/sva/aspsps': get: summary: Servicio de ASPSPs disponibles description: Este mensaje es enviado por el TPP hacia el HUB para recibir la información acerca de que ASPSP están disponibles en el sistema. operationId: getAspspsV2 parameters: - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: OK tags: - Servicio de valor añadido '/api-entrada-xs2a/services/{aspsp}/v1/sva/payments/{payment-product}': post: summary: Realización inicio de pago sin informar de la cuenta ordenante description: Este servicio permite al TPP la realización de un inicio de un pago sin informar la cuenta del ordenante “debtorAccount” y proporciona el listado de cuentas durante el flujo SCA para que el PSU seleccione una. operationId: startPayment_NoDebtorAcc parameters: - name: aspsp in: path required: true type: string description: URL del hub donde se publica el servicio - name: payment-product in: path required: true type: string description: Producto de pago a usar. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-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' default: 'http://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"' default: 'http://www.exampleNok.com' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - name: Body required: true in: body schema: $ref: '#/definitions/RequestInicioPagoConListadoCuentasDisponible' description: Body de la petición responses: default: description: OK tags: - Servicio de valor añadido '/api-entrada-xs2a/services/{aspsp}/v1/payments/{payment-product}': post: summary: Inicio de pago description: Este mensaje es enviado por el TPP hacia el HUB para la realización de inicio de un pago. x-ibm-languages: summary: en: Payment start description: en: This message is sent by the TPP to the HUB for the realization of initiation of a payment. operationId: inicioPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: Content-Type in: header required: true type: string description: application/json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' 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-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: 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 ' - 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" ' - 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 ' - in: body name: body required: true schema: $ref: '#/definitions/RequestInicioPago' responses: default: description: OK x-ibm-languages: description: en: OK schema: $ref: '#/definitions/ResponseInicioPago' examples: application/json: transactionStatus: RCVD paymentId: 123-qwe-456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' self: href: /v1/payments/sepa-credit-transfers/123-qwe-456 status: href: /v1/payments/sepa-credit-transfers/123-qwe-456/status scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/authorisations/123auth456 tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/v1/bulk-payments/{payment-product}': post: 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 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 operationId: inicioPagoBulk consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: Content-Type in: header required: true type: string description: application/json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' 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-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: 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: true 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: true 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 ' - in: body name: body required: true schema: $ref: '#/definitions/RequestCrearBulk' responses: default: description: OK x-ibm-languages: description: en: OK schema: $ref: '#/definitions/ResponseInicioPago' examples: application/json: transactionStatus: RCVD paymentId: 123-qwe-456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' self: href: /v1/bulk-payments/sepa-credit-transfers/123-qwe-456 status: href: /v1/bulk-payments/sepa-credit-transfers/123-qwe-456/status scaStatus: href: /v1/bulk-payments/sepa-credit-transfers/123-qwe-456/authorisations/123auth456 tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/v1/periodic-payments/{payment-product}': post: summary: Inicio de pago 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.' x-ibm-languages: summary: en: Payment start 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. ' operationId: inicioPagoPeriodico consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: Content-Type in: header required: true type: string description: application/json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' 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-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: 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 ' - in: body name: body required: true schema: $ref: '#/definitions/RequestCrearPeriodico' responses: default: description: OK x-ibm-languages: description: en: OK schema: $ref: '#/definitions/ResponseInicioPago' tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/v1/payments/{payment-product}/{payment-id}/status': get: summary: status - Informacion del estado 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 x-ibm-languages: summary: en: status - 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 operationId: status 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: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string 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. 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 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: Accept in: header required: true type: string description: Formato soportado de la respuesta. x-ibm-languages: description: en: Supported response format. - 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-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 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: GET. Ej: 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 ' 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: 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: OK x-ibm-languages: description: en: OK examples: application/json: transactionStatus: ' ACCP' fundsAvailable: true tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/v1/bulk-payments/{payment-product}/{payment-id}/status': get: summary: statusBulk - Informacion del estado 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 x-ibm-languages: summary: en: statusBulk - 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 operationId: statusBulk 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: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string 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. 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 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: Accept in: header required: true type: string description: Formato soportado de la respuesta. x-ibm-languages: description: en: Supported response format. - 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-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 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: GET. Ej: 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 ' 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: 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: OK x-ibm-languages: description: en: OK examples: application/json: transactionStatus: ' ACCP' fundsAvailable: true tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/v1/periodic-payments/{payment-product}/{payment-id}/status': get: summary: statusPeriodic - Informacion del estado 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 x-ibm-languages: summary: en: statusPeriodic - 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 operationId: statusPeriodic 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: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string 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. 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 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: Accept in: header required: true type: string description: Formato soportado de la respuesta. x-ibm-languages: description: en: Supported response format. - 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-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 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: GET. Ej: 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 ' 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: 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: OK x-ibm-languages: description: en: OK examples: application/json: transactionStatus: ' ACCP' fundsAvailable: true tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/v1/payments/{payment-product}/{payment-id}': get: summary: Informacion del pago description: Este mensaje es enviado por el TPP al HUB para solicitar información de un inicio de pago x-ibm-languages: summary: en: Payment information description: en: This message is sent by the TPP to the HUB to request information about a payment start operationId: getPaymentInfo 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: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string 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. 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 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: Accept in: header required: true type: string description: 'Formato soportado de la respuesta. ' x-ibm-languages: description: en: 'Supported response format. ' - 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-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 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: GET. Ej: 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 ' 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: 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: OK x-ibm-languages: description: en: OK tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/v1/bulk-payments/{payment-product}/{payment-id}': get: summary: Informacion del pago description: Este mensaje es enviado por el TPP al HUB para solicitar información de un inicio de pago x-ibm-languages: summary: en: Payment information description: en: This message is sent by the TPP to the HUB to request information about a payment start operationId: getPaymentInfoBulk 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: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string 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. 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 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: Accept in: header required: true type: string description: 'Formato soportado de la respuesta. ' x-ibm-languages: description: en: 'Supported response format. ' - 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-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 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: GET. Ej: 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 ' 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: 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: OK x-ibm-languages: description: en: OK tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/v1/periodic-payments/{payment-product}/{payment-id}': get: summary: Informacion del pago description: Este mensaje es enviado por el TPP al HUB para solicitar información de un inicio de pago x-ibm-languages: summary: en: Payment information description: en: This message is sent by the TPP to the HUB to request information about a payment start operationId: getPaymentInfoPeriodic 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: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string 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. 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 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: Accept in: header required: true type: string description: 'Formato soportado de la respuesta. ' x-ibm-languages: description: en: 'Supported response format. ' - 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-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 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: GET. Ej: 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 ' 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: 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: OK x-ibm-languages: description: en: OK tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/v1/{payment-service}/{payment-product}/{payment-id}': delete: 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.' 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. ' operationId: deletePayment 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: payment-service in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - payments - bulk-payments - periodic-payments - name: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string 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. 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 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-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 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: GET, POST, PUT, PATCH, DELETE. Ej: 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 ' 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: 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: OK x-ibm-languages: description: en: OK examples: application/json: transactionStatus: ACTC _links: startAuthorisation: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{asp-name}/v1/multibanco/catalogue/{multibanco-payment-type}': get: 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.' 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.' operationId: getMultibancoCatalogue parameters: - name: asp-name 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: multibanco-payment-type in: path required: true type: string description: Tipo de pago multibanco x-ibm-languages: description: en: Multibank payment type - name: paymentReference in: query required: false type: string description: Referencia de la operación x-ibm-languages: description: en: Operation reference - name: instructedAmount in: query required: false type: string description: Importe de pago x-ibm-languages: description: en: Payment amount - name: requestedExecutionDate in: query required: false type: string description: Fecha de la ejecución del pago x-ibm-languages: description: en: Payment execution date - 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: 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: '200': description: '' x-ibm-languages: description: en: '' schema: $ref: '#/definitions/ResponseGetMultibankCatalogue' tags: - Servicios multibanco '/api-entrada-xs2a/services/{asp-name}/v1/multibanco/social-security/withholding': post: 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.' consumes: - application/json produces: - application/json 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.' parameters: - name: asp-name 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: Content-Type in: header required: true type: string description: application/json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Identificador que el PSU utiliza para identificarse en su ASPSP. ' x-ibm-languages: description: en: 'Identifier that the PSU uses to identify itself in its ASPSP. ' - name: PSU-ID-Type in: header required: false type: string description: 'Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso.' x-ibm-languages: description: en: '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: 'Identifier of "company" 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 content.' - 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: 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/RequestSocialSecurityWithholding' responses: '200': description: Respuesta a la operación x-ibm-languages: description: en: Operation response schema: $ref: '#/definitions/ResponseSocialSecurityWithholding' tags: - Servicios multibanco '/api-entrada-xs2a/services/{asp-name}/v1/multibanco/payments/{multibanco-payment-type}': post: 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' consumes: - application/json produces: - application/json 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.' parameters: - name: asp-name 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: multibanco-payment-type in: path required: true type: string description: Tipo de pago multibanco x-ibm-languages: description: en: Multibank payment type - name: Content-Type in: header required: true type: string description: application/json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' 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 required: false type: string description: 'Identificador que el PSU utiliza para identificarse en su ASPSP. ' x-ibm-languages: description: en: 'Identifier that the PSU uses to identify itself in its ASPSP. ' - name: PSU-ID-Type in: header required: false type: string description: 'Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso.' x-ibm-languages: description: en: '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: 'Identifier of "company" 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 content.' - 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: 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: TPP-Explicit-Authorisation-Preferred in: header required: false type: boolean 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.' 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.' default: false - 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/RequestStartMultibankPayment' responses: '201': description: Created x-ibm-languages: description: en: Created schema: $ref: '#/definitions/ResponseStartMultibankPayment' tags: - Servicios multibanco '/api-entrada-xs2a/services/{asp-name}/v1/multibanco-payments/{multibanco-payment-type}/{paymentId}/status': get: 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.' consumes: - application/json produces: - application/json 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.' parameters: - name: asp-name 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: multibanco-payment-type in: path required: true type: string description: Tipo de pago multibanco x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - 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: Accept in: header required: true type: string description: Formato soportado de la respuesta. x-ibm-languages: description: en: Supported response format. - 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: 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: '200': description: '' x-ibm-languages: description: en: '' schema: $ref: '#/definitions/ResponseGetStatusMultibankPayment' tags: - Servicios multibanco '/api-entrada-xs2a/services/{asp-name}/v1/multibanco-payments/{multibanco-payment-type}/{paymentId}': get: 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.' consumes: - application/json produces: - application/json 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.' parameters: - name: asp-name 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: multibanco-payment-type in: path required: true type: string description: Tipo de pago multibanco x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - 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: 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: '200': description: '' x-ibm-languages: description: en: '' schema: $ref: '#/definitions/ResponseGetMultibankPayment' tags: - Servicios multibanco delete: 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' consumes: - application/json produces: - application/json 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' parameters: - name: asp-name 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: multibanco-payment-type in: path required: true type: string description: Tipo de pago multibanco x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - 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: 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: '200': description: 'Deleted' x-ibm-languages: description: en: 'Deleted' schema: $ref: '#/definitions/ResponseDeleteMultibankPayment' tags: - Servicios multibanco '/api-entrada-xs2a/services/{asp-name}/v1/multibanco-payments/{multibanco-payment-type}/{paymentId}/authorisations': post: consumes: - application/json produces: - application/json parameters: - name: asp-name 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: multibanco-payment-type in: path required: true type: string description: Tipo de pago multibanco x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - 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: PSU-Corporate-ID in: header required: false type: string description: 'Identificador de "empresa" en los Canales Online.' x-ibm-languages: description: en: 'Identifier of "company" 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 content.' - 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: 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: Created x-ibm-languages: description: en: Created schema: $ref: '#/definitions/ResponseMultibankAuthorizeConsentEstablishment' tags: - Servicios multibanco get: consumes: - application/json produces: - application/json parameters: - name: asp-name 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: multibanco-payment-type in: path required: true type: string description: Tipo de pago multibanco x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - 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: PSU-Corporate-ID in: header required: false type: string description: 'Identificador de "empresa" en los Canales Online.' x-ibm-languages: description: en: 'Identifier of "company" 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 content.' - 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: 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: '200': description: '' x-ibm-languages: description: en: '' schema: $ref: '#/definitions/ResponseMultibankAuthorizationSubresources' tags: - Servicios multibanco '/api-entrada-xs2a/services/{asp-name}/v1/multibanco-payments/{multibanco-payment-type}/{paymentId}/authorisations/{authorisationId}': put: consumes: - application/json produces: - application/json parameters: - name: asp-name 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: multibanco-payment-type in: path required: true type: string description: Tipo de pago multibanco x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - name: authorisationId in: path required: true type: string description: Identificador del sub-recurso asociado al inicio de pago Multibanco x-ibm-languages: description: en: Identifier of the sub-resource associated with the Multibanco payment initiation - 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: PSU-Corporate-ID in: header required: false type: string description: 'Identificador de "empresa" en los Canales Online.' x-ibm-languages: description: en: 'Identifier of "company" 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 content.' - 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: 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/RequestActualizarDatosPsu' responses: '200': description: '' x-ibm-languages: description: en: '' schema: $ref: '#/definitions/ResponseMultibankSelectSCAMethod' tags: - Servicios multibanco get: consumes: - application/json produces: - application/json parameters: - name: asp-name 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: multibanco-payment-type in: path required: true type: string description: Tipo de pago multibanco x-ibm-languages: description: en: Multibank payment type - name: paymentId in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago x-ibm-languages: description: en: Resource identifier that refers to the payment initiation - name: authorisationId in: path required: true type: string description: Identificador del sub-recurso asociado al inicio de pago Multibanco x-ibm-languages: description: en: Identifier of the sub-resource associated with the Multibanco payment initiation - 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: PSU-Corporate-ID in: header required: false type: string description: 'Identificador de "empresa" en los Canales Online.' x-ibm-languages: description: en: 'Identifier of "company" 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 content.' - 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: 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: '200': description: '' x-ibm-languages: description: en: '' schema: $ref: '#/definitions/ResponseMultibankGetSCAStatus' tags: - Servicios multibanco '/api-entrada-xs2a/services/{aspsp}/v1/funds-confirmations': post: summary: Funds Confirmation - Confirmacion 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.' 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. ' operationId: fundsConfirmation 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 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' 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 required: true type: string description: 'Es contenido si viaja el campo Signature. 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 required: true type: string description: Firma de la peticion 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 firmado x-ibm-languages: description: en: Certificate signed - name: Authorization in: header required: true type: string 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. 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 required: true type: string 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. 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. - in: body name: body required: true schema: $ref: '#/definitions/fundsConfirmationRequest' responses: default: headers: X-Request-ID: type: string 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' 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 ' description: OK x-ibm-languages: description: en: OK examples: application/json: fundsAvailable: true schema: $ref: '#/definitions/fundsConfirmationResponse' tags: - Servicio de confirmacion de fondos '/api-entrada-xs2a/services/{aspsp}/v1/accounts': get: summary: Obtencion 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.' 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. ' operationId: getAccountListv11 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: withBalance in: query required: false default: 'false' type: string 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.' 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 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: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' default: 7890-asdf-4321 - 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-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-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el 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 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: GET, POST, PUT, PATCH, DELETE. Ej: 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 ' 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: 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 ' default: TestTPPCertificate responses: default: description: OK x-ibm-languages: description: en: OK examples: application/json: accounts: - resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e80f iban: ES1111111111111111111111 currency: EUR product: Girokonto cashAccountType: CACC name: Main Account _links: balances: href: /v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances transactions: href: /v1/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/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances schema: $ref: '#/definitions/responseAccountsList' tags: - Servicio de acceso a información sobre cuentas '/api-entrada-xs2a/services/{aspsp}/v1/accounts/{account-id}': get: summary: Lectura detalle de 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.' 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. ' operationId: getAccountIdv11 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: account-id in: path required: true type: string - name: withBalance in: query required: false default: 'false' type: string 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.' 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 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: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' default: 7890-asdf-4321 - 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-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-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el 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 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: GET, POST, PUT, PATCH, DELETE. Ej: 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 ' 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: 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 ' default: TestTPPCertificate responses: default: description: OK x-ibm-languages: description: en: OK examples: application/json: 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/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances transactions: href: /v1/accounts/3dc3d5b3-7023-4848-9853--5400a64e80f/transactions schema: $ref: '#/definitions/responseAccountDetail' tags: - Servicio de acceso a información sobre cuentas '/api-entrada-xs2a/services/{aspsp}/v1/accounts/{account-id}/transactions': get: summary: Obtener las 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.' 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. ' operationId: accountsTrasactions 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: account-id in: path required: true type: string description: Id de la cuenta x-ibm-languages: description: en: Account id - name: dateFrom type: string required: false in: query description: Fecha de inicio de consulta. Es incluido si no es requerido un acceso delta. x-ibm-languages: description: en: Query start date. It is included if delta access is not required. - name: dateTo type: string required: false in: query description: 'Fecha de fin de consulta. Su valor por defecto es la facha actual si no es dado. Ej: 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 type: string required: false in: query description: 'Al ser indicado, nos daría los resultados desde la llamada con transactionId anterior al dado. Alternativo a dateFrom y 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 type: string required: true 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”.' 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 type: boolean required: false 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. 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 type: string required: false default: 'false' 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.' 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 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: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' default: 7890-asdf-4321 - 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-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-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el 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 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: GET, POST, PUT, PATCH, DELETE. Ej: 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 ' 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: 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 ' default: TestTPPCertificate responses: default: description: 200 OK x-ibm-languages: description: en: 200 OK schema: $ref: '#/definitions/responseAccountTransactions' tags: - Servicio de acceso a información sobre cuentas '/api-entrada-xs2a/services/{aspsp}/v1/accounts/{account-id}/balances': get: summary: Informacion de los balances del pago 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.' 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. ' operationId: getAccountBalances 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: account-id in: path required: true type: string description: Id de la cuenta x-ibm-languages: description: en: Account id - 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: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' default: 7890-asdf-4321 - 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-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-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el 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 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: GET, POST, PUT, PATCH, DELETE. Ej: 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 ' 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: 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 ' default: TestTPPCertificate responses: default: description: OK x-ibm-languages: description: en: OK examples: application/json: account: iban: ES1111111111111111111111 balances: - balanceType: closingBooked balanceAmount: currency: EUR amount: '500.00' referenceDate: '2017-10-25' - balanceType: expected balanceAmount: currency: EUR amount: '900.00' lastChangeDateTime: '2017-10-25T15:30:35.035Z' schema: $ref: '#/definitions/responseAccountBalances' tags: - Servicio de acceso a información sobre cuentas '/api-entrada-xs2a/services/{aspsp}/{version}/consents/{consent-id}': get: summary: Información del estado de una solicitud de consentimiento description: Este servicio permite al TPP conocer el estado de una solicitud de consentimiento iniciada previamente. x-ibm-languages: summary: en: Information on the status of a consent request 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: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - 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: default: description: Respuesta a la operación x-ibm-languages: description: en: Operation response schema: $ref: '#/definitions/responseGetInfoConsent' tags: - Gestion de consentimiento delete: summary: Eliminar una solicitud de consentimiento 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: Delete a consent request 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: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - 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: Respuesta a la operación x-ibm-languages: description: en: Operation response schema: $ref: '#/definitions/responseDeleteConsent' tags: - Gestion de consentimiento '/api-entrada-xs2a/services/{aspsp}/{version}/consents/{consent-id}/status': get: summary: Información del estado de una solicitud de consentimiento description: Este servicio permite al TPP conocer el estado de una solicitud de consentimiento iniciada previamente. x-ibm-languages: summary: en: Information on the status of a consent request 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: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - 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: Respuesta a la operación x-ibm-languages: description: en: Operation response schema: $ref: '#/definitions/responseStatusConsent' tags: - Gestion de consentimiento '/api-entrada-xs2a/services/{aspsp}/{version}/consents': post: summary: Solicitud de consentimiento 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 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: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - 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: 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: 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 ' - 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/requestGetConsent' responses: default: description: Respuesta a la operación x-ibm-languages: description: en: Operation response schema: $ref: '#/definitions/responseGetConsent' tags: - Gestion de consentimiento '/api-entrada-xs2a/services/{aspsp}/{version}/consents/confirmation-of-funds': post: summary: Consentimiento de confirmación de fondos 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: Consent for confirmation of funds 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: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - 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 ' - name: Body required: true in: body schema: $ref: '#/definitions/requestPostConsentFundsConfirmation' description: Cuerpo del mensaje x-ibm-languages: description: en: Message body responses: '201': description: '' x-ibm-languages: description: en: '' schema: $ref: '#/definitions/responsePostConsentFundsConfirmation' tags: - Gestion de consentimiento '/api-entrada-xs2a/services/{aspsp}/{version}/consents/confirmation-of-funds/{consent-id}/status': get: summary: Estado del consentimiento de confirmación de fondos 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: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - 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: '' x-ibm-languages: description: en: '' schema: $ref: '#/definitions/responsePostConsentFundsConfirmation' tags: - Gestion de consentimiento '/api-entrada-xs2a/services/{aspsp}/{version}/consents/confirmation-of-funds/{consent-id}': get: summary: Estado del consentimiento de confirmación de fondos 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: 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: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - 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: '' x-ibm-languages: description: en: '' schema: $ref: '#/definitions/responsePostConsentFundsConfirmation' tags: - Gestion de consentimiento delete: summary: Estado del consentimiento de confirmación de fondos 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: 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: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - 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: Cancelación correcta x-ibm-languages: description: en: Correct cancellation tags: - Gestion de consentimiento '/api-entrada-xs2a/services/{aspsp}/v1/{payment-service}/{payment-product}/{payment-id}/authorisations': post: summary: Inicio del proceso de autorización en caso de Inicio de Pago description: 'El proceso de iniciar autorización es un proceso necesario para crear un nuevo sub-recurso de autorización (Si no se ha creado implícitamente).' x-ibm-languages: summary: en: Start of the authorization process in case of Start of Payment description: en: 'The process of initiating authorization is a process required to create a new authorization sub-resource (if it has not been created implicitly).' operationId: postAutorizacionPagoPIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizacionInicioPago' examples: application/json: scaStatus: received authorisationId: 123auth456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Servicio de iniciacion de pagos get: summary: 'Obtener sub-recursos de la autorización en caso de Cancelación de Pago' description: 'Proporcionará un array de identificadores de recursos para todos los sub-recursos de autorización generados.' x-ibm-languages: summary: en: Obtain sub-resources of the authorization in case of Cancellation of Payment description: en: 'Will provide an array of resource identifiers for all generated authorization sub-resources' operationId: getAutorizacionPagoPIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' - name: payment-id in: path required: true type: string - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers description: Identificador del recurso que referencia a la iniciación de pago o consentimiento. - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' examples: application/json: cancellationIds: - 123auth456 '/api-entrada-xs2a/services/{aspsp}/v1/{payment-service}/{payment-product}/{payment-id}/authorisations/{authorisation-id}': put: summary: Actualizar datos del PSU en caso de Inicio de Pago description: 'Este mensaje es enviado por el TPP hacia el ASPSP a través del HUB para informar el método SCA seleccionado por el PSU.' x-ibm-languages: summary: en: Update PSU data in case of Payment Initiation description: en: 'This message is sent by the TPP to the ASPSP through the HUB to inform the SCA method selected by the PSU.' operationId: putAutorizacionPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path required: true type: string - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - name: Body required: true in: body schema: $ref: '#/definitions/RequestActualizarDatosPsu' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizarDatosPsu' examples: application/json: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Servicio de iniciacion de pagos get: summary: Endpoint en caso de Inicio de Pago description: 'Mensaje enviado por el TPP al ASPSP a través del Hub para solicitar el estado SCA de un sub-recurso de autorización' x-ibm-languages: summary: en: Endpoint in case of Start of Payment description: en: 'Message sent by the TPP to the ASPSP through the Hub to request the SCA status of an authorization sub-resource' operationId: GetByIdAutorizacionPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: authorisation-id in: path required: true type: string - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' examples: application/json: scaStatus: ' finalised' tags: - Servicio de iniciacion de pagos '/api-entrada-xs2a/services/{aspsp}/{version}/consents/{consent-id}/authorisations/{authorisation-id}': put: summary: Actualizar datos del PSU en caso de Consentimiento de Información sobre Cuentas description: 'Este mensaje es enviado por el TPP hacia el ASPSP a través del HUB para informar el método SCA seleccionado por el PSU.' x-ibm-languages: summary: en: Update PSU data in case of Consent of Information on Accounts description: en: 'This message is sent by the TPP to the ASPSP through the HUB to inform the SCA method selected by the PSU.' operationId: putAutorizacionAIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - name: authorisation-id in: path required: true type: string - name: consent-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - name: Body required: true in: body schema: $ref: '#/definitions/RequestActualizarDatosPsu' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizarDatosPsu' examples: application/json: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Gestion de consentimiento get: summary: Endpoint en caso de Consentimiento de Información de cuenta description: 'Mensaje enviado por el TPP al ASPSP a través del Hub para solicitar el estado SCA de un sub-recurso de autorización' x-ibm-languages: summary: en: Endpoint in case of Consent of Information on Accounts description: en: 'Message sent by the TPP to the ASPSP through the Hub to request the SCA status of an authorization sub-resource' operationId: GetByIdAutorizacionAIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - name: authorisation-id in: path required: true type: string - name: consent-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' examples: application/json: scaStatus: ' finalised' tags: - Gestion de consentimiento '/api-entrada-xs2a/services/{aspsp}/{version}/consents/{consent-id}/authorisations': post: summary: Inicio del proceso de autorización en caso de Consentimiento de Información sobre Cuentas description: El proceso de iniciar autorización es un proceso necesario para crear un nuevo sub-recurso de autorización (Si no se ha creado implícitamente). x-ibm-languages: summary: en: Start of the authorization process in case of Consent of Information on Accounts description: en: The process of initiating authorization is a process required to create a new authorization sub-resource (if it has not been created implicitly). operationId: postAutorizacionAIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string - name: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - name: consent-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizacionInicioPago' examples: application/json: scaStatus: received authorisationId: 123auth456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Gestion de consentimiento get: summary: Obtener sub-recursos de la autorización en caso de Consentimiento de Información sobre Cuentas description: Proporcionará un array de identificadores de recursos para todos los sub-recursos de autorización generados x-ibm-languages: summary: en: Obtain sub-resources of the authorization in case of Consent of Information on Accounts description: en: Will provide an array of resource identifiers for all generated authorization sub-resources operationId: getAutorizacionAIS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' - name: version in: path required: true type: string description: Version del servicio x-ibm-languages: description: en: Service version - name: consent-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago o consentimiento. - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' examples: application/json: cancellationIds: - 123auth456 tags: - Operaciones procesos comunes '/api-entrada-xs2a/services/{aspsp}/v1/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations/{cancellation-id}': put: summary: Endpoint en caso de Cancelación de Pago description: Endpoint en caso de Cancelación de Pago operationId: putCancellationAutorizacionPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: cancellation-id in: path required: true type: string - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - name: Body required: true in: body schema: $ref: '#/definitions/RequestActualizarDatosPsu' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizarDatosPsu' examples: application/json: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Operaciones procesos comunes get: summary: Endpoint en caso de Cancelación de Pago description: Endpoint en caso de Cancelación de Pago operationId: GetByIdCancellationAutorizacionPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: cancellation-id in: path required: true type: string description: Identificador del subrecurso asociado al inicio de pago o consentimiento. - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' examples: application/json: scaStatus: ' finalised' tags: - Operaciones procesos comunes '/api-entrada-xs2a/services/{aspsp}/v1/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations': post: summary: Endpoint en caso de Cancelación de Pago description: Endpoint en caso de Cancelación de Pago operationId: cancellationAutorizacionPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizacionInicioPago' examples: application/json: scaStatus: received authorisationId: 123auth456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Operaciones procesos comunes get: summary: Endpoint en caso de Cancelación de Pago description: Endpoint en caso de Cancelación de Pago operationId: GetCancellationAutorizacionPago consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - domestic-cross-currency-payments-uk - domestic-chaps-payments-uk - domestic-faster-payments-uk - domestic-bacs-payments-uk - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: payment-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago o consentimiento. - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' examples: application/json: cancellationIds: - 123auth456 tags: - Operaciones procesos comunes '/api-entrada-xs2a/services/{aspsp}/v1/{payment-service}/{payment-product}/cancellation-authorisations': post: summary: Endpoint en caso de Cancelación de Pago description: Endpoint en caso de Cancelación de Pago operationId: cancellationAutorizacionPagoNoId consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizacionInicioPago' examples: application/json: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Operaciones procesos comunes get: summary: Endpoint en caso de Cancelación de Pago description: Endpoint en caso de Cancelación de Pago operationId: GetCancellationAutorizacionPagoNoId consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-service in: path required: true type: string enum: - payments - bulk-payments - periodic-payments - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' tags: - Operaciones procesos comunes '/api-entrada-xs2a/services/{aspsp}/v2/consents/confirmation-of-funds/{consent-id}/authorisations/{authorisation-id}': put: summary: Endpoint en caso de actualizacion de datos PSU description: Este mensaje es enviado por el TPP hacia el ASPSP a través del HUB para informar el método SCA seleccionado por el PSU. El SCA-Approach puede depender del método SCA seleccionado. operationId: putCancellationAutorizacionPagoFCS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: authorisation-id in: path required: true type: string description: Identificador del subrecurso asociado al ID de autorización - name: consent-id in: path required: true type: string description: 'Identificador asociado al ID de consentimiento, creado previamente' - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - name: Body required: true in: body schema: $ref: '#/definitions/RequestActualizarDatosPsu' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizarDatosPsu' examples: application/json: scaStatus: scaMethodSelected _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Operaciones procesos comunes get: summary: Este mensaje es enviado por el TPP hacia el ASPSP a través del HUB para informar el método SCA seleccionado por el PSU. El SCA-Approach puede depender del método SCA seleccionado. description: Endpoint en caso de Cancelación de Pago operationId: GetByIdCancellationAutorizacionPagoFCS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' enum: - redsys - BBVA - BBVAPT - BBVABE - BBVAFR - BBVAEUK - caixabank - BancSabadell - bancosantander - bancamarch - bankoa - cajamar - arquia - BFF - colonya - eurocajarural - evobanco - fiarebancaetica - bancopichincha - unicajabanco - cajasur - kutxabank - bankinter - renta4 - BCE - laboralkutxa - mediolanum - openbank - ibercaja - selfbank - inversis - andbank - wizink - name: authorisation-id in: path required: true type: string description: Identificador del subrecurso asociado al ID de autorización - name: consent-id in: path required: true type: string description: 'Identificador asociado al ID de consentimiento, creado previamente' - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' examples: application/json: scaStatus: ' finalised' tags: - Operaciones procesos comunes '/api-entrada-xs2a/services/{aspsp}/v2/consents/confirmation-of-funds/{consent-id}/authorisations': post: summary: Endpoint en caso de Cancelación de Pago description: Endpoint en caso de Cancelación de Pago operationId: cancellationAutorizacionPagoFCS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string - name: consent-id in: path required: true type: string - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizacionInicioPago' examples: application/json: scaStatus: received authorisationId: 123auth456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' scaStatus: href: /v1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations/123auth456 tags: - Operaciones procesos comunes get: summary: Endpoint en caso de Cancelación de Pago description: Endpoint en caso de Cancelación de Pago operationId: GetCancellationAutorizacionPagoFCS consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: 'Nombre del ASPSP al que desea realizar la petición.(BBVA, Banco Santander ...)' - name: consent-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago o consentimiento. - name: Content-Type in: header required: true type: string description: application/json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' - name: TPP-Redirect-Preferred in: header required: false type: string description: 'Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU.' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 'Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' examples: application/json: cancellationIds: - 123auth456 tags: - Operaciones procesos comunes