---
swagger: "2.0"
info:
  x-ibm-name: trustedBeneficiaries
  title: Security/TrustedBeneficiaries
  version: 1.2.0
  description: API implementing  processes related with trusted beneficiaries (i.e.
    whitelisting of accounts or payments), in order to exclude particular monetary
    transactions or payments from any second factor authentication requirements.
  contact:
    name: Rapidlink Support Team
    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/security/trustedBeneficiaries
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  Sandbox OAuth:
    type: oauth2
    description: Resource Owner Implicit Grant Type
    flow: accessCode
    scopes:
      /sandboxapi: Access to all security resources in sandbox
    authorizationUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
    tokenUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
    x-tokenIntrospect:
      url: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1.2.1/oauth/internal/introspect
  MSIS OAuth:
    type: oauth2
    description: ""
    flow: accessCode
    scopes:
      winbankAccess winbankAccess.info winbankAccess.monetaryTransactions: ""
    authorizationUrl: https://openbank.piraeusbank.gr/identityserver/connect/authorize
    tokenUrl: https://openbank.piraeusbank.gr/identityserver/connect/token
    x-tokenIntrospect:
      url: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1.2/oauth/external/introspect
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- clientIdHeader: []
  MSIS OAuth:
  - winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
- clientIdHeader: []
  Sandbox OAuth:
  - /sandboxapi
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/GetTrustedBeneficiaries_Output'
      operationId: GetTrustedBeneficiaries
      tags:
      - Security
      - TrustedBeneficiaries
      summary: Get list of trusted beneficiaries
      description: Get list of trusted beneficiaries
    parameters:
    - $ref: '#/parameters/Authorization'
  /list:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/GetStagedBeneficiaries_Output'
      operationId: GetStagedBeneficiaries
      summary: Get list of beneficiaries staged for whitelisting
      description: Get list of beneficiaries staged for whitelisting
      tags:
      - Security
      - TrustedBeneficiaries
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/PostStageBeneficiary_Output'
      operationId: PostStageBeneficiary
      parameters:
      - name: body
        required: true
        in: body
        schema:
          $ref: '#/definitions/PostStageBeneficiary_Input'
      tags:
      - Security
      - TrustedBeneficiaries
      summary: Add beneficiary to staging list for whitelisting
      description: Add beneficiary to staging list for whitelisting
    delete:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/RemoveAllStagedBeneficiaries_Output'
      operationId: RemoveAllStagedBeneficiaries
      tags:
      - Security
      - TrustedBeneficiaries
      summary: Remove all staged beneficiaries from list for whitelisting
      description: Remove all staged beneficiaries from list for whitelisting
    parameters:
    - $ref: '#/parameters/Authorization'
  /list/{stagedId}:
    parameters:
    - $ref: '#/parameters/Authorization'
    delete:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/DeleteStagedBeneficiary_Output'
      operationId: DeleteStagedBeneficiary
      parameters:
      - name: stagedId
        type: string
        required: true
        in: path
      tags:
      - Security
      - TrustedBeneficiaries
      summary: Remove a staged beneficiary from list for whitelisting based on its
        stageId
      description: Remove a staged beneficiary from list for whitelisting based on
        its stageId
  /validate:
    parameters:
    - $ref: '#/parameters/Authorization'
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/AddTrustedBeneficiariesValidate_Output'
      operationId: AddTrustedBeneficiariesValidate
      tags:
      - Security
      - TrustedBeneficiaries
      summary: Validate insertion of trusted beneficiaries
      description: Validate insertion of trusted beneficiaries
  /execute:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/AddTrustedBeneficiariesExecute_Output'
      operationId: AddTrustedBeneficiariesExecute
      summary: Execute insertion of trusted beneficiaries
      description: Execute insertion of trusted beneficiaries
      tags:
      - Security
      - TrustedBeneficiaries
      parameters:
      - name: body
        required: false
        in: body
        schema:
          $ref: '#/definitions/AddTrustedBeneficiariesExecute_Input'
  /{trustedBeneficiaryID}:
    parameters:
    - $ref: '#/parameters/Authorization'
    delete:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/RemoveTrustedBeneficiary_Output'
      operationId: RemoveTrustedBeneficiary
      parameters:
      - name: trustedBeneficiaryID
        type: string
        required: true
        in: path
      summary: Remove a trusted beneficiary
      description: Remove a trusted beneficiary
      tags:
      - Security
      - TrustedBeneficiaries
definitions:
  BeneficiaryBank:
    properties:
      Name:
        type: string
        description: Bank name of beneficiary's account
        example: EFG EUROBANK ERGASIAS
      Bic:
        type: string
        description: Bic of beneficiary's account
        example: ERBKGRAAXXX
      Address:
        type: string
        description: Main bank address of beneficiary's account
        example: OTHONOS STREET 8
      CountryIsoCode:
        type: string
        description: Country ISO code of beneficiary's account
        example: GR
      City:
        type: string
        description: City of beneficiary's bank main address
        example: ATHENS
      DomesticBankCode:
        type: string
        description: Domestic bank code of beneficiary's account
        example: "026"
    additionalProperties: false
    description: Object containing information about the beneficiary's bank
  StageBeneficiary_Input:
    properties:
      ProductValue:
        type: string
        description: Account number or payment code for whitelisting
      BeneficiaryBank:
        $ref: '#/definitions/BeneficiaryBank'
        description: (Optional. Used in remittances) Object containing information
          about the beneficiary bank
      BeneficiaryName:
        type: string
        description: (Optional. Used in remittances) Name of beneficiary
    additionalProperties: false
    description: Object containing information about the beneficiary to be staged
      for whitelisting
  GetTrustedBeneficiaries_Output:
    type: array
    items:
      $ref: '#/definitions/GetTrustedBeneficiaries_Definition'
    description: Array of objects of type GetTrustedBeneficiaries_Definition
  GetTrustedBeneficiaries_Definition:
    properties:
      WhitelistId:
        type: string
        example: VDA6RPYZ2Mp
        description: Unique identifier of whitelist entry
      OperationDescription:
        type: string
        example: Vodafone Mobile/Fixed
        description: Description of whitelisted operation
      WhitelistType:
        type: integer
        format: int32
        example: "4"
        description: 1 = Active, 2 = Destination, 4 = Operation, otherwise = N/A
      WhitelistTypeDescription:
        type: string
        example: Operation
        description: Description of the WhitelistType
      DisplayName:
        type: string
        example: Vodafone Mobile/Fixed
        description: Displayed name of whitelisted beneficiary/payment operation
      UpdateDate:
        type: string
        example: "2023-01-16T16:33:38.917"
        description: Date of last update
    additionalProperties: false
    description: Object containing information about TrustedBeneficiaries
  GetStagedBeneficiaries_Output:
    type: array
    items:
      $ref: '#/definitions/GetStagedBeneficiaries_Definition'
    description: Array of objects of type GetStagedBeneficiaries_Definition
  GetStagedBeneficiaries_Definition:
    properties:
      StagedId:
        type: string
        description: Unique identifier of the staged list element
      Timestamp:
        type: string
        description: Time of beneficiary staging
      DisplayName:
        type: string
        description: Displayed name of beneficiary/payment operation staged for whitelisting
      ProductValue:
        type: string
        description: Account number or payment code staged for whitelisting
      Name:
        type: string
        description: Bank name of beneficiary's account
      Bic:
        type: string
        description: Bic of beneficiary's account
      Address:
        type: string
        description: Main bank address of beneficiary's account
      CountryIsoCode:
        type: string
        description: Country ISO code of beneficiary's account
      City:
        type: string
        description: City of beneficiary's bank main address
      DomesticBankCode:
        type: string
        description: Domestic bank code of beneficiary's account
      BeneficiaryName:
        type: string
        description: Name of beneficiary staged for whitelisting
    additionalProperties: false
    description: Object containing information about the beneficiary staged for whitelisting
  PostStageBeneficiary_Input:
    properties:
      DisplayName:
        type: string
        description: Displayed name of beneficiary/payment operation staged for whitelisting
      ProductValue:
        type: string
        description: Account number or payment code staged for whitelisting
      BeneficiaryBank:
        $ref: '#/definitions/BeneficiaryBank'
        description: (Optional. Used in remittances) Object containing information
          about the beneficiary bank
    additionalProperties: false
    description: Input object required for staging the beneficiary for whitelisting
  PostStageBeneficiary_Output:
    properties:
      message:
        type: string
        description: Generic success message
        example: Successfully added to list
    additionalProperties: false
    description: Object containing the response of the request to stage a beneficiary
      for whitelisting
  RemoveAllStagedBeneficiaries_Output:
    properties:
      message:
        type: string
        description: Generic success/failure message
        example: list successfully cleared
    additionalProperties: false
    description: Object containing the response of the request to delete all staged
      beneficiaries for whitelisting
  DeleteStagedBeneficiary_Output:
    properties:
      message:
        type: string
        description: Generic success message
        example: staged entry {stagedId} successfully deleted
    additionalProperties: false
    description: Object containing the response of the request to delete a staged
      beneficiary for whitelisting
  AddTrustedBeneficiariesValidate_Output:
    properties:
      SessionKey:
        type: string
        description: Session key used in /execute
    additionalProperties: false
    description: Object containing the output of the request for validating the addition
      of new trusted beneficiaries
  AddTrustedBeneficiariesExecute_Input:
    properties:
      SessionKey:
        type: string
        description: Session key fetched from /validate
      ExtraPin:
        type: string
        example: "3288000"
    additionalProperties: false
    description: Input object required for executing the addition of new trusted beneficiaries
  AddTrustedBeneficiariesExecute_Output:
    properties:
      message:
        type: string
        description: Generic success/failure message
    additionalProperties: false
    description: Object containing the output of the request for executing the addition
      of new trusted beneficiaries
  RemoveTrustedBeneficiary_Output:
    properties:
      message:
        type: string
        description: Generic success/failure message
        example: '{whitelistId} successfully deleted'
    additionalProperties: false
    description: Object containing the response of the request to delete a trusted
      beneficiary
tags: []
externalDocs:
  description: Getting Started
  url: https://rapidlink.piraeusbank.gr/start
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
x-ibm-endpoints:
- endpointUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production
  description: Base Gateway API Endpoint
  type:
  - production
  - development
...