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: requestGetConsent: type: object properties: access: properties: accounts: type: array items: type: object properties: iban: type: string bban: type: string pan: type: string masked_pan: type: string msisdn: type: string currency: type: string balances: type: array items: type: object properties: iban: type: string bban: type: string pan: type: string masked_pan: type: string msisdn: type: string currency: type: string transactions: type: array items: type: object properties: iban: type: string bban: type: string pan: type: string masked_pan: type: string msisdn: type: string currency: type: string availableAccounts: type: string allPsd2: type: string 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”. $ref: '#/definitions/_AccountAccess' recurringIndicator: type: boolean description: 'true: acceso recurrente a la cuenta. false: un solo acceso.' 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.' 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. 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. example: "false" additionalProperties: true required: - access responseGetConsent: properties: psuMessage: type: string example: Texto de ejemplo description: Texto a mostrar al PSU. tppMessage: items: type: object properties: category: type: string code: type: string path: type: string text: type: string example: "" description: Mensaje para el TPP. $ref: '#/definitions/_tppMessage' transactionStatus: type: string description: Estado de la transacción. Valores definidos en anexos. example: ACCP consentId: type: string description: Identificador del recurso que referencia al consentimiento. Debe ser contenido si se generó un consentimiento. example: 123-QWE-456 _links: description: 'Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta: redirect, oAuth, self, status' $ref: '#/definitions/_links' responseStatusConsent: properties: psuMessage: type: string description: Mensaje para mostrar example: Informacion para PSU tppMessage: items: type: object properties: category: type: string code: type: string path: type: string text: type: string description: Mensaje para el TPP $ref: '#/definitions/_tppMessage' transactionStatus: type: string description: Estado de la transacción (solicitud de consentimiento identificado por consent-id) example: AcceptedTechnicalValidation responseGetInfoConsent: properties: psuMessage: type: string description: Texto a mostrar al PSU example: Informacion PSU tppMessage: items: type: object properties: category: type: string code: type: string path: type: string text: type: string $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP transactionStatus: type: string description: Estado de la transacción. Valores definidos en anexos. example: ACCP access: properties: accounts: type: array items: type: object properties: iban: type: string bban: type: string pan: type: string masked_pan: type: string msisdn: type: string currency: type: string balances: type: array items: type: object $ref: '#/definitions/requestGetConsent/properties/access/properties/accounts' transactions: type: array items: type: object $ref: '#/definitions/requestGetConsent/properties/access/properties/accounts' availableAccounts: type: string allPsd2: type: string 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”. $ref: '#/definitions/_AccountAccess' recurringIndicator: type: boolean description: 'true: acceso recurrente a la cuenta. false: un solo acceso.' 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.' 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. example: "4" lastActionDate: type: string description: Fecha de la última modificación realizada sobre el consentimiento. example: "2018-01-01" consentStatus: type: string example: valid description: 'Valores permitidos: empty, valid, blocked, expired, deleted' required: - access - recurringIndicator - validUntil - transactionStatus - lastActionDate - frequencyPerDay - consentStatus responseDeleteConsent: properties: psuMessage: type: string description: Texto a mostrar al PSU example: Mensaje PSU tppMessage: items: type: object properties: category: type: string code: type: string path: type: string text: type: string description: Mensaje para el TPP $ref: '#/definitions/_tppMessage' example: Mensaje para el TPP _access: properties: accounts: items: type: string $ref: '#/definitions/_accountList' additionalProperties: false _accountList: type: array items: $ref: '#/definitions/_AccountDetails' _AccountAccess: properties: accounts: $ref: '#/definitions/_accountList' 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. balances: $ref: '#/definitions/_accountList' 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. transactions: $ref: '#/definitions/_accountList' 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. availableAccounts: type: string description: Solo el valor “allAccounts” es admitido example: allAccounts allPsd2: type: string example: allAccounts description: Solo el valor “allAccounts” es admitido additionalProperties: false Link_scaRedirect: properties: href: type: string description: URL para el link example: https://hub.example.es/authorize additionalProperties: false Link_self: properties: href: type: string description: URL asociada al link example: /v1/payments/sepa-credit-transfers/123-qwe-456 additionalProperties: false Link_status: properties: href: type: string example: /v1/payments/sepa-credit-transfers/123-qwe-456/status description: URL del 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 additionalProperties: false Link_StartAuthorisationWithAuthenticationMethodSelection: properties: href: type: string example: https://hub.example.es/authorize description: URL asociada al link additionalProperties: false _links: properties: scaRedirect: example: "" $ref: '#/definitions/Link_scaRedirect' description: En caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el TPP. startAuthorisation: example: "" $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) startAuthorisationWithAuthenticationMethodSelection: 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" $ref: '#/definitions/Link_StartAuthorisationWithAuthenticationMethodSelection' self: $ref: '#/definitions/Link_self' description: link al recurso creado por esta petición. status: description: Link para recuperar el estado de la transacción. $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. $ref: '#/definitions/Link_scaStatus' additionalProperties: false requestPostConsentFundsConfirmation: properties: account: $ref: '#/definitions/_AccountReference' description: Cuenta sobre la que se realizará la consulta de fondos. cardNumber: type: string description: Número de tarjeta de la tarjeta emitida por el PIISP. Debe ser enviada si está disponible. example: 4548-8100-0000-0001 cardExpiryDate: type: string description: Fecha de caducidad de la tarjeta emitida por el PIISP. (Formato ISODate) example: "2018-05-17" cardInformation: type: string description: Explicación adicional del producto. 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 example: Informacion adicional additionalProperties: false required: - account responsePostConsentFundsConfirmation: properties: consentStatus: type: string description: Estado de autenticación del consentimiento. Ver valores definidos en 6.5 Estados de consentimiento consentId: type: string description: Identificador del recurso que referencia al consentimiento. Debe ser contenido si se generó un consentimiento. scaMethods: type: string description: 'Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. Si este dato es contenido también se informará el link "startAuthorisationWithAuthenticationMethodSelection”. Esto métodos deberán ser presentados al PSU. Nota: Solo si ASPSP soporta selección del método SCA' _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)' example: "" $ref: '#/definitions/_links' tppMessages: description: Mensaje para el TPP enviado a través del HUB. $ref: '#/definitions/_tppMessage' psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. additionalProperties: false required: - consentStatus - _links - consentId responseGetConsentFundsConfirmation: properties: consentStatus: type: string description: Estado del consentimiento. Ver valores definidos en 6.5 Estados de consentimiento example: valid psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al 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. $ref: '#/definitions/_AccountReference' cardNumber: type: string description: Número de tarjeta de la tarjeta emitida por el PIISP. Debe ser enviada si está disponible. example: 4548-8100-0000-0001 cardInformation: type: string description: Explicación adicional del producto. 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 example: Informacion adicional consentStatus: type: string description: Estado del consentimiento. Valores definidos en anexos. example: valid psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. example: Mensaje de ejemplo tppMessages: description: Mensaje para el TPP enviado a través del HUB. $ref: '#/definitions/_tppMessage' additionalProperties: false required: - account - consentStatus Address: type: object properties: street: type: string description: Calle example: Ejemplo de Calle buildingNumber: type: string description: Numero example: "5" city: type: string description: Ciudad example: Cordoba postalCode: type: string description: Codigo Postal example: "14100" country: type: string description: Pais example: ES Amount: type: object properties: currency: type: string description: Moneda del importe example: EUR amount: type: string description: Cantidad del importe example: "500.00" 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. example: "true" debtorAccount: $ref: '#/definitions/_AccountReference' description: Cuenta del ordenante. 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' $ref: '#/definitions/ListSinglePaymentBulk' SinglePayment: type: object properties: instructedAmount: $ref: '#/definitions/_Amount' description: Información de la transferencia realizada. creditorName: type: string description: Nombre del beneficiario example: Nombre creditorAccount: $ref: '#/definitions/_AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' creditorAgent: type: string description: BIC de la cuenta del beneficiario example: XXXLESMMXXX creditorAddress: $ref: '#/definitions/Address' description: Direccion Beneficiario remittanceInformationUnstructured: type: string description: Informacion Adicional example: Informacion adicional chargeBearer: type: string description: 'Valores permitidos: Valores permitidos: • DEBT • CRED • SHAR • SLEV' example: SLEV debtorAccount: $ref: '#/definitions/_AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' AccountAccess: type: object properties: accounts: items: $ref: '#/definitions/_AccountReference' $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 y serán preguntadas en un diálogo entre PSU-ASPSP. Además, la lista de balances y transactions también deben ir vacías si son usadas. balances: items: $ref: '#/definitions/_AccountReference' $ref: '#/definitions/ListAccountReference' description: Indica las cuentas sobre las que pedir balances. Si la lista está vacía, el TPP está solicitando todas las cuentas accesibles y serán preguntadas en un diálogo entre PSU-ASPSP. Además, la lista de accounts y transactions también deben ir vacías si son usadas. transactions: items: $ref: '#/definitions/_AccountReference' $ref: '#/definitions/ListAccountReference' description: Indica las cuentas sobre las que pedir transacciones. Si la lista está vacía, el TPP está solicitando todas las cuentas accesibles y serán preguntadas en un diálogo entre PSU-ASPSP. Además, la lista de balances y accounts también deben ir vacías si son usadas. availableAccounts: type: string example: allAcounts description: Solo el valor “allAcounts” es admitido availableAccountsWithBalance: type: string example: allAcounts description: Solo el valor “allAcounts” es admitido allPsd2: type: string example: allAcounts description: Solo el valor “allAcounts” es admitido RequestInicioPago: type: object properties: instructedAmount: $ref: '#/definitions/_Amount' debtorAccount: $ref: '#/definitions/_AccountReference' creditorName: type: string example: Nombre123 creditorAccount: $ref: '#/definitions/_AccountReference' creditorAgent: type: string example: XSXHXSMMXXX creditorAddress: $ref: '#/definitions/Address' remittanceInformationUnstructured: type: string example: Information Example chargeBearer: type: string example: SLEV requestedExecutionDate: type: string example: "2019-01-12" RequestCrearPeriodico: type: object properties: startDate: type: string description: El primer día aplicable de ejecución desde esta fecha es el primer pago example: "2018-12-20" executionRule: type: string description: 'Valores soportados: • following • preceeding Define el comportamiento cuando las fechas del pago recurrente caen en fin de semana o festivo. Entonces el pago se ejecuta el día laboral anterior o posterior. El ASPSP puede rechazar la petición debido al valor comunicado si las reglas de la Banca Online no soportan esta regla de ejecución.' example: following endDate: type: string example: "2018-12-20" description: El último día aplicable de ejecución. Si no viene se trata de una orden permanente sin fin. frequency: type: string description: 'La frecuencia del pago recurrente resultante de esta orden permanente. Valores permitidos: • daily • weekly • everyTwoWeeks • monthly • everyTwoMonths • quarterly • semi-annual' example: semi-annual dayOfExecution: type: string description: '"31" es último. Sigue la expresión regular \d{1,2} La fecha se refiere a la zona horaria del ASPSP. Solo si soportado en Banca Online del ASPSP.' example: "01" instructedAmount: $ref: '#/definitions/_Amount' description: Información de la transferencia realizada. debtorAccount: $ref: '#/definitions/_AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' example: "" creditorName: type: string description: Nombre del beneficiario example: Nombre creditorAccount: $ref: '#/definitions/_AccountReference' description: Cuenta del beneficiario creditorAgent: type: string description: BIC de la cuenta del beneficiario. example: XSXHXSMMXXX creditorAddress: $ref: '#/definitions/Address' description: Dirección del beneficiario remittanceInformationUnstructured: type: string description: Informacion adicional example: Informacion adicional chargeBearer: type: string description: 'Valores permitidos: • DEBT • CRED • SHAR • SLEV' example: SLEV requestedExecutionDate: type: string description: 'Fecha de ejecución solicitada para pagos futuros. Formato: ISODate' RequestInicioPagoConListadoCuentasDisponible: type: object properties: instructedAmount: $ref: '#/definitions/_Amount' description: Información de la transferencia realizada. creditorName: type: string description: Nombre del beneficiario example: Nombre creditorAccount: $ref: '#/definitions/_AccountReference' description: Cuenta del beneficiario creditorAgent: type: string description: BIC de la cuenta del beneficiario. example: XSXHXSMMXXX creditorAddress: $ref: '#/definitions/Address' description: Dirección del beneficiario remittanceInformationUnstructured: type: string description: Informacion adicional example: Informacion Adicional ListSinglePayment: type: array items: $ref: '#/definitions/SinglePayment' ListSinglePaymentBulk: type: array items: $ref: '#/definitions/SinglePaymentBulk' ListAccountReference: type: array items: $ref: '#/definitions/_AccountReference' ResponseInicioPago: properties: transactionStatus: type: string description: Estado de la transaccion example: RCVD paymentId: type: string description: Identificador del recurso que referencia a la iniciación de pago. example: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 transactionFees: description: Comisiones asociadas al pago. example: "" $ref: '#/definitions/_Amount' transactionFeeIndicator: type: boolean description: Si es igual a "true", la transacción implicará una comisión según el ASPSP o según lo acordado entre ASPSP y PSU. Si es igual a "false", la transacción no implicará ninguna comisión adicional para el PSU. example: "true" _links: description: 'Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta:' $ref: '#/definitions/LinksInicioPago' psuMessage: type: string example: Informacion para el PSU description: Texto a mostrar al PSU. tppMessages: $ref: '#/definitions/ListTppMessages' description: Mensaje para el TPP additionalProperties: false TppMessage: properties: category: type: string description: 'Categoría del tipo de mensaje recibido. Posibles valores: ERROR o WARNING' example: ERROR code: type: string description: Código de respuesta. example: CONSENT_INVALID path: type: string description: Path al campo referenciando el error. text: type: string description: Texto adicional explicativo. example: Ejemplo additionalProperties: false required: - code - category ListTppMessages: type: array items: $ref: '#/definitions/TppMessage' 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 self: $ref: '#/definitions/Link_self' description: Link al recurso creado por esta petición. status: $ref: '#/definitions/Link_status' description: Link para recuperar el estado de la transacción 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 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" $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) $ref: '#/definitions/Link_StartAuthorisation' additionalProperties: false SinglePaymentBulk: type: object properties: instructedAmount: $ref: '#/definitions/_Amount' description: Información de la transferencia realizada. creditorName: type: string description: Nombre del beneficiario example: Nombre creditorAccount: $ref: '#/definitions/_AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' creditorAgent: type: string description: BIC de la cuenta del beneficiario example: XXXLESMMXXX creditorAddress: $ref: '#/definitions/Address' description: Direccion Beneficiario remittanceInformationUnstructured: type: string description: Informacion Adicional example: Informacion adicional chargeBearer: type: string description: 'Valores permitidos: Valores permitidos: • DEBT • CRED • SHAR • SLEV' example: SLEV responseAccountsList: properties: psuMessage: type: string description: Mensaje PSU example: Mensaje PSU tppMessage: items: type: object properties: category: type: string code: type: string path: type: string text: type: string $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP accounts: items: type: object properties: id: type: string iban: type: string bban: type: string pan: type: string masked_pan: type: string msisdn: type: string currency: type: string name: type: string accountType: type: string cashAcountType: type: string bic: type: string balances: type: array items: type: object properties: closingBooked: type: object $ref: '#/definitions/closingBooked' expected: type: object $ref: '#/definitions/closingBooked' authorised: type: object $ref: '#/definitions/closingBooked' openingBooked: type: object $ref: '#/definitions/closingBooked' interimAvailable: type: object $ref: '#/definitions/closingBooked' responseAccountTransactions: type: object properties: booked: $ref: '#/definitions/_transactionsList' description: Últimas transacciones (anotaciones) conocidas de la cuenta. pending: $ref: '#/definitions/_transactionsList' description: Transacciones pendientes de la cuenta. _links: description: 'Los siguientes links se aceptan en este objeto: • viewAccount (OB) • first (OP) • next (OP)• previous (OP) • last (OP)' $ref: '#/definitions/_Links_Accounts_Transactions' responseAccountBalances: properties: psuMessage: type: string description: Texto a mostrar al PSU. tppMessage: items: type: object properties: category: type: string code: type: string path: type: string text: type: string description: Mensaje para el TPP. $ref: '#/definitions/_tppMessage' balances: properties: closingBooked: type: object properties: amount: type: object properties: currency: type: string content: type: string lastActionDateTime: type: string date: type: string expected: type: object $ref: '#/definitions/responseAccountBalances/properties/balances/properties/closingBooked' authorised: type: object $ref: '#/definitions/responseAccountBalances/properties/balances/properties/closingBooked' openingBooked: type: object $ref: '#/definitions/responseAccountBalances/properties/balances/properties/closingBooked' interimAvailable: type: object $ref: '#/definitions/responseAccountBalances/properties/balances/properties/closingBooked' description: Una lista de balances con respecto a una cuenta. $ref: '#/definitions/_balancesList' items: type: string required: - balances responseAccountDetail: properties: psuMessage: type: string description: Texto a mostrar al PSU example: Texto para mostrar tppMessage: items: type: object properties: category: type: string code: type: string path: type: string text: type: string $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP account: properties: id: type: string iban: type: string bban: type: string pan: type: string masked_pan: type: string msisdn: type: string currency: type: string name: type: string accountType: type: string cashAcountType: type: string bic: type: string balances: type: array items: type: object properties: closingBooked: type: object properties: amount: type: object properties: currency: type: string content: type: string lastActionDateTime: type: string date: type: string expected: type: object $ref: '#/definitions/responseAccountDetail/properties/account/properties/balances/items/properties/closingBooked' authorised: type: object $ref: '#/definitions/responseAccountDetail/properties/account/properties/balances/items/properties/closingBooked' openingBooked: type: object $ref: '#/definitions/responseAccountDetail/properties/account/properties/balances/items/properties/closingBooked' interimAvailable: type: object $ref: '#/definitions/responseAccountDetail/properties/account/properties/balances/items/properties/closingBooked' _links: type: object properties: redirect: type: string oAuth: type: string self: type: string status: type: string viewAccount: type: string viewBalances: type: string viewTransactions: type: string first: type: string next: type: string previous: type: string last: type: string download: type: string $ref: '#/definitions/_AccountDetails' description: Información detallada de la cuenta _AccountDetails: properties: resourceId: type: string example: 3dc3d5b3702348489853f5400a64e80f description: Identificador de la cuenta a ser usado en el PATH cuando se solicitan datos sobre una cuenta dedicada. iban: type: string example: ES1111111111111111111 description: IBAN de la cuenta bban: type: string description: BBAN de la cuenta, cuando esta no tiene IBAN. example: "20385778983000760236" msisdn: type: string description: Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado. example: "8198741987" currency: type: string description: Tipo de moneda example: EUR name: type: string description: Nombre dado por el banco o el PSU a la cuenta en la banca online. example: Nombre product: type: string description: Nombre del producto que da el ASPSP a esta cuenta. example: Main Account cashAccountType: type: string description: Especifica la naturaleza o el uso de la cuenta. example: BBAN status: type: string description: 'Estado de la cuenta. El valor es uno de los siguientes: enabled, deleted, blocked' example: enabled bic: type: string description: BIC de la cuenta. example: XSXHXSMMXXX usage: type: string description: 'Especifica el uso de la cuenta. Valores posibles: PRIV (cuenta personal privada), ORGA (cuenta profesional)' example: PRIV details: type: string description: Especificaciones que deben ser provistas por el ASPSP. Características de la cuenta, características de la tarjeta balances: description: Balances de la cuenta $ref: '#/definitions/_balancesList' _links: description: Enlaces a la cuenta para recuperar información de balances y/o transacciones de la cuenta. Links soportados solo cuando se ha dado el consentimiento correspondiente a la cuenta. $ref: '#/definitions/_Links_Accounts_Transactions' ownerName: type: string description: Nombre del propietario legal de la cuenta. Si hay más de un propietario, entonces en este campo deberán informarse los nombres. Para una cuenta corporativa, el nombre corporativo se usará en este campo. example: Nombre del propietario additionalProperties: false _Balances: properties: balanceAmount: $ref: '#/definitions/_Amount' description: Importe y moneda del balance balanceType: description: Transacciones compuestas por las entradas anotadas y las entradas pendientes en el momento de la petición. $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. $ref: '#/definitions/_SingleBalance' type: boolean example: "true" lastChangeDateTime: description: Fecha de la última acción realizada sobre la cuenta. $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. $ref: '#/definitions/_SingleBalance' referenceDate: type: string description: Fecha de referencia del balance 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. example: 1234-asd-567 additionalProperties: false _SingleBalance: properties: amount: description: Cantidad contenida en la cuenta. $ref: '#/definitions/_Amount' lastActionDateTime: type: string example: "2017-10-23" description: Fecha de la última anotación encontrada en la cuenta. date: type: string description: Fecha Actual example: "2017-10-23" additionalProperties: false 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. example: '"download/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. 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. 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. 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. example: /aspsp-name/v1/accounts/qwer3456tzui7890/transactions?page[number]=10&page[size]=15 additionalProperties: false _AccountReport: type: object properties: booked: $ref: '#/definitions/_Amount' description: Últimas transacciones (anotaciones) conocidas de la cuenta. pending: $ref: '#/definitions/_AccountReference' description: Transacciones pendientes de la cuenta. _links: description: Cuenta del beneficiario example: "" $ref: '#/definitions/_AccountReference' _Amount: type: object properties: currency: type: string example: EUR content: type: string example: "150.03" _tppMessage: properties: category: type: string example: OK code: type: string example: ACCESS_OK text: type: string example: Acceso OK path: type: string example: /example/path additionalProperties: false _Transactions: properties: transactionId: type: string description: Identificador de la transacción. endToEndId: type: string description: Identificador único end to end entryReference: type: string description: Identificación de la transacción que puede ser usada, por ejemplo, en las consultas delta. mandateId: type: string description: Identificación del mandato. Por ejemplo, un ID de un mandato SEPA. example: e733223hge7 checkId: type: string description: Identificador de un cheque creditorId: type: string description: Identificación del beneficiario. Por ejemplo, un ID de beneficiario SEPA. example: e7363987hge7 bookingDate: type: string description: Fecha de anotación de la transacción example: "2017-10-23" valueDate: type: string description: Fecha valor de la transacción example: "2017-10-23" transactionAmount: $ref: '#/definitions/_Amount' description: Cantidad de la transaccion currencyExchange: $ref: '#/definitions/_CurrencyExchange' description: Tasa de intercambio creditorName: type: string description: Nombre del beneficiario si la transacción es un cargo. example: NombreEjemplo creditorAccount: description: Cuenta del beneficiario. $ref: '#/definitions/_AccountReference' ultimateCreditor: type: string description: Beneficiario final. debtorName: type: string description: Nombre del ordenante example: NombreEjemplo debtorAccount: description: Cuenta del ordenante. $ref: '#/definitions/_AccountReference' ultimateDebtor: type: string description: Nombre ordenante final. example: NombreEjemplo remittanceInformationUnstructured: type: string description: Campo para incluir información adicional del envío. example: Informacion adicional remittanceInformationStructured: type: string description: Campo para incluir una referencia example: 1234-asdf-456 bankTransactionCode: type: string description: Codigo de la transaccion bancaria como es usado por los ASPSP additionalProperties: false _transactionsList: type: array items: $ref: '#/definitions/_Transactions' _balancesList: type: array items: $ref: '#/definitions/_Balances' _CurrencyExchange: properties: currencyFrom: type: string description: Moneda Origen 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.' example: "0.8" currencyTo: type: string description: Moneda Destino example: EUR rateDate: type: string description: Fecha de la tarifa. Formato ISODateTime rateContract: type: string description: Referencia al contrato de la tarifa additionalProperties: false required: - currencyFrom - rate - currencyTo - rateDate _AccountReference: type: object properties: iban: type: string example: ES1111111111111111111111 description: IBAN de la cuenta bban: type: string description: BBAN de la cuenta, cuando esta no tiene 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. 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. example: "195198741874" currency: type: string description: Tipo de moneda. 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 example: 1111-1111-1111-1111 account: properties: iban: type: string bban: type: string pan: type: string masked_pan: type: string msisdn: type: string currency: type: string $ref: '#/definitions/_AccountReference' description: Número de cuenta del PSU. payee: type: string description: Comercio donde la tarjeta es aceptada como información para el PSU. example: Comercio instructedAmount: properties: currency: type: string content: type: string description: Contiene la cantidad y moneda a consultar. $ref: '#/definitions/_Amount' required: - account - instructedAmount fundsConfirmationResponse: type: object properties: 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. ResponseAutorizacionInicioPago: properties: scaStatus: type: string description: Estado SCA authorisationId: type: string description: Identificador del recurso que referencia al sub-recurso de autorización creado 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' $ref: '#/definitions/ListAuthenticationObject' _links: description: 'Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta: scaRedirect: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el TPP. selectAuthenticatio nMethod: link al sub-recurso de autorización o de autorización de cancelación donde el método SCA seleccionado será informado. • scaStatus: link para consultar el estado SCA correspondiente al sub-recurso de autorización.' $ref: '#/definitions/Links_AutorizacionInicioPago' psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. tppMessages: type: string description: Mensaje para el TPP enviado a través del HUB. additionalProperties: false required: - scaStatus - authorisationId - _links 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.' authenticationVersion: type: string description: Versión de la herramienta asociada al authenticationType. 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. additionalProperties: false ListAuthenticationObject: type: array items: $ref: '#/definitions/AuthenticationObject' RequestActualizarDatosPsu: properties: authenticationMethodId: type: string description: Identificador del método de autenticación additionalProperties: false ResponseAutorizarDatosPsu: properties: links: $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: type: string description: Estado SCA psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. additionalProperties: false Links_AutorizacionInicioPago: properties: scaRedirect: type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 selectAuthenticationMethod: type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 scaStatus: type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 Links_ActualizarDatosPSU: properties: scaRedirect: type: string description: en caso de SCA por redirección. Link donde el navegador del PSU debe ser redireccionado por el TPP. scaStatus: type: string 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 additionalProperties: false ResponseAuthorization: properties: authorisationIds: type: array items: type: string description: Array de authorisationIds. cancellationIds: 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: properties: scaRedirect: type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 selectAuthenticationMethod: type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 scaStatus: type: string example: /aspsp-name/v1/payments/sepa-credit-transfers/1234-qwer-5678 closingBooked: properties: amount: type: object properties: currency: type: string content: type: string lastActionDateTime: type: string date: type: string paths: /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 - bankia - 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: 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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizacionInicioPago' 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 - bankia - 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: 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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' /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 - bankia - 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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizacionInicioPago' tags: - Inicio del proceso de autorización 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 - bankia - 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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' /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 - bankia - 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. 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' tags: [] 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 - bankia - 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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' /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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAutorizacionInicioPago' 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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization' /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. 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. - 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 - 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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - in: body name: body required: true schema: $ref: '#/definitions/RequestInicioPago' responses: default: description: OK schema: $ref: '#/definitions/ResponseInicioPago' /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 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. - 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 - 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: 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' 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" 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==' - 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 ' - in: body name: body required: true schema: $ref: '#/definitions/RequestCrearBulk' responses: default: description: OK schema: $ref: '#/definitions/ResponseInicioPago' /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.' 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. - 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 - 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' 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" 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==' - 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 ' - in: body name: body required: true schema: $ref: '#/definitions/RequestCrearPeriodico' responses: default: description: OK schema: $ref: '#/definitions/ResponseInicioPago' /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 operationId: status parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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: 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. - 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: Accept in: header required: true type: string description: Formato soportado de la respuesta. - 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-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 ' - 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: GET. Ej: 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' - 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: 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 /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 operationId: statusBulk parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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: 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. - 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: Accept in: header required: true type: string description: Formato soportado de la respuesta. - 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-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 ' - 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: GET. Ej: 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' - 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: 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 /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 operationId: statusPeriodic parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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: 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. - 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: Accept in: header required: true type: string description: Formato soportado de la respuesta. - 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-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 ' - 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: GET. Ej: 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' - 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: 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 /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 operationId: getPaymentInfo parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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: 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. - 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: Accept in: header required: true type: string description: 'Formato soportado de la respuesta. ' - 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-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 ' - 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: GET. Ej: 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' - 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: 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 /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 operationId: getPaymentInfoBulk parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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: 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. - 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: Accept in: header required: true type: string description: 'Formato soportado de la respuesta. ' - 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-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 ' - 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: GET. Ej: 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' - 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: 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 /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 operationId: getPaymentInfoPeriodic parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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: 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. - 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: Accept in: header required: true type: string description: 'Formato soportado de la respuesta. ' - 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-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 ' - 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: GET. Ej: 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' - 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: 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 /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. operationId: deletePayment parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - name: payment-service in: path required: true type: string description: Producto de pago a usar. enum: - payments - bulk-payments - periodic-payments - 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: 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. - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' default: Bearer 6yBnsqnMQQ - name: PSU-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' - 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-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 ' - 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: GET, POST, PUT, PATCH, DELETE. Ej: 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' - 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: 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 /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. operationId: fundsConfirmation parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' - name: Signature in: header required: true type: string description: Firma de la peticion por el TPP. - name: TPP-Signature-Certificate in: header required: true type: string description: Certificado firmado - 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. - 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. - 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' description: OK examples: application/json: fundsAvailable: true schema: $ref: '#/definitions/fundsConfirmationResponse' /api-entrada-xs2a/services/{aspsp}/v1.1/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. operationId: getAccountListv11 parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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. - 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: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' - 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-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-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 ' - 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: GET, POST, PUT, PATCH, DELETE. Ej: 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' - 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: 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 ' default: TestTPPCertificate responses: default: description: OK examples: application/json: '{"accountList":[{"id":"3dc3d5b3-7023-4848-9853-f5400a64e80f","iban":"ES1111111111111111111111","currency":"EUR","accountType":"Main Account","cashAccountType":"Current account","_links":{"viewBalances":"/aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances","viewTransactions":"/aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"}},{"id":"3dc3d5b3-7023-4848-9853-f5400a64e81g","iban":"ES2222222222222222222222","currency":"USD","accountType":"US Dollar Account","cashAccountType":"Account","_links":{"viewBalances":"/aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"}}]}' schema: $ref: '#/definitions/responseAccountsList' /api-entrada-xs2a/services/{aspsp}/v1.1/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. operationId: getAccountIdv11 parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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. - 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: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' - 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-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-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 ' - 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: GET, POST, PUT, PATCH, DELETE. Ej: 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' - 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: 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 ' default: TestTPPCertificate responses: default: description: OK examples: application/json: account: id: 3dc3d5b3-7023-4848-9853-f5400a64e80f iban: ES1111111111111111111111 currency: EUR name: Account name accountType: Main Account cashAccountType: Current account _links: viewBalances: /aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances viewTransactions: /aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853--5400a64e80f/transactions schema: $ref: '#/definitions/responseAccountDetail' /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. operationId: accountsTrasactions parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - name: account-id in: path required: true type: string description: Id de la cuenta - name: dateFrom type: string required: false in: query description: Fecha de inicio de consulta. Es incluido si no es requerido un acceso delta. - 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' - 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 - name: bookingStatus type: string required: true in: query description: Estados de las transacciones devueltas. Los codigos de estado permitidos son “booked”, “pending” y “both”. Los obligatorios para los ASPSPs son “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. - 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. - 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: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' - 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-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-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 ' - 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: GET, POST, PUT, PATCH, DELETE. Ej: 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' - 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: 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 ' default: TestTPPCertificate responses: default: description: 200 OK schema: $ref: '#/definitions/responseAccountTransactions' /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. operationId: getAccountBalances parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - name: account-id in: path required: true type: string description: Id de la cuenta - 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: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' - 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-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-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 ' - 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: GET, POST, PUT, PATCH, DELETE. Ej: 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' - 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: 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 ' default: TestTPPCertificate responses: default: description: OK examples: application/json: balances: - closingBooked: amount: currency: EUR content: "500.00" date: "2017-10-25" expected: amount: currency: EUR content: "900.00" lastActionDateTime: "2017-10-25T15:30:35.035Z" schema: $ref: '#/definitions/responseAccountBalances' /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. operationId: getAccountList parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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. - 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: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' - 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-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-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 ' - 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: GET, POST, PUT, PATCH, DELETE. Ej: 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' - 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: 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 ' default: TestTPPCertificate responses: default: description: OK examples: application/json: '{"accountList":[{"id":"3dc3d5b3-7023-4848-9853-f5400a64e80f","iban":"ES1111111111111111111111","currency":"EUR","accountType":"Main Account","cashAccountType":"Current account","_links":{"viewBalances":"/aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances","viewTransactions":"/aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"}},{"id":"3dc3d5b3-7023-4848-9853-f5400a64e81g","iban":"ES2222222222222222222222","currency":"USD","accountType":"US Dollar Account","cashAccountType":"Account","_links":{"viewBalances":"/aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"}}]}' schema: $ref: '#/definitions/responseAccountsList' /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. operationId: getAccountId parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. - 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. - 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: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: 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' - 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-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-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 ' - 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: GET, POST, PUT, PATCH, DELETE. Ej: 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' - 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: 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 ' default: TestTPPCertificate responses: default: description: OK examples: application/json: account: id: 3dc3d5b3-7023-4848-9853-f5400a64e80f iban: ES1111111111111111111111 currency: EUR name: Account name accountType: Main Account cashAccountType: Current account _links: viewBalances: /aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances viewTransactions: /aspsp-name/v1/accounts/3dc3d5b3-7023-4848-9853--5400a64e80f/transactions schema: $ref: '#/definitions/responseAccountDetail' /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 - bankia - 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: 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. 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' tags: [] 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 - bankia - 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: 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. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: Respuesta a la operación schema: $ref: '#/definitions/ResponseAuthorization'