---
swagger: "2.0"
info:
  description: API de Redsys para PSD2
  version: 1.0.0
  title: Confirmación de fondos
  x-ibm-name: api-dc51c
  contact:
    name: Soporte PSD2
    email: psd2.sandbox.soporte@redsys.es
  x-ibm-languages:
    title:
      en: FundsConfirmations-FCS-PSD2
tags:
- name: PSD2
  description: Endpoints disponibles para el hub PSD2
definitions:
  Amount:
    type: object
    properties:
      currency:
        type: string
        example: EUR
      amount:
        type: string
        example: "150.03"
  AccountReference:
    type: object
    properties:
      iban:
        type: string
        example: ES1111111111111111111111
        description: IBAN de la cuenta
        x-ibm-languages:
          description:
            en: Account IBAN
      bban:
        type: string
        description: BBAN de la cuenta, cuando esta no tiene IBAN.
        x-ibm-languages:
          description:
            en: Account BBAN, when it does not have IBAN.
        example: "20385778983000760236"
      pan:
        type: string
        description: Número de la tarjeta de la cuenta. Puede ser tokenizado por el
          ASPSP para cumplir los requerimientos de PCI DSS. Campo no soportado por
          el HUB.
        x-ibm-languages:
          description:
            en: Account card number. It can be tokenized by the ASPSP to meet the
              PCI DSS requirements. Field not supported by the HUB.
        example: "1234567891234567"
      msisdn:
        type: string
        description: Alias para acceder a una cuenta de pago a través de un número
          de teléfono móvil registrado.
        x-ibm-languages:
          description:
            en: Alias ​​to access a payment account through a registered mobile phone
              number.
        example: "195198741874"
      currency:
        type: string
        description: Tipo de moneda.
        x-ibm-languages:
          description:
            en: Type of currency.
        example: EUR
  fundsConfirmationRequest:
    properties:
      cardNumber:
        type: string
        description: Numeración de la tarjeta emitida por el PIISP. Debe ser enviada
          si está disponible. Este campo no está soportado para esta versión
        x-ibm-languages:
          description:
            en: Card number issued by the PIISP. It must be sent if available. This
              field is not supported for this version.
        example: 1111-1111-1111-1111
      account:
        $ref: '#/definitions/AccountReference'
        description: Número de cuenta del PSU.
        x-ibm-languages:
          description:
            en: PSU account number.
      payee:
        type: string
        description: Comercio donde la tarjeta es aceptada como información para el
          PSU.
        x-ibm-languages:
          description:
            en: Commerce where the card is accepted as information for the PSU.
        example: Comercio
      instructedAmount:
        description: Contiene la cantidad y moneda a consultar.
        x-ibm-languages:
          description:
            en: Contains the quantity and currency to consult.
        $ref: '#/definitions/Amount'
    required:
    - account
    - instructedAmount
  fundsConfirmationResponse:
    type: object
    properties:
      tppMessage:
        $ref: '#/definitions/_tppMessage'
        description: Mensaje para el TPP
        x-ibm-languages:
          description:
            en: Message for the TPP
      fundsAvailable:
        type: boolean
        example: "true"
        description: Toma el valor "true" si hay suficientes fondos disponibles en
          el momento de la petición. "false" en otro caso.
        x-ibm-languages:
          description:
            en: It takes the value "true" if there are enough funds available at the
              time of the request. "false" in another case.
  _tppMessage:
    properties:
      category:
        type: string
        example: OK
      code:
        properties: []
        type: string
        example: ACCESS_OK
      text:
        properties: []
        type: string
        example: Acceso OK
      path:
        properties: []
        type: string
        example: /example/path
    additionalProperties: false
paths:
  /api-entrada-xs2a/services/{aspsp}/v1/funds-confirmations:
    post:
      summary: Funds Confirmation - Confirmacion de Fondos
      description: Este tipo de mensaje es utilizado en el servicio de consulta de
        fondos. El HUB consulta al ASPSP por la disponibilidad de fondos para una
        cantidad dada. El HUB se comunica con el ASPSP para preguntar si tiene fondos
        y, tras consultarlo, devuelve la respuesta al TPP.
      x-ibm-languages:
        summary:
          en: Funds Confirmation - Funds Confirmation
        description:
          en: 'This type of message is used in the fund consultation service. The
            HUB consults the ASPSP for the availability of funds for a given amount.
            The HUB communicates with the ASPSP to ask if it has funds and, after
            consultation, returns the response to the TPP. '
      operationId: fundsConfirmation
      parameters:
      - name: aspsp
        in: path
        required: true
        type: string
        description: Nombre del ASPSP al que desea realizar la petición.
        x-ibm-languages:
          description:
            en: Name of the ASPSP to which you wish to make the request.
      - name: X-Request-ID
        in: header
        required: true
        type: string
        description: 'Identificador único para la petición dado por el TPP. Relaciona
          la petición HTTP entre TPP y HUB. Ejemplo: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7'
        x-ibm-languages:
          description:
            en: 'Unique identifier for the request given by the TPP. Match the HTTP
              request between TPP and HUB. Example: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
      - name: Digest
        in: header
        required: true
        type: string
        description: 'Es contenido si viaja el campo Signature. Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ=='
        x-ibm-languages:
          description:
            en: 'It is content if the Signature field travels. Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ
              == '
      - name: Signature
        in: header
        required: true
        type: string
        description: Firma de la peticion por el TPP.
        x-ibm-languages:
          description:
            en: Signature of the petition by the TPP.
      - name: TPP-Signature-Certificate
        in: header
        required: true
        type: string
        description: Certificado firmado
        x-ibm-languages:
          description:
            en: Certificate signed
      - name: Authorization
        in: header
        required: true
        type: string
        description: Bearer Token. Obtenido en una autenticación previa sobre OAuth2.
          Solo si se ha realizado la gestión del consentimiento a través del API.
        x-ibm-languages:
          description:
            en: Bearer Token. Obtained in a previous authentication on OAuth2. Only
              if consent management has been done through the API.
      - name: Consent-ID
        in: header
        required: true
        type: string
        description: Identificador del consentimiento obtenido en la transacción de
          solicitar consentimiento. Solo si se ha realizado la gestión del consentimiento
          a través del API.
        x-ibm-languages:
          description:
            en: Identifier of the consent obtained in the transaction to request consent.
              Only if consent management has been done through the API.
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/fundsConfirmationRequest'
      responses:
        default:
          headers:
            X-Request-ID:
              type: string
              description: 'Identificador único para la petición dado por el TPP.
                Relaciona la petición HTTP entre TPP y HUB. Ejemplo: X-Request-ID:
                1b3ab8e8-0fd5-43d2-946e-d75958b172e7'
              x-ibm-languages:
                description:
                  en: 'Unique identifier for the request given by the TPP. Match the
                    HTTP request between TPP and HUB. Example: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
          description: OK
          x-ibm-languages:
            description:
              en: OK
          examples:
            application/json:
              fundsAvailable: true
          schema:
            $ref: '#/definitions/fundsConfirmationResponse'
      tags:
      - Servicio de confirmacion de fondos
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
...