---
swagger: "2.0"
info:
  version: 1.0.0
  title: CFS API
  description: Confirmation Of Funds API
  x-ibm-name: confirmation-of-funds
  contact:
    name: Postbank
    email: apigate@postbank.bg
    url: https://www.postbank.bg
externalDocs:
  description: Latest update is published here
  url: https://www.postbank.bg/
schemes:
- https
securityDefinitions:
  OAuth2:
    type: oauth2
    description: ""
    flow: accessCode
    scopes:
      cfs: ""
    authorizationUrl: https://gate.postbank.bg:444/postbank/psd2/oauth2/authorize
    tokenUrl: https://gate.postbank.bg:444/postbank/psd2/oauth2/token
    x-tokenIntrospect:
      url: ""
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
definitions:
  Amount:
    type: object
    required:
    - currency
    - amount
    properties:
      currency:
        type: string
        pattern: ^[A-Z]{3}
        description: ISO 4217 code of account currency
      amount:
        type: string
        pattern: (^([0-9]+(.?[0-9]?[0-9])*?|[0-9]+)$)
  AccountReference:
    type: object
    required:
    - iban
    properties:
      iban:
        type: string
  ErrorModel:
    type: object
    properties:
      tppMessages:
        type: array
        items:
          type: object
          properties:
            category:
              type: string
            code:
              type: string
            text:
              type: string
  ConfirmationOfFundsRequestBody:
    type: object
    required:
    - account
    - instructedAmount
    properties:
      cardNumber:
        type: string
        description: Card Number of the card issued by the PIISP. Must be delivered
          if available.
      account:
        description: Account number
        $ref: '#/definitions/AccountReference'
      payee:
        type: string
        description: The merchant where the card is accepted as an information to
          the PSU.
      instructedAmount:
        description: Transaction amount to be checked within the funds check mechanism.
        $ref: '#/definitions/Amount'
paths:
  /funds-confirmations:
    post:
      tags:
      - Funds
      summary: Confirmation of Funds Request
      description: Checks whether funds are available for a payment transaction on
        an account linked with a given tuple cardissuer/cardnumber, or an IBAN and
        TPP respectively. The currency of requested funds must be the same as PSU`s
        account currency.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: X-Request-ID
        in: header
        type: string
        format: uuid
        description: ID of the request, unique to the call, as determined by the initiating
          party.
        required: true
      - name: Request Body
        in: body
        description: Funds confirmation request body.
        required: true
        schema:
          $ref: '#/definitions/ConfirmationOfFundsRequestBody'
      responses:
        200:
          description: OK
          schema:
            type: object
            required:
            - fundsAvailable
            properties:
              fundsAvailable:
                type: string
                description: Equals “true” if sufficient funds are available at the
                  time of the request, “false” otherwise.
            example:
              fundsAvailable: "true"
          headers:
            X-Request-ID:
              type: string
              description: ID of the request, unique to the call, as determined by
                the initiating party.
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorModel'
          headers:
            X-Request-ID:
              type: string
              description: ID of the request, unique to the call, as determined by
                the initiating party.
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/ErrorModel'
          headers:
            X-Request-ID:
              type: string
              description: ID of the request, unique to the call, as determined by
                the initiating party.
x-ibm-configuration:
  enforced: true
  testable: false
  phase: realized
  application-authentication:
    certificate: true
security:
- OAuth2:
  - cfs
  clientIdHeader: []
basePath: /v1
consumes:
- application/json
produces:
- application/json
x-ibm-endpoints:
- endpointUrl: https://gate.postbank.bg/postbank/psd2
  type:
  - production
  - development
...