--- swagger: "2.0" info: description: API de Redsys para PSD2 version: 1.1.0 title: 'PIS: Servicio de iniciación de pago' x-ibm-name: api-110dc50c contact: name: Soporte PSD2 email: psd2.sandbox.soporte@redsys.es x-ibm-languages: title: en: HUB-PSD2 x-ibm-configuration: enforced: true testable: true phase: realized produces: - application/json consumes: - application/json schemes: - https securityDefinitions: RedsysClientSecret: type: apiKey description: Clave acceso consumidor APIS in: header name: X-IBM-Client-Secret RedsysClientId: type: apiKey description: Identificador consumidor APIS in: header name: X-IBM-Client-Id security: - RedsysClientId: [] basePath: / definitions: Address: type: object properties: streetName: type: string description: Calle x-ibm-languages: description: en: Street example: Ejemplo de Calle buildingNumber: type: string description: Numero x-ibm-languages: description: en: Number example: "5" townName: type: string description: Ciudad x-ibm-languages: description: en: City example: Cordoba postCode: type: string description: Codigo Postal x-ibm-languages: description: en: Postal Code example: "14100" country: type: string description: Pais x-ibm-languages: description: en: Country example: ES AuthenticationObject: properties: authenticationType: type: string authenticationVersion: type: string authenticationMethodId: type: string name: type: string explanation: type: string AccountReference: type: object properties: iban: properties: [] type: string example: ES2640000418401234567599 description: IBAN de la cuenta x-ibm-languages: description: en: Account IBAN bban: properties: [] type: string description: BBAN de la cuenta, cuando esta no tiene IBAN. x-ibm-languages: description: en: Account BBAN, when it does not have IBAN. example: "20385778983000760236" pan: properties: [] type: string description: Primary Account Number de la tarjeta. Puede ser tokenizada por el ASPSP para cumplir los requerimientos de PCI DSS. x-ibm-languages: description: en: Primary Account Number of the card. It can be tokenized by the ASPSP to meet the PCI DSS requirements. example: "1234567891234567" maskedPan: properties: [] type: string description: Primary Account Number de la tarjeta en forma enmascarda. x-ibm-languages: description: en: Primary Account Number of the card in masked form. example: 123456******4567 msisdn: properties: [] type: string description: Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado. x-ibm-languages: description: en: Alias ​​to access a payment account through a registered mobile phone number. example: "27821234567" currency: properties: [] type: string example: EUR description: Moneda x-ibm-languages: description: en: Currency Amount: type: object properties: currency: type: string description: Moneda del importe x-ibm-languages: description: en: Currency of the amount example: EUR amount: type: string description: Cantidad del importe x-ibm-languages: description: en: Amount of the amount example: "500.00" Href: properties: href: type: string description: Contiene un enlace a un recurso example: /v1.1/payments/sepa-credit-transfers/asd-1234-jkl Links: properties: scaRedirect: $ref: '#/definitions/Href' scaOAuth: $ref: '#/definitions/Href' startAuthorisation: $ref: '#/definitions/Href' startAuthorisationWithAuthenticationMethodSelection: $ref: '#/definitions/Href' selectAuthenticationMethod: $ref: '#/definitions/Href' self: $ref: '#/definitions/Href' status: $ref: '#/definitions/Href' scaStatus: $ref: '#/definitions/Href' account: $ref: '#/definitions/Href' balances: $ref: '#/definitions/Href' transactions: $ref: '#/definitions/Href' first: $ref: '#/definitions/Href' next: $ref: '#/definitions/Href' previous: $ref: '#/definitions/Href' last: $ref: '#/definitions/Href' download: $ref: '#/definitions/Href' List_Other: type: array items: $ref: '#/definitions/Other' List_AuthenticationObject: type: array items: $ref: '#/definitions/AuthenticationObject' List_SingleBulkPayment: type: array items: $ref: '#/definitions/SingleBulkPayment' List_TppMessage: type: array items: $ref: '#/definitions/TppMessage' OrganisationIdentification: type: object properties: others: $ref: '#/definitions/List_Other' description: Lista de "others" x-ibm-languages: description: en: List of "others" Other: type: object properties: identification: type: string description: Entrada proporcionada por una lista de códigos ISO externa x-ibm-languages: description: en: Input provided by an external ISO code list PartyIdentification: type: object properties: organisationId: $ref: '#/definitions/OrganisationIdentification' description: Entrada proporcionada por una lista de códigos ISO externa x-ibm-languages: description: en: Input provided by an external ISO code list Request_BulkPayment: type: object properties: batchBookingPreferred: type: boolean description: Si este elemento es true, el PSU prefiere solo una anotación. Si este elemento es igual a false, el PSU prefiere anotaciones individuales de todas las transacciones individuales contenidas. El ASPSP seguirá esta preferencia de acuerdo al contrato con el PSU. x-ibm-languages: description: en: 'If this element is true, the PSU prefers only one annotation. If this element is equal to false, the PSU prefers individual annotations of all the individual transactions contained. The ASPSP will follow this preference according to the contract with the PSU. ' example: "true" requestedExecutionDate: type: string description: Si es contenido, los pagos contenidos en el lote serán ejecutados en la fecha indicada. Este campo podría no ser usado junto con el campo requestedExecutionTime x-ibm-languages: description: en: If it is content, the payments contained in the lot will be executed on the indicated date. This field may not be used together with the requestedExecutionTime field requestedExecutionTime: type: string description: Si es contenido, los pagos contenidos en el lote serán ejecutados en la fecha/hora indicada. Este campo podría no ser usado junto con el campo requestedExecutionDate x-ibm-languages: description: en: If it is content, the payments contained in the lot will be executed on the date / time indicated. This field may not be used together with the requestedExecutionDate field debtorAccount: $ref: '#/definitions/AccountReference' description: Cuenta del ordenante. x-ibm-languages: description: en: Account of the payer. payments: items: $ref: '#/definitions/SingleBulkPayment' description: 'Este elemento es un array de inicios de pago en notación JSON para los productos de pago soportados. Excluyendo los datos: • debtorAccount • requestedExecutionDate • requestedExecutionTime' x-ibm-languages: description: en: 'This element is an array of payment starts in JSON notation for supported payment products. Excluding data: • debtorAccount • requestedExecutionDate • requestedExecutionTime ' $ref: '#/definitions/List_SingleBulkPayment' debtorIdentification: $ref: '#/definitions/PartyIdentification' description: Identificación estructurada del debtor x-ibm-languages: description: en: Debtor structured identification Request_PeriodicPayment: allOf: - $ref: '#/definitions/SinglePayment' - properties: startDate: type: string description: El primer día aplicable de ejecución desde esta fecha es el primer pago x-ibm-languages: description: en: The first applicable day of execution from this date is the first payment executionRule: type: string description: Define el comportamiento cuando las fechas del pago recurrente caen en fin de semana o festivo. Entonces el pago se ejecuta el día laboral anterior o posterior x-ibm-languages: description: en: Define the behavior when recurring payment dates fall on weekends or holidays. Then the payment is executed the previous or subsequent business day endDate: type: string description: El último día aplicable de ejecución. Si no viene se trata de una orden permanente sin fin. x-ibm-languages: description: en: The last applicable day of execution. If it does not come, it is an endless permanent order. frequency: type: string description: La frecuencia del pago recurrente resultante de esta orden permanente x-ibm-languages: description: en: The frequency of recurring payment resulting from this permanent order dayOfExecution: type: string description: La fecha se refiere a la zona horaria del ASPSP x-ibm-languages: description: en: The date refers to the time zone of the ASPSP Response_PaymentInitiation: properties: transactionStatus: type: string description: Estado de la transaccion x-ibm-languages: description: en: Transaction Status example: RCVD paymentId: properties: [] type: string description: Identificador del recurso que referencia a la iniciación de pago. x-ibm-languages: description: en: Identifier of the resource that refers to the initiation of payment. example: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 transactionFees: properties: [] description: Comisiones asociadas al pago. x-ibm-languages: description: en: Fees associated with payment. example: "" $ref: '#/definitions/Amount' transactionFeeIndicator: properties: [] type: boolean description: Si es igual a "true", la transacción implicará una comisión según el ASPSP o según lo acordado entre ASPSP y PSU. Si es igual a "false", la transacción no implicará ninguna comisión adicional para el PSU. x-ibm-languages: description: en: 'If it is equal to "true", the transaction will involve a commission according to the ASPSP or as agreed between ASPSP and PSU. If it is equal to "false", the transaction will not imply any additional commission for the PSU. ' example: '"transactionFeeIndicator": true' scaMethods: $ref: '#/definitions/List_AuthenticationObject' description: Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. x-ibm-languages: description: en: This element is content if SCA is required and if the PSU can choose between different authentication methods. _links: properties: [] description: 'Lista de hipervínculos para ser reconocidos por el TPP. Tipos soportados en esta respuesta:' x-ibm-languages: description: en: 'List of hyperlinks to be recognized by the TPP. Types supported in this answer: ' $ref: '#/definitions/Links' psuMessage: properties: [] type: string example: Informacion para el PSU description: Texto a mostrar al PSU. x-ibm-languages: description: en: Text to display to the PSU. tppMessages: properties: [] $ref: '#/definitions/List_TppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP additionalProperties: false Response_GetStatusPayment: type: object properties: transactionStatus: type: string description: Estado de la transacción de pago. Valores definidos en 9.4 Estados de transacción fundsAvailable: type: boolean description: Este dato es contenido si es soportado por el ASPSP, si una confirmación de fondos ha sido realizada y si el “transactionStatus” es ATCT, ACWC, ACCP psuMessage: type: string description: Texto a mostrar al PSU. tppMessages: $ref: '#/definitions/List_TppMessage' description: Mensaje para el TPP. required: - transactionStatus Response_GetInfoPayment: allOf: - $ref: '#/definitions/SinglePayment' - properties: transactionStatus: type: string description: Estado de la transacción. Valores definidos en anexos. Código corto. psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. tppMessages: $ref: '#/definitions/List_TppMessage' description: Mensaje para el TPP enviado a través del HUB. required: - debtorAccount - transactionStatus - instructedAmount - creditorAccount - creditorName Response_CancelPaymentInitiation: properties: transactionStatus: type: string description: Estado de la transacción. scaMethods: $ref: '#/definitions/List_AuthenticationObject' description: 'Este elemento es contenido si SCA es requerido y si el PSU puede elegir entre diferentes métodos de autenticación. ' _links: $ref: '#/definitions/Links' description: 'Lista de hipervínculos para ser reconocidos por el TPP. Dependen de la decisión que tome el ASPSP dinámicamente al evaluar la operación. ' psuMessage: type: string description: Texto enviado al TPP a través del HUB para ser mostrado al PSU. tppMessages: $ref: '#/definitions/List_TppMessage' description: Mensaje para el TPP enviado a través del HUB. required: - transactionStatus SinglePayment: type: object properties: instructedAmount: $ref: '#/definitions/Amount' description: Información de la transferencia realizada. x-ibm-languages: description: en: Transfer information made. creditorName: type: string description: Nombre del beneficiario x-ibm-languages: description: en: Beneficiary Name example: Nombre creditorAccount: $ref: '#/definitions/AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' x-ibm-languages: description: en: 'Account of the payer. Note: this field may be optional in some services such as bulk payments.' creditorAgent: type: string description: BIC de la cuenta del beneficiario x-ibm-languages: description: en: BIC of the beneficiary's account example: XXXLESMMXXX creditorAddress: $ref: '#/definitions/Address' description: Direccion Beneficiario x-ibm-languages: description: en: Beneficiary Address remittanceInformationUnstructured: type: string description: Informacion Adicional x-ibm-languages: description: en: Additional Information example: Informacion adicional chargeBearer: type: string description: 'Valores permitidos: Valores permitidos: • DEBT • CRED • SHAR • SLEV' x-ibm-languages: description: en: 'Allowed values: Allowed values: • DEBT • CRED • SHAR • SLEV' example: SLEV debtorAccount: properties: [] $ref: '#/definitions/AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' x-ibm-languages: description: en: 'Account of the payer. Note: this field may be optional in some services such as bulk payments.' purposeCode: type: string description: Lista de códigos ISO x-ibm-languages: description: en: List of ISO codes debtorName: type: string description: Nombre del ordenante x-ibm-languages: description: en: Name of payer requestedExecutionDate: type: string description: Fecha de ejecución x-ibm-languages: description: en: Date of execution requestedExecutionTime: type: string description: Fecha/hora de ejecución x-ibm-languages: description: en: Date/time of execution SingleBulkPayment: type: object properties: instructedAmount: $ref: '#/definitions/Amount' description: Información de la transferencia realizada. x-ibm-languages: description: en: Transfer information made. creditorName: type: string description: Nombre del beneficiario x-ibm-languages: description: en: Beneficiary Name example: Nombre creditorAccount: $ref: '#/definitions/AccountReference' description: 'Cuenta del ordenante. Nota: este campo puede ser opcional en algunos servicios como pagos bulk' x-ibm-languages: description: en: 'Account of the payer. Note: this field may be optional in some services such as bulk payments.' creditorAgent: type: string description: BIC de la cuenta del beneficiario x-ibm-languages: description: en: BIC of the beneficiary's account example: XXXLESMMXXX creditorAddress: $ref: '#/definitions/Address' description: Direccion Beneficiario x-ibm-languages: description: en: Beneficiary Address remittanceInformationUnstructured: type: string description: Informacion Adicional x-ibm-languages: description: en: Additional Information example: Informacion adicional endToEndIdentification: type: string description: Identificador único de la operación asignado por la parte iniciadora (TPP) chargeBearer: type: string description: 'Valores permitidos: Valores permitidos: • DEBT • CRED • SHAR • SLEV' x-ibm-languages: description: en: 'Allowed values: Allowed values: • DEBT • CRED • SHAR • SLEV' example: SLEV TppMessage: properties: category: type: string description: 'Categoría del tipo de mensaje recibido. Posibles valores: ERROR o WARNING' x-ibm-languages: description: en: 'Category of the type of message received. Possible values: ERROR or WARNING ' example: ERROR code: properties: [] type: string description: Código de respuesta. x-ibm-languages: description: en: Response code. example: CONSENT_INVALID path: properties: [] type: string description: Path al campo referenciando el error. x-ibm-languages: description: en: Path to the field referencing the error. text: properties: [] type: string description: Texto adicional explicativo. x-ibm-languages: description: en: Additional explanatory text. example: Ejemplo additionalProperties: false required: - code - category paths: /api-entrada-xs2a/services/{aspsp}/v1.1/payments/{payment-product}: post: summary: Inicio de pago Simple o pago Futuro description: Mensaje enviado por el TPP al ASPSP a través del HUB para crear un inicio de pago Simple. x-ibm-languages: summary: en: Simple payment start description: en: Message sent by the TPP to the ASPSP through the HUB to create a Single payment initiation. operationId: initiationPayment consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: Content-Type in: header required: true type: string description: application/json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' x-ibm-languages: description: en: 'This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456 ' - name: PSU-ID in: header required: false type: string description: Identificador que el PSU utiliza para identificarse en su ASPSP. Puede ser informado incluso si se está usando un token de OAuth y, en tal caso, el ASPSP podría comprobar que el PSU-ID y el token se corresponden. x-ibm-languages: description: en: Identifier that the PSU uses to identify itself to its ASPSP. It can be reported even if an OAuth token is being used and, in such a case, the ASPSP could check that the PSU-ID and token match. - name: PSU-ID-Type in: header required: false type: string description: Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. x-ibm-languages: description: en: PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. - name: PSU-Corporate-ID in: header required: false type: string description: Identificador de "empresa" en los Canales Online. x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header required: false type: string description: Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. x-ibm-languages: description: en: Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' x-ibm-languages: description: en: 'Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: TPP-Redirect-Preferred in: header required: false type: boolean description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. x-ibm-languages: description: en: 'If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. ' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' x-ibm-languages: description: en: 'TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb ' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" x-ibm-languages: description: en: 'If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" ' - name: TPP-Explicit-Authorisation-Preferred in: header required: false type: boolean description: Si es igual a true, el TPP prefiere iniciar el proceso de autorización separadamente, por ej. debido a la necesidad de la autorización de un conjunto de operaciones simultáneamente. x-ibm-languages: description: en: If equal to true, the TPP prefers to initiate the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. - name: TPP-Brand-Logging-Information in: header required: false type: string description: Este campo podría ser usado por el TPP para informar al ASPSP acerca de la marca (Brand) usada por el TPP de cara al PSU. Esta información puede ser usada para mejorar la comunicación entre el ASPSP y el PSU o el ASPSP y el TPP. x-ibm-languages: description: en: This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. - name: TPP-Rejection-NoFunds-Preferred in: header required: false type: string description: 'Nota: Este campo será ignorado en caso de venir informado por el TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-URI in: header required: false type: string description: 'Nota: Este campo será ignorado en caso de venir informado por el TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-Content-Preferred in: header required: false type: string description: 'Nota: Este campo será ignorado en caso de venir informado por el TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - in: body name: body required: true schema: $ref: '#/definitions/SinglePayment' responses: default: description: HTTP/1.1 201 Created headers: Location: type: string description: Contiene el link al recurso generado. X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_PaymentInitiation' examples: application/json: transactionStatus: RCVD paymentId: 123-qwe-456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' self: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456 status: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/status scaStatus: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/authorisations/123auth456 tags: - Inicio de pago /api-entrada-xs2a/services/{aspsp}/v1.1/bulk-payments/{payment-product}: post: summary: Inicio de pago Bulk description: Este mensaje es enviado por el TPP hacia el HUB para la realización de inicio de pago bulk x-ibm-languages: summary: en: Bulk payment start description: en: This message is sent by the TPP to the HUB for the realization of bulk payment initiation operationId: initiationBulkPayment consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: Content-Type in: header required: true type: string description: application/json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' x-ibm-languages: description: en: 'This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456 ' - name: PSU-ID in: header required: false type: string description: Identificador que el PSU utiliza para identificarse en su ASPSP. Puede ser informado incluso si se está usando un token de OAuth y, en tal caso, el ASPSP podría comprobar que el PSU-ID y el token se corresponden. x-ibm-languages: description: en: Identifier that the PSU uses to identify itself to its ASPSP. It can be reported even if an OAuth token is being used and, in such a case, the ASPSP could check that the PSU-ID and token match. - name: PSU-ID-Type in: header required: false type: string description: Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. x-ibm-languages: description: en: PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. - name: PSU-Corporate-ID in: header required: false type: string description: Identificador de "empresa" en los Canales Online. x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header required: false type: string description: Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. x-ibm-languages: description: en: Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' x-ibm-languages: description: en: 'Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: TPP-Redirect-Preferred in: header required: false type: boolean description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. x-ibm-languages: description: en: 'If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. ' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' x-ibm-languages: description: en: 'TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb ' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" x-ibm-languages: description: en: 'If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" ' - name: TPP-Explicit-Authorisation-Preferred in: header required: false type: boolean description: Si es igual a true, el TPP prefiere iniciar el proceso de autorización separadamente, por ej. debido a la necesidad de la autorización de un conjunto de operaciones simultáneamente. x-ibm-languages: description: en: If equal to true, the TPP prefers to initiate the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. - name: TPP-Brand-Logging-Information in: header required: false type: string description: Este campo podría ser usado por el TPP para informar al ASPSP acerca de la marca (Brand) usada por el TPP de cara al PSU. Esta información puede ser usada para mejorar la comunicación entre el ASPSP y el PSU o el ASPSP y el TPP. x-ibm-languages: description: en: This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. - name: TPP-Rejection-NoFunds-Preferred in: header required: false type: string description: 'Nota: Este campo será ignorado en caso de venir informado por el TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-URI in: header required: false type: string description: 'Nota: Este campo será ignorado en caso de venir informado por el TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-Content-Preferred in: header required: false type: string description: 'Nota: Este campo será ignorado en caso de venir informado por el TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - in: body name: body required: true schema: $ref: '#/definitions/Request_BulkPayment' responses: default: description: HTTP/1.1 201 Created headers: Location: type: string description: Contiene el link al recurso generado. X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_PaymentInitiation' examples: application/json: transactionStatus: RCVD paymentId: 123-qwe-456 _links: scaRedirect: href: 'https://hub.example.es/authorize ' self: href: /v1.1/bulk-payments/sepa-credit-transfers/123-qwe-456 status: href: /v1.1/bulk-payments/sepa-credit-transfers/123-qwe-456/status scaStatus: href: /v1.1/bulk-payments/sepa-credit-transfers/123-qwe-456/authorisations/123auth456 tags: - Inicio de pago /api-entrada-xs2a/services/{aspsp}/v1.1/periodic-payments/{payment-product}: post: summary: Inicio de pago Recurrente/Periódico description: 'Mensaje enviado por el TPP al ASPSP a través del Hub para crear un inicio de pago recurrente/periódico. La funcionalidad de inicios de pagos recurrentes es cubierta por la especificación de Berlin Group como la iniciación de una orden específica permanente. Un TPP puede enviar un inicio de pago recurrente donde se proporciona la fecha de inicio, frecuencia y, condicionalmnete, fecha fin. Una vez autorizado por el PSU, el pago será ejecutado por el ASPSP, si es posible, siguiendo la “orden permanente” como fue enviada por el TPP. No se necesitan acciones adicionales por parte del TPP. En este contexto, este pago es considerado un pago periódico para diferenciar el pago de otros tipos de pagos recurrentes donde terceras partes están iniciando la misma cantidad de dinero. Nota: para las órdenes permanentes de inicios de pago, el ASPSP siempre pedirá SCA con Dynamic linking. No se permiten exenciones.' x-ibm-languages: summary: en: Recurring/Periodic Payment Initiation description: en: 'Message sent by the TPP to the ASPSP through the Hub to create a recurring / periodic payment start. The recurring payment initiation functionality is covered by the Berlin Group specification as the initiation of a specific permanent order. A TPP can send a recurring payment start where the start date, frequency and, conditionally, end date are provided. Once authorized by the PSU, the payment will be executed by the ASPSP, if possible, following the “permanent order” as sent by the TPP. No additional actions are required by the TPP. In this context, this payment is considered a periodic payment to differentiate payment from other types of recurring payments where third parties are initiating the same amount of money. Note: for permanent orders for payment initiation, the ASPSP will always request SCA with Dynamic linking. Exemptions are not allowed. ' operationId: initiateRecurringPayment consumes: - application/json produces: - application/json parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-product in: path required: true type: string enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: Content-Type in: header required: true type: string description: application/json x-ibm-languages: description: en: application / json - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: false type: string description: 'Este dato es contenido si la transacción de inicio de pago forma parte de una sesión (combinación de AIS/PIS). Contendrá el consentId del consentimiento AIS que se realizó previo al inicio de pago. . Ej: Consent-ID: 123-qwer-456' x-ibm-languages: description: en: 'This data is contained if the payment initiation transaction is part of a session (AIS / PIS combination). It will contain the consent of the AIS consent that was made prior to the start of payment. . Ex: Consent-ID: 123-qwer-456 ' - name: PSU-ID in: header required: false type: string description: Identificador que el PSU utiliza para identificarse en su ASPSP. Puede ser informado incluso si se está usando un token de OAuth y, en tal caso, el ASPSP podría comprobar que el PSU-ID y el token se corresponden. x-ibm-languages: description: en: Identifier that the PSU uses to identify itself to its ASPSP. It can be reported even if an OAuth token is being used and, in such a case, the ASPSP could check that the PSU-ID and token match. - name: PSU-ID-Type in: header required: false type: string description: Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios PSU-IDs como posibilidades de acceso. x-ibm-languages: description: en: PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs as access possibilities. - name: PSU-Corporate-ID in: header required: false type: string description: Identificador de "empresa" en los Canales Online. x-ibm-languages: description: en: '"Company" identifier in the Online Channels.' - name: PSU-Corporate-ID-Type in: header required: false type: string description: Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar su contenido. x-ibm-languages: description: en: Type of PSU-Corporate-ID required by the ASPSP to identify its contents. - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' x-ibm-languages: description: en: 'Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: POST. Ej: PSU-Http-Method: POST ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: POST. Ex: PSU-Http-Method: POST ' default: POST - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: TPP-Redirect-Preferred in: header required: false type: boolean description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. x-ibm-languages: description: en: 'If it is "true", the TPP has informed the HUB that it prefers SCA by redirection. If it is "false", the TPP has informed the HUB that it prefers not to be redirected to SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to be applied depending on the SCA method chosen by the TPP / PSU. ' - name: TPP-Redirect-URI in: header required: false type: string description: 'URI del TPP donde el flujo de la transacción debe ser redirigido después de alguna de las fases del SCA. Es recomendado usar siempre este campo de cabecera.En el futuro, este campo podría cambiar a obligatorio. Ej: TPP-Redirect-URI: https://www.tpp.com/cb' x-ibm-languages: description: en: 'TPP URI where the transaction flow must be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. Ex: TPP-Redirect-URI: https://www.tpp.com/cb ' - name: TPP-Nok-Redirect-URI in: header required: false type: string description: Si esta URI es contenida, el TPP está solicitando redirigir el flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok" x-ibm-languages: description: en: 'If this URI is contained, the TPP is requesting to redirect the flow of the transaction to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI": "https://www.tpp.com/cb/nok" ' - name: TPP-Explicit-Authorisation-Preferred in: header required: false type: boolean description: Si es igual a true, el TPP prefiere iniciar el proceso de autorización separadamente, por ej. debido a la necesidad de la autorización de un conjunto de operaciones simultáneamente. x-ibm-languages: description: en: If equal to true, the TPP prefers to initiate the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. - name: TPP-Brand-Logging-Information in: header required: false type: string description: Este campo podría ser usado por el TPP para informar al ASPSP acerca de la marca (Brand) usada por el TPP de cara al PSU. Esta información puede ser usada para mejorar la comunicación entre el ASPSP y el PSU o el ASPSP y el TPP. x-ibm-languages: description: en: This field could be used by the TPP to inform the ASPSP about the Brand used by the TPP towards the PSU. This information can be used to improve communication between the ASPSP and the PSU or the ASPSP and the TPP. - name: TPP-Rejection-NoFunds-Preferred in: header required: false type: string description: 'Nota: Este campo será ignorado en caso de venir informado por el TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-URI in: header required: false type: string description: 'Nota: Este campo será ignorado en caso de venir informado por el TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: TPP-Notification-Content-Preferred in: header required: false type: string description: 'Nota: Este campo será ignorado en caso de venir informado por el TPP.' x-ibm-languages: description: en: 'Note: This field will be ignored if informed by the TPP.' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' - in: body name: body required: true schema: $ref: '#/definitions/Request_PeriodicPayment' responses: default: description: HTTP/1.1 201 Created headers: Location: type: string description: Contiene el link al recurso generado. X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. ASPSP-SCA-Approach: type: string description: Valor devuelto si el método SCA ha sido fijado. El SCA basado en OAuth será tomado como REDIRECT. enum: - EMBEDDED - DECOUPLED - REDIRECT schema: $ref: '#/definitions/Response_PaymentInitiation' tags: - Inicio de pago /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}/status: get: summary: Obtener información del Estado de pago description: Este mensaje es enviado por el TPP al HUB para solicitar información del estado en el que se encuentra la iniciación de pago que solicitó el TPP x-ibm-languages: summary: en: Obtain payment status information description: en: This message is sent by the TPP to the HUB to request information on the status of the payment initiation requested by the TPP operationId: statusPayment parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-service in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - payments - bulk-payments - periodic-payments - name: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago. Enviado previamente como respuesta a un mensaje de iniciación de pago del TPP al HUB. x-ibm-languages: description: en: Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB. - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Accept in: header required: true type: string description: Formato soportado de la respuesta. x-ibm-languages: description: en: Supported response format. - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Encoding: gzip' x-ibm-languages: description: en: 'Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Encoding: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET. Ej: PSU-Http-Method: GET ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: GET. Ex: PSU-Http-Method: GET ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. schema: $ref: '#/definitions/Response_GetStatusPayment' tags: - Obtener estado del pago /api-entrada-xs2a/services/{aspsp}/v1.1/{payment-service}/{payment-product}/{payment-id}: get: summary: Recuperar información del Inicio de pago description: Este mensaje es enviado por el TPP al HUB para solicitar información de un inicio de pago x-ibm-languages: summary: en: Retrieve payment Initiation information description: en: This message is sent by the TPP to the HUB to request information about a payment start operationId: getInfoPayment parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-service in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - payments - bulk-payments - periodic-payments - name: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago. Enviado previamente como respuesta a un mensaje de iniciación de pago del TPP al HUB. x-ibm-languages: description: en: Identifier of the resource that refers to the initiation of payment. Previously sent in response to a TPP payment initiation message to the HUB. - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Accept in: header required: true type: string description: 'Formato soportado de la respuesta. ' x-ibm-languages: description: en: 'Supported response format. ' - name: PSU-IP-Address in: header required: true type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Encoding: gzip' x-ibm-languages: description: en: 'Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Encoding: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET. Ej: PSU-Http-Method: GET ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: GET. Ex: PSU-Http-Method: GET ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 200 Ok headers: X-Request-ID: type: string description: Identificador único de la operación asignado por el TPP. schema: $ref: '#/definitions/Response_GetInfoPayment' tags: - Recuperar información del Inicio de pago delete: summary: Cancelar Inicio de pago description: Esta petición es enviada por el TPP al ASPSP a través del Hub y permite iniciar la cancelación de un pago. Dependiendo del servicio de pago, el producto de pago y la implementación del ASPSP, esta petición podríar ser suficiente para cancelar el pago o podría ser necesario una autorización. x-ibm-languages: summary: en: Cancel payment start description: en: 'This request is sent by the TPP to the ASPSP through the Hub and allows to initiate the cancellation of a payment. Depending on the payment service, the payment product and the implementation of the ASPSP, this request may be sufficient to cancel the payment or authorization may be necessary. ' operationId: deletePayment parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: payment-service in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - payments - bulk-payments - periodic-payments - name: payment-product in: path required: true type: string description: Producto de pago a usar. x-ibm-languages: description: en: Payment product to use. enum: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - name: payment-id in: path required: true type: string description: Identificador del recurso que referencia a la iniciación de pago.Enviado previamente como respuesta a un mensaje de iniciación de pago del HUB al ASPSP. x-ibm-languages: description: en: Identifier of the resource that refers to the payment initiation. Previously sent in response to a payment initiation message from the HUB to the ASPSP. - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: TPP-Redirect-Preferred in: header required: false type: boolean description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no ser redireccionado para SCA y el procedimiento será por flujo desacoplado. Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo del método SCA elegido por el TPP/PSU. EMBEBIDO NO SOPORTADO EN ESTA VERSIÓN x-ibm-languages: description: en: If "true", the TPP has communicated to the HUB that it prefers SCA by redirection. If "false", the TPP has communicated to the HUB that it prefers not to be redirected for SCA and the procedure will be by decoupled flow. If the parameter is not used, the ASPSP will choose the SCA flow to apply depending on the SCA method chosen by the TPP/PSU. EMBEDDED NOT SUPPORTED IN THIS VERSION - name: TPP-Redirect-URI in: header 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. x-ibm-languages: description: en: TPP URI where the transaction flow should be redirected after one of the SCA phases. It is recommended to always use this header field. In the future, this field may change to mandatory. - name: TPP-Nok-Redirect-URI in: header 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. x-ibm-languages: description: en: If this URI is contained, the TPP is requesting to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the SCA method by redirection. - name: TPP-Explicit-Authorisation-Preferred in: header required: false type: boolean description: 'Si es igual a true, el TPP prefiere iniciar el proceso de autorización separadamente, por ej. debido a la necesidad de la autorización de un conjunto de operaciones simultáneamente. Si es false o el parámetro no es usado, no hay preferencia del TPP. El TPP asume una autorización directa de la transacción en el siguiente paso. Nota: el ASPSP podría no tenerlo en cuenta si no lo soporta.' x-ibm-languages: description: en: 'If true, the TPP prefers to start the authorization process separately, e.g. due to the need for authorization of a set of operations simultaneously. If false or the parameter is not used, there is no TPP preference. The TPP assumes a direct authorization of the transaction in the next step. Note: ASPSP may not take this into account if it does not support it.' - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept encoding header de la petición HTTP entre PSU y el TPP. PSU-Accept-Encoding: gzip' x-ibm-languages: description: en: 'Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Encoding: gzip ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET ' default: DELETE - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' responses: default: description: HTTP/1.1 202 Ok headers: X-Request-ID: type: string description: Identificador único de la petición asignado por el TPP. schema: $ref: '#/definitions/Response_CancelPaymentInitiation' examples: application/json: transactionStatus: ACTC _links: self: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456 status: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/status startAuthorisation: href: /v1.1/payments/sepa-credit-transfers/123-qwe-456/cancellation-authorisations tags: - Cancelar Inicio de pago x-ibm-endpoints: - endpointUrl: https://apis-i.redsys.es:20443/psd2/xs2a description: Endpoint entorno Integracion type: - production - development ...