---
swagger: "2.0"
info:
  x-ibm-name: piraeus4all
  title: Piraeus4All
  version: "1.2"
  description: Transactions/Payments API supports various kinds of payments (single/RF
    and bill/non-RF payments)
  contact:
    name: rapidlink support
    email: rapidlink@piraeusbank.gr
    url: https://rapidlink.piraeusbank.gr
  termsOfService: <href a="https://rapidlink.piraeusbank.gr/privacy">Privacy Policy</href>
  license:
    name: Terms and Conditions of Use
    url: https://rapidlink.piraeusbank.gr/terms
schemes:
- https
basePath: /v1.2/piraeus4all
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  MSIS OAuth:
    type: oauth2
    description: ""
    flow: accessCode
    authorizationUrl: https://identityserver.piraeusbank.gr/identityserver/connect/authorize
    scopes:
      winbankAccess winbankAccess.info winbankAccess.monetaryTransactions: ""
    tokenUrl: https://identityserver.piraeusbank.gr/identityserver/connect/token
    x-tokenIntrospect:
      url: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1.2.1/oauth/external/introspect
  Sandbox OAuth:
    type: oauth2
    description: Resource Owner Implicit Grant Type
    flow: accessCode
    authorizationUrl: https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
    scopes:
      /sandboxapi: Access to all payments resources in sandbox
    tokenUrl: https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
    x-tokenIntrospect:
      url: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1.2/oauth/internal/introspect
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Client ID Header
security:
- clientIdHeader: []
  MSIS OAuth:
  - winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
- clientIdHeader: []
  Sandbox OAuth:
  - /sandboxapi
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
  categories:
  - Piraeus4All
paths:
  /massPayments/validate:
    post:
      responses:
        200:
          description: 200 OK
      parameters:
      - name: file
        type: string
        required: false
        in: formData
        description: Encrypted file (.pgp) located in form data.
      - name: vopId
        type: string
        required: false
        in: formData
        description: After the VOP check is finished (if used), this field is required
          to use the /validate request, and the file is not needed.
      - name: withVop
        type: boolean
        required: false
        in: query
        description: Set to true if opting into VOP check, default value is false.
      operationId: massPaymentsValidate
      description: ""
    parameters:
    - $ref: '#/parameters/Authorization'
  /massPayments/execute:
    parameters:
    - $ref: '#/parameters/Authorization'
    post:
      responses:
        200:
          description: 200 OK
      operationId: massPaymentsExecute
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/MassPaymentsExecute'
  /massPayments/vopCheck/{vopId}:
    get:
      responses:
        200:
          description: 200 OK
      operationId: massPaymentsVopCheck
      parameters:
      - name: vopId
        type: string
        required: true
        in: path
        description: Returned in /validate when opting into VOP check.
    parameters:
    - $ref: '#/parameters/Authorization'
  /payrolls/validate:
    parameters:
    - $ref: '#/parameters/Authorization'
    post:
      responses:
        200:
          description: 200 OK
      operationId: payrollValidate
      parameters:
      - name: file
        type: string
        required: false
        in: formData
        description: Encrypted file (.pgp) located in form data.
      - name: vopId
        type: string
        required: false
        in: formData
        description: After the VOP check is finished (if used), this field is required
          to use the /validate request, and the file is not needed.
      - name: withVop
        type: boolean
        required: false
        in: query
        description: Set to true if opting into VOP check, default value is false.
  /payrolls/execute:
    parameters:
    - $ref: '#/parameters/Authorization'
    post:
      responses:
        200:
          description: 200 OK
      operationId: payrollExecute
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/PayrollExecute'
  /payrolls/vopCheck/{vopId}:
    get:
      responses:
        200:
          description: 200 OK
      operationId: payrollVopCheck
      parameters:
      - name: vopId
        type: string
        required: true
        in: path
        description: Returned in /validate when opting into VOP check.
    parameters:
    - $ref: '#/parameters/Authorization'
  /massPayments/list:
    get:
      responses:
        200:
          description: 200 OK
      operationId: massPaymentsList
    parameters:
    - $ref: '#/parameters/Authorization'
    - $ref: '#/parameters/dateFrom'
    - $ref: '#/parameters/dateTo'
    - $ref: '#/parameters/pageSize'
    - $ref: '#/parameters/nextPagePositionId'
  /payrolls/list:
    get:
      responses:
        200:
          description: 200 OK
      operationId: payrollsList
    parameters:
    - $ref: '#/parameters/Authorization'
    - $ref: '#/parameters/dateFrom'
    - $ref: '#/parameters/dateTo'
    - $ref: '#/parameters/pageSize'
    - $ref: '#/parameters/nextPagePositionId'
  /massPayments/paymentResults/{transactionReference}:
    get:
      responses:
        200:
          description: 200 OK
      operationId: massPaymentsPaymentResults
      parameters:
      - $ref: '#/parameters/transactionReference'
    parameters:
    - $ref: '#/parameters/Authorization'
    - $ref: '#/parameters/transactionReference'
  /payrolls/paymentResults/{transactionReference}:
    get:
      responses:
        200:
          description: 200 OK
      operationId: payrollsPaymentResults
      parameters:
      - $ref: '#/parameters/transactionReference'
    parameters:
    - $ref: '#/parameters/Authorization'
    - $ref: '#/parameters/transactionReference'
parameters:
  Authorization:
    name: Authorization
    type: string
    required: true
    in: header
    description: This header should be in the form "Bearer Token", where Token is
      returned from the call to OAuth2
  dateFrom:
    name: dateFrom
    type: string
    required: false
    in: query
    format: date-time
  dateTo:
    name: dateTo
    type: string
    required: false
    in: query
    format: date-time
  pageSize:
    name: pageSize
    type: integer
    required: false
    in: query
    format: int32
  nextPagePositionId:
    name: nextPagePositionId
    type: string
    required: false
    in: query
  transactionReference:
    name: transactionReference
    type: string
    required: true
    in: path
    description: Transaction reference, returned by /list apis. In that API, the transactionReference
      will be visible once processing of the file is finished in the bank's systems.
externalDocs:
  description: Getting Started
  url: https://rapidlink.piraeusbank.gr/start
tags:
- name: Piraeus4All
definitions:
  MassPaymentsExecute:
    properties:
      SessionKey:
        type: string
        example: 4QYCjB0Zas8osivYQxr8XRmdxNGUHj5bLD
        description: Returned from the /validate request.
      ExtraPin:
        type: string
        example: "3288000"
    additionalProperties: false
    required:
    - SessionKey
  PayrollExecute:
    properties:
      SessionKey:
        type: string
        description: Returned from the /validate request.
        example: 4QYCjB0Zas8osivYQxr8XRmdxNGUHj5bLD
      ExtraPin:
        type: string
        example: "3288000"
    additionalProperties: false
    required:
    - SessionKey
x-ibm-endpoints:
- endpointUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production
  description: Base Gateway API Endpoint
  type:
  - production
  - development
...