--- swagger: "2.0" info: description: API de Redsys para PSD2 version: 1.0.0 title: Lectura de información de cuentas x-ibm-name: api-dc53c contact: name: Soporte PSD2 email: psd2.sandbox.soporte@redsys.es x-ibm-languages: title: en: Accounts-AIS-PSD2 tags: - name: PSD2 description: Endpoints disponibles para el hub PSD2 definitions: responseAccountsList: properties: psuMessage: type: string description: Mensaje PSU x-ibm-languages: description: en: PSU message example: Mensaje PSU tppMessage: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP accounts: $ref: '#/definitions/_accountList' description: Listado de cuentas disponibles. x-ibm-languages: description: en: List of available accounts. responseAccountTransactions: type: object properties: psuMessage: type: string description: Mensaje PSU x-ibm-languages: description: en: PSU message example: Mensaje PSU tppMessage: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP account: $ref: '#/definitions/_AccountReference' description: Identificador de la cuenta que se está consultando. x-ibm-languages: description: en: Identifier of the account being consulted. transactions: $ref: '#/definitions/_AccountReport' description: Devolución de los datos en formato JSON, cuando los datos devueltos tienen un tamaño pequeño. x-ibm-languages: description: en: Return of data in JSON format, when the returned data has a small size. balances: $ref: '#/definitions/_balancesList' description: Una lista de balances con respecto a una cuenta. x-ibm-languages: description: en: A list of balances regarding an account. _links: $ref: '#/definitions/_Links_Accounts_Transactions' responseAccountBalances: properties: psuMessage: type: string description: Mensaje PSU x-ibm-languages: description: en: PSU message example: Mensaje PSU tppMessage: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP balances: description: Balances de la cuenta x-ibm-languages: description: en: Account balances $ref: '#/definitions/_balancesList' account: $ref: '#/definitions/_AccountReference' description: Identificador de la cuenta que se está consultando. x-ibm-languages: description: en: Identifier of the account being consulted. required: - balances responseAccountDetail: properties: psuMessage: type: string description: Texto a mostrar al PSU x-ibm-languages: description: en: Text to display to the PSU example: Texto para mostrar tppMessage: $ref: '#/definitions/_tppMessage' description: Mensaje para el TPP x-ibm-languages: description: en: Message for the TPP account: $ref: '#/definitions/_AccountDetails' description: Información detallada de la cuenta x-ibm-languages: description: en: Detailed account information _access: properties: accounts: items: type: string $ref: '#/definitions/_accountList' additionalProperties: false _accountList: type: array items: $ref: '#/definitions/_AccountDetails' _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. x-ibm-languages: description: en: Identifier of the account to be used in the PATH when data is requested on a dedicated account. iban: type: string example: ES1111111111111111111 description: IBAN de la cuenta x-ibm-languages: description: en: Account IBAN bban: type: string description: BBAN de la cuenta, cuando esta no tiene IBAN. x-ibm-languages: description: en: Account BBAN, when it does not have IBAN. example: "20385778983000760236" msisdn: type: string description: Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado. x-ibm-languages: description: en: Alias ​​to access a payment account through a registered mobile phone number. example: "8198741987" currency: type: string description: Tipo de moneda x-ibm-languages: description: en: Currency type example: EUR name: type: string description: Nombre dado por el banco o el PSU a la cuenta en la banca online. x-ibm-languages: description: en: Name given by the bank or PSU to the account in online banking. example: Nombre product: type: string description: Nombre del producto que da el ASPSP a esta cuenta. x-ibm-languages: description: en: Name of the product that the ASPSP gives to this account. example: Main Account cashAccountType: type: string description: Especifica la naturaleza o el uso de la cuenta. x-ibm-languages: description: en: Specify the nature or use of the account. example: BBAN status: type: string description: 'Estado de la cuenta. El valor es uno de los siguientes: enabled, deleted, blocked' x-ibm-languages: description: en: 'Account status. The value is one of the following: enabled, deleted, blocked ' example: enabled bic: type: string description: BIC de la cuenta. x-ibm-languages: description: en: BIC of the account. example: XSXHXSMMXXX usage: type: string description: 'Especifica el uso de la cuenta. Valores posibles: PRIV (cuenta personal privada), ORGA (cuenta profesional)' x-ibm-languages: description: en: 'Specify the use of the account. Possible values: PRIV (private personal account), ORGA (professional account) ' example: PRIV details: type: string description: Especificaciones que deben ser provistas por el ASPSP. Características de la cuenta, características de la tarjeta x-ibm-languages: description: en: Specifications that must be provided by the ASPSP. Account features, card features balances: description: Balances de la cuenta x-ibm-languages: description: en: Account balances $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. x-ibm-languages: description: en: Links to the account to retrieve balance information and / or account transactions. Supported links only when the corresponding consent has been given to the account. $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. x-ibm-languages: description: en: 'Name of the legal owner of the account. If there is more than one owner, then in this field the names must be informed. For a corporate account, the corporate name will be used in this field. ' example: Nombre del propietario additionalProperties: false _Balances: properties: balanceAmount: $ref: '#/definitions/_Amount' description: Importe y moneda del balance x-ibm-languages: description: en: Balance amount and currency balanceType: description: Transacciones compuestas por las entradas anotadas y las entradas pendientes en el momento de la petición. x-ibm-languages: description: en: Transactions composed of the entries entered and the pending entries at the time of the request. $ref: '#/definitions/_SingleBalance' type: string example: closingBooked creditLimitIncluded: description: Flag indicando si el límite de crédito de la cuenta correspondiente está incluido en el cálculo del balance, cuando aplicque. x-ibm-languages: description: en: Flag indicating if the credit limit of the corresponding account is included in the balance calculation, when applicable. $ref: '#/definitions/_SingleBalance' type: boolean example: "true" lastChangeDateTime: description: Fecha de la última acción realizada sobre la cuenta. x-ibm-languages: description: en: Date of the last action performed on the account. $ref: '#/definitions/_SingleBalance' type: string example: "2017-10-25T15:30:35.035Z" interimAvailable: description: Balance disponible provisionalmente. Calculado en base a las anotaciones de ítems de crédito y débito durante el periodo de tiempo especificado. x-ibm-languages: description: en: Balance available provisionally. Calculated based on annotations of credit and debit items during the specified period of time. $ref: '#/definitions/_SingleBalance' referenceDate: type: string description: Fecha de referencia del balance x-ibm-languages: description: en: Balance sheet reference date example: "2017-10-25" lastCommittedTransaction: type: string description: entryReference de la última transacción para ayudar al TPP a identificar si ya se conocen todas las transacciones del PSU. x-ibm-languages: description: en: entryReference of the last transaction to help the TPP identify if all transactions of the PSU are already known. example: 1234-asd-567 additionalProperties: false _SingleBalance: properties: amount: description: Cantidad contenida en la cuenta. x-ibm-languages: description: en: Amount contained in the account. $ref: '#/definitions/_Amount' lastActionDateTime: type: string example: "2017-10-23" description: Fecha de la última anotación encontrada en la cuenta. x-ibm-languages: description: en: Date of the last entry found in the account. date: type: string description: Fecha Actual x-ibm-languages: description: en: Current Date example: "2017-10-23" additionalProperties: 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. x-ibm-languages: description: en: 'Download link of the data of the query made, when the returned data is large. Only for camt-data. ' example: '"download/path/example"' account: type: string example: '"account/path/example"' first: type: string description: Enlace usado en la navegación para paginación. Devuelve la primera página de la paginación de las transacciones. x-ibm-languages: description: en: Link used in paging navigation. Returns the first page of the pagination of the transactions. example: /aspsp-name/v1/accounts/qwer3456tzui7890/transactions?page[number]=1&page[size]=15 next: type: string description: Enlace usado en la navegación por paginación. Devuelve la siguiente página a la actual en la paginación de las transacciones. x-ibm-languages: description: en: Link used in paging navigation. Returns the next page to the current page in the pagination of the transactions. example: aspsp-name/v1/accounts/qwer3456tzui7890/transactions?page[number]=2&page[size]=15 previous: type: string description: Enlace usado en la navegación por paginación. Devuelve la página anterior a la actual en la paginación de las transacciones. x-ibm-languages: description: en: Link used in paging navigation. Returns the previous page to the current page in the pagination of the transactions. example: /aspsp-name/v1/accounts/qwer3456tzui7890/transactions?page[number]=4&page[size]=15 last: type: string description: Enlace usado en la navegación para paginación. Devuelve la última página de la paginación de las transacciones. x-ibm-languages: description: en: Link used in paging navigation. Returns the last page of the pagination of the transactions. example: /aspsp-name/v1/accounts/qwer3456tzui7890/transactions?page[number]=10&page[size]=15 additionalProperties: false _AccountReport: type: object properties: booked: $ref: '#/definitions/_transactionsList' description: Últimas transacciones (anotaciones) conocidas de la cuenta. x-ibm-languages: description: en: Last known transactions (annotations) of the account. pending: $ref: '#/definitions/_transactionsList' description: Transacciones pendientes de la cuenta. x-ibm-languages: description: en: Pending account transactions. information: $ref: '#/definitions/_transactionsList' description: Listado de órdenes permanentes. Incluido si el parámetro bookingStatus está establecido a "information" x-ibm-languages: description: en: List of standing orders. Included if the bookingStatus parameter is set to "information" _links: description: Cuenta del beneficiario x-ibm-languages: description: en: Beneficiary account example: "" $ref: '#/definitions/_Links_Accounts_Transactions' _Amount: type: object properties: currency: type: string example: EUR content: type: string example: "150.03" _AccountReference: type: object properties: iban: type: string example: ES1111111111111111111111 bban: type: string example: "20385778983000760236" pan: type: string example: "1234567891234567" masked_pan: type: string example: 123456******4567 msisdn: type: string example: "12414515" currency: type: string example: EUR _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 _StandingOrderDetails: properties: startDate: type: string endDate: type: string executionRule: type: string withinAMonthFlag: type: boolean frequency: type: string monthsOfExecution: type: array items: type: string multiplicator: type: integer dayOfExecution: type: string limitAmount: $ref: '#/definitions/_Amount' _StructuredAdditionalInformation: properties: standingOrderDetails: $ref: '#/definitions/_StandingOrderDetails' _Transactions: properties: transactionId: type: string description: Identificador de la transacción. x-ibm-languages: description: en: Transaction identifier. endToEndId: type: string description: Identificador único end to end x-ibm-languages: description: en: Unique identifier end to end entryReference: type: string description: Identificación de la transacción que puede ser usada, por ejemplo, en las consultas delta. x-ibm-languages: description: en: Identification of the transaction that can be used, for example, in delta queries. mandateId: type: string description: Identificación del mandato. Por ejemplo, un ID de un mandato SEPA. x-ibm-languages: description: en: 'Identification of the mandate. For example, an ID of a SEPA command. ' example: e733223hge7 checkId: type: string description: Identificador de un cheque x-ibm-languages: description: en: Identifier of a check creditorId: type: string description: Identificación del beneficiario. Por ejemplo, un ID de beneficiario SEPA. x-ibm-languages: description: en: 'Beneficiary identification. For example, a SEPA beneficiary ID. ' example: e7363987hge7 bookingDate: type: string description: Fecha de anotación de la transacción x-ibm-languages: description: en: Transaction annotation date example: "2017-10-23" valueDate: type: string description: Fecha valor de la transacción x-ibm-languages: description: en: Transaction value date example: "2017-10-23" transactionAmount: $ref: '#/definitions/_Amount' description: Cantidad de la transaccion x-ibm-languages: description: en: Transaction amount currencyExchange: $ref: '#/definitions/_CurrencyExchange' description: Tasa de intercambio x-ibm-languages: description: en: Exchange rate creditorName: type: string description: Nombre del beneficiario si la transacción es un cargo. x-ibm-languages: description: en: Name of the beneficiary if the transaction is a charge. example: NombreEjemplo creditorAccount: description: Cuenta del beneficiario. x-ibm-languages: description: en: Beneficiary account. $ref: '#/definitions/_AccountReference' ultimateCreditor: type: string description: Beneficiario final. x-ibm-languages: description: en: Final beneficiary. debtorName: type: string description: Nombre del ordenante x-ibm-languages: description: en: Name of the payer example: NombreEjemplo debtorAccount: description: Cuenta del ordenante. x-ibm-languages: description: en: Account of the payer. $ref: '#/definitions/_AccountReference' ultimateDebtor: type: string description: Nombre ordenante final. x-ibm-languages: description: en: Final ordering name. example: NombreEjemplo remittanceInformationUnstructured: type: string description: Campo para incluir información adicional del envío. x-ibm-languages: description: en: Field to include additional shipping information. example: Informacion adicional remittanceInformationStructured: type: string description: Campo para incluir una referencia x-ibm-languages: description: en: Field to include a reference example: 1234-asdf-456 additionalInformationStructured: description: Es usado solo si el campo bookingStatus contiene el valor "information". Cada orden permanente activa relacionada a la cuenta de pago resulta en una entrada. x-ibm-languages: description: en: It is used only if the bookingStatus field contains the value "information". Each active standing order related to the payment account results in one entry. $ref: '#/definitions/_StructuredAdditionalInformation' bankTransactionCode: type: string description: Codigo de la transaccion bancaria como es usado por los ASPSP x-ibm-languages: description: en: Bank transaction code as used by the ASPSP additionalProperties: false _transactionsList: type: array items: $ref: '#/definitions/_Transactions' _balancesList: type: array items: $ref: '#/definitions/_Balances' _CurrencyExchange: properties: currencyFrom: type: string description: Moneda Origen x-ibm-languages: description: en: Currency Origin example: USD rate: type: string description: 'Define la tarifa de intercambio. Ej: currencyFrom=USD, currencyTo=EUR: 1USD =0.8 EUR y 0.8 es la tarifa.' x-ibm-languages: description: en: 'Define the exchange rate. Ex: currencyFrom = USD, currencyTo = EUR: 1USD = 0.8 EUR and 0.8 is the rate. ' example: "0.8" currencyTo: type: string description: Moneda Destino x-ibm-languages: description: en: Destination Currency example: EUR rateDate: type: string description: Fecha de la tarifa. Formato ISODateTime x-ibm-languages: description: en: Rate date. ISODateTime format rateContract: type: string description: Referencia al contrato de la tarifa x-ibm-languages: description: en: Reference to the tariff contract additionalProperties: false required: - currencyFrom - rate - currencyTo - rateDate paths: /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. x-ibm-languages: summary: en: Obtaining list of accounts description: en: 'This service allows you to obtain a list of PSU accounts, including account balances if required. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. The operation of the service according to the type of access indicated in the consent. ' operationId: getAccountListv11 parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: withBalance in: query required: false default: "false" type: string description: Si está incluido, esta función incluye los balances. Esta petición será rechazada si el acceso a balances no lo recoge el consentimiento o el ASPSP no soporta este parámetro. x-ibm-languages: description: en: 'If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. ' - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321' x-ibm-languages: description: en: 'Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321' default: 7890-asdf-4321 - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' default: TestTPPCertificate responses: default: description: OK x-ibm-languages: description: en: OK examples: application/json: accounts: - resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e80f iban: ES1111111111111111111111 currency: EUR product: Girokonto cashAccountType: CACC name: Main Account _links: balances: href: /v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances transactions: href: /v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions - resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e81g iban: ES2222222222222222222222 currency: USD cashAccountType: CACC name: US Dollar Account _links: balances: href: /v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances schema: $ref: '#/definitions/responseAccountsList' tags: - Servicio de acceso a información sobre cuentas /api-entrada-xs2a/services/{aspsp}/v1.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. x-ibm-languages: summary: en: Reading account detail description: en: 'This service allows you to read the details of an account with the balances if required. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. The operation of the service according to the type of access indicated in the consent. ' operationId: getAccountIdv11 parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: account-id in: path required: true type: string - name: withBalance in: query required: false default: "false" type: string description: Si está incluido, esta función incluye los balances. Esta petición será rechazada si el acceso a balances no lo recoge el consentimiento o el ASPSP no soporta este parámetro. x-ibm-languages: description: en: 'If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. ' - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321' x-ibm-languages: description: en: 'Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321' default: 7890-asdf-4321 - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' default: TestTPPCertificate responses: default: description: OK x-ibm-languages: description: en: OK examples: application/json: account: resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e80f iban: ES1111111111111111111111 currency: EUR ownerName: Heike Mustermann product: Girokonto cashAccountType: CACC name: Main Account _links: balances: href: /v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances transactions: href: /v1/accounts/3dc3d5b3-7023-4848-9853--5400a64e80f/transactions schema: $ref: '#/definitions/responseAccountDetail' tags: - Servicio de acceso a información sobre cuentas /api-entrada-xs2a/services/{aspsp}/v1/accounts/{account-id}/transactions: get: summary: Obtener las transacciones de una cuenta description: Este servicio permite obtener las transacciones de una cuenta determinada por su identificador. Este servicio permite obtener los balances de una cuenta determinada por su identificador. Como requisito, se asume que el PSU ha dado su consentimiento para este acceso y ha sido almacenado por el ASPSP. x-ibm-languages: summary: en: Get the transactions of an account description: en: 'This service allows to obtain the transactions of an account determined by its identifier. This service allows to obtain the balances of an account determined by its identifier. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. ' operationId: accountsTrasactions parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: account-id in: path required: true type: string description: Id de la cuenta x-ibm-languages: description: en: Account id - name: dateFrom type: string required: false in: query description: Fecha de inicio de consulta. Es incluido si no es requerido un acceso delta. x-ibm-languages: description: en: Query start date. It is included if delta access is not required. - name: dateTo type: string required: false in: query description: 'Fecha de fin de consulta. Su valor por defecto es la facha actual si no es dado. Ej: 2017-11-05' x-ibm-languages: description: en: 'Date of end of consultation. Its default value is the current façade if it is not given. Ex: 2017-11-05 ' - name: entryReferenceFrom type: string required: false in: query description: Al ser indicado, nos daría los resultados desde la llamada con transactionId anterior al dado. Alternativo a dateFrom y dateTo x-ibm-languages: description: en: 'If indicated, it would give us the results from the call with transactionId before the given one. Alternative to dateFrom and dateTo ' - name: bookingStatus type: string required: true in: query description: Estados de las transacciones devueltas. Los codigos de estado permitidos son “booked”, “pending”, "information" y “both”. Los obligatorios para los ASPSPs son “booked”. x-ibm-languages: description: en: States of returned transactions. The allowed status codes are "booked", "pending", "information" and "both". Mandatory for ASPSPs are "booked." - name: deltaList type: boolean required: false in: query description: Indica que el AISP está a favor de obtener todas las transacciones después del último acceso de informe para esta PSU y cuenta. Este indicador podría ser rechazado por el ASPSP si esta función no es compatible. x-ibm-languages: description: en: Indicates that the AISP is in favor of obtaining all transactions after the last report access for this PSU and account. This indicator could be rejected by the ASPSP if this function is not supported. - name: withBalance type: string required: false default: "false" in: query description: Si está incluido, esta función incluye los balances. Esta petición será rechazada si el acceso a balances no lo recoge el consentimiento o el ASPSP no soporta este parámetro. x-ibm-languages: description: en: 'If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. ' - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321' x-ibm-languages: description: en: 'Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321' default: 7890-asdf-4321 - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' default: TestTPPCertificate responses: default: description: 200 OK x-ibm-languages: description: en: 200 OK schema: $ref: '#/definitions/responseAccountTransactions' tags: - Servicio de acceso a información sobre cuentas /api-entrada-xs2a/services/{aspsp}/v1/accounts/{account-id}/balances: get: summary: Informacion de los balances del pago description: Este servicio permite obtener los balances de una cuenta determinada por su identificador. Como requisito, se asume que el PSU ha dado su consentimiento para este acceso y ha sido almacenado por el ASPSP. x-ibm-languages: summary: en: Payment balance information description: en: 'This service allows to obtain the balances of an account determined by its identifier. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. ' operationId: getAccountBalances parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: account-id in: path required: true type: string description: Id de la cuenta x-ibm-languages: description: en: Account id - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321' x-ibm-languages: description: en: 'Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321' default: 7890-asdf-4321 - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' default: TestTPPCertificate responses: default: description: OK x-ibm-languages: description: en: OK examples: application/json: account: iban: ES1111111111111111111111 balances: - balanceType: closingBooked balanceAmount: currency: EUR amount: "500.00" referenceDate: "2017-10-25" - balanceType: expected balanceAmount: currency: EUR amount: "900.00" lastChangeDateTime: "2017-10-25T15:30:35.035Z" schema: $ref: '#/definitions/responseAccountBalances' tags: - Servicio de acceso a información sobre cuentas /api-entrada-xs2a/services/{aspsp}/v1/accounts: get: summary: Obtencion listado de cuentas description: Este servicio permite obtener un listado de cuentas del PSU, incluyendo los balances de las cuentas si ha sido requerido. Como requisito, se asume que el PSU ha dado su consentimiento para este acceso y ha sido almacenado por el ASPSP. El funcionamiento del servicio según el tipo de acceso indicado en el consentimiento. x-ibm-languages: summary: en: Obtaining list of accounts description: en: 'This service allows you to obtain a list of PSU accounts, including account balances if required. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. The operation of the service according to the type of access indicated in the consent. ' operationId: getAccountList parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: withBalance in: query required: false default: "false" type: string description: Si está incluido, esta función incluye los balances. Esta petición será rechazada si el acceso a balances no lo recoge el consentimiento o el ASPSP no soporta este parámetro. x-ibm-languages: description: en: 'If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. ' - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321' x-ibm-languages: description: en: 'Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321' default: 7890-asdf-4321 - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' default: TestTPPCertificate responses: default: description: OK x-ibm-languages: description: en: OK examples: application/json: accounts: - resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e80f iban: ES1111111111111111111111 currency: EUR product: Girokonto cashAccountType: CACC name: Main Account _links: balances: href: /v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances transactions: href: /v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions - resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e81g iban: ES2222222222222222222222 currency: USD cashAccountType: CACC name: US Dollar Account _links: balances: href: /v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances schema: $ref: '#/definitions/responseAccountsList' tags: - Servicio de acceso a información sobre cuentas /api-entrada-xs2a/services/{aspsp}/v1/accounts/{account-id}: get: summary: Lectura detalle de cuent description: Este servicio permite leer los detalles de una cuenta con los balances si son requeridos.Como requisito, se asume que el PSU ha dado su consentimiento para este acceso y ha sido almacenado por el ASPSP. El funcionamiento del servicio según el tipo de acceso indicado en el consentimiento. x-ibm-languages: summary: en: Reading account detail description: en: 'This service allows you to read the details of an account with the balances if required. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. The operation of the service according to the type of access indicated in the consent. ' operationId: getAccountId parameters: - name: aspsp in: path required: true type: string description: Nombre del ASPSP al que desea realizar la petición. x-ibm-languages: description: en: Name of the ASPSP to which you wish to make the request. - name: account-id in: path required: true type: string - name: withBalance in: query required: false default: "false" type: string description: Si está incluido, esta función incluye los balances. Esta petición será rechazada si el acceso a balances no lo recoge el consentimiento o el ASPSP no soporta este parámetro. x-ibm-languages: description: en: 'If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter. ' - name: X-Request-ID in: header required: true type: string description: 'Identificador único de la transacción asignado por el TPP. Ej: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: Authorization in: header required: true type: string description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2. Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA' x-ibm-languages: description: en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA ' default: Bearer 6yBnsqnMQQ - name: Consent-ID in: header required: true type: string description: 'Identificador del consentimiento sobre el que iría la consulta de cuentas Ej: Consent-ID: 7890-asdf-4321' x-ibm-languages: description: en: 'Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321' default: 7890-asdf-4321 - name: PSU-IP-Address in: header required: false type: string description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no está disponible, el TPP debe usar la dirección IP usada por el TPP cuando envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5' x-ibm-languages: description: en: 'IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 ' - name: PSU-IP-Port in: header required: false type: string description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está disponible. Ejemplo: PSU-IP-Port: 443' x-ibm-languages: description: en: 'IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443 ' - name: PSU-Accept in: header required: false type: string description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept: application/json' x-ibm-languages: description: en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json ' - name: PSU-Accept-Charset in: header required: false type: string description: 'Accept charset header de la petición HTTP entre PSU y el TPP. PSU-Accept-Charset: utf-8' x-ibm-languages: description: en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8 ' - name: PSU-Accept-Language in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: es-ES ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES ' - name: PSU-Accept-Encoding in: header required: false type: string description: 'Accept language header de la petición HTTP entre PSU y el TPP. PSU-Accept-Language: gzip ' x-ibm-languages: description: en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip ' - name: PSU-User-Agent in: header required: false type: string description: 'Navegador o sistema operativo de la petición HTTP entre el PSU y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) ' x-ibm-languages: description: en: 'Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729) ' - name: PSU-Http-Method in: header required: false type: string description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos: GET, POST, PUT, PATCH, DELETE. Ej: PSU-Http-Method: GET ' x-ibm-languages: description: en: 'HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET ' default: GET - name: PSU-Device-ID in: header required: false type: string description: 'UUID (Universally Unique Identifier) para un dispositivo. El UUID identifica al dispositivo o a una instalación de una aplicación en un dispositivo. Este ID no debe ser modificado hasta la desinstalación de la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7' x-ibm-languages: description: en: 'UUID (Universally Unique Identifier) ​​for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 ' - name: PSU-Geo-Location in: header required: false type: string description: 'Localización correspondiente a la petición HTTP entre el PSU y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963' x-ibm-languages: description: en: 'Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 ' - name: Digest in: header required: true type: string description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ==' x-ibm-languages: description: en: 'It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ == ' - name: Signature in: header required: true type: string description: 'Firma de la petición por el TPP. ' x-ibm-languages: description: en: 'Signature of the petition by the TPP. ' - name: TPP-Signature-Certificate in: header required: true type: string description: 'Certificado del TPP usado para firmar la petición, en base64, sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' x-ibm-languages: description: en: 'TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA ' default: TestTPPCertificate responses: default: description: OK x-ibm-languages: description: en: OK examples: application/json: account: resourceId: 3dc3d5b3-7023-4848-9853-f5400a64e80f iban: ES1111111111111111111111 currency: EUR ownerName: Heike Mustermann product: Girokonto cashAccountType: CACC name: Main Account _links: balances: href: /v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances transactions: href: /v1/accounts/3dc3d5b3-7023-4848-9853--5400a64e80f/transactions schema: $ref: '#/definitions/responseAccountDetail' tags: - Servicio de acceso a información sobre cuentas 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: / x-ibm-endpoints: - endpointUrl: https://apis-i.redsys.es:20443/psd2/xs2a description: Endpoint entorno Integracion type: - production - development ...