---
swagger: "2.0"
info:
  x-ibm-name: loans
  title: Assets/Loans
  version: "1.2"
  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
  description: Loans API provides access to loans and financing and their corresponding
    transactions
schemes:
- https
basePath: /v1.2/assets/loans
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  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
  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
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- clientIdHeader: []
  MSIS OAuth:
  - winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
- Sandbox OAuth:
  - /sandboxapi
  clientIdHeader: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /{loanId}/details:
    get:
      responses:
        200:
          description: 200 OK for Loans
          schema:
            $ref: '#/definitions/Asset_Loan_Details_Output'
        400:
          description: Bad request
          schema:
            $ref: '#/definitions/Error_Output'
        440:
          description: Session Expired
          schema:
            $ref: '#/definitions/SessionExpired_Output'
      tags:
      - Assets
      - Loans
      - Details
      summary: Get details of a loan
      operationId: GetLoanDetails
      parameters: []
      description: Fetches the details of a loan based on the required LoanId.
    parameters:
    - $ref: '#/parameters/Authorization'
    - $ref: '#/parameters/loanId'
  /:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/Assets_Loan_List_Output'
        400:
          description: Error
          schema:
            $ref: '#/definitions/Error_Output'
        440:
          description: 440 Session Expired
          schema:
            $ref: '#/definitions/SessionExpired_Output'
      tags:
      - Assets
      - Loans
      - List
      summary: Get a list of loans
      operationId: GetLoanList
      description: Fetches a list of the user's loans.
    parameters:
    - $ref: '#/parameters/Authorization'
  /{loanId}/transactions/{input_filter}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/Assets_Loan_Transactions_Output'
        400:
          description: Bad request
          schema:
            $ref: '#/definitions/Error_Output'
        440:
          description: Session Expired
          schema:
            $ref: '#/definitions/SessionExpired_Output'
      tags:
      - Asset
      - Loans
      - Transactions
      summary: Get transactions of a specific loan
      operationId: GetLoanTransactions
      parameters:
      - name: input_filter
        type: string
        required: true
        in: path
        description: Filter Loan Transactions.  Json string in the format of Asset_Loans_Transactions_Input
      description: Fetches the transactions of a loan based on the required LoanId
        and optional Input Filter.
    parameters:
    - $ref: '#/parameters/Authorization'
    - $ref: '#/parameters/loanId'
definitions:
  Assets_Loan_List_Output:
    type: object
    properties:
      Loans:
        $ref: '#/definitions/LoanList_Array'
  Assets_Loan_Transactions_Output:
    type: object
    properties:
      Transactions:
        items:
          properties:
            TransactionDate:
              type: string
            TransactionCode:
              type: string
            ValueDate:
              type: string
            Description:
              type: string
            Comments:
              type: string
            UserReference:
              type: string
            Amounts:
              type: object
              properties:
                Amount:
                  type: string
                Currency:
                  type: string
            CapitalAmount:
              type: object
              properties:
                Amount:
                  type: string
                Currency:
                  type: string
            InterestAmount:
              type: object
              properties:
                Amount:
                  type: string
                Currency:
                  type: string
            WithHoldInterestAmount:
              type: object
              properties:
                Amount:
                  type: string
                Currency:
                  type: string
            ProgressiveBalance:
              type: object
              properties:
                Amount:
                  type: string
                Currency:
                  type: string
            DeferredPaymentInterest:
              type: object
              properties:
                Amount:
                  type: string
                Currency:
                  type: string
            DealReference:
              type: string
            Narratives:
              type: string
            TaxType:
              type: string
            LoanAmount:
              type: object
              properties:
                Amount:
                  type: string
                Currency:
                  type: string
            Rate:
              type: string
            TotalInterest:
              type: object
              properties:
                Amount:
                  type: string
                Currency:
                  type: string
            TaxPaymentDate:
              type: string
        $ref: '#/definitions/LoanTransactions_Array'
  Assets_Loan_Transactions_Input:
    properties:
      fromDate:
        type: string
        description: Date From
        example: "2020-12-30"
      toDate:
        type: string
        description: Date To
        example: "2020-12-30"
      fromRow:
        type: string
      pageSize:
        type: string
    additionalProperties: false
  Assets_Loan_Finance_Details_Output:
    properties:
      LoanId:
        type: string
        description: Unique id of the loan
      AssetNumber:
        type: string
        example: "5011099999999"
      ProductName:
        type: string
        example: DEMAND LOANS -R-
      BlockActionDisabled:
        type: boolean
      Amounts:
        items:
          properties:
            Amount:
              type: string
            Currency:
              type: string
            AmountType:
              type: string
        $ref: '#/definitions/Amount_Array'
      Characteristics:
        items:
          properties:
            Name:
              type: string
            Value:
              type: string
        $ref: '#/definitions/Characteristics_Array'
      Beneficiaries:
        items:
          properties:
            Name:
              type: string
            Address:
              type: string
            Type:
              type: string
            DateTimeLastModified:
              type: string
        $ref: '#/definitions/Beneficiaries_Array'
      BranchName:
        type: string
        example: STADIOU & AMERIKIS
      Address:
        type: string
      BranchCode:
        type: string
        example: "2011"
      BranchAddress:
        type: string
        example: 4, Stadiou st., 105 64 Athens Center Attiki
      AssetAlias:
        type: string
      Balance:
        $ref: '#/definitions/Capital_Definition'
      CanDebit:
        type: boolean
      CanViewStatement:
        type: boolean
      Status:
        type: string
        example: Active
      AssetProductTypeDescription:
        type: string
        example: DEMAND LOANS -R-
      StartDate:
        type: string
      EndDate:
        type: string
      DateTimeLastModified:
        type: string
      LinkedAccount:
        type: string
      ArrangementRelation:
        type: string
      RelationDescription:
        type: string
    additionalProperties: false
  Assets_Loan_Finance_Transactions_Output:
    properties:
      transactions:
        $ref: '#/definitions/FinanceTransactions_Array'
      pagingInfo:
        $ref: '#/definitions/PagingInfo_Definition'
  LoanList_Definition:
    description: ""
    type: object
    properties:
      loanId:
        type: string
        description: Unique id of the loan
      iban:
        type: string
        example: GR4301720110005011099999999
      statusDescription:
        type: string
        example: Ενεργό
      productName:
        type: string
        example: Κεφάλαιο Κίνησης Τακτής Λήξης
      startDate:
        type: string
        format: date-time
      endDate:
        type: string
        format: date-time
      capital:
        properties:
          amount:
            type: number
        $ref: '#/definitions/Capital_Definition'
      productTypeDescription:
        type: string
        example: Κεφάλαιο Κίνησης Τακτής Λήξης
      amounts:
        $ref: '#/definitions/Amount_Array'
      isOpenLoan:
        type: boolean
      loanType:
        type: integer
        format: int32
        example: "1"
      loanRejection:
        items:
          type: object
        $ref: '#/definitions/LoanRejection_Array'
      relationDescription:
        type: string
        example: Debtor
    example: '{"loanId":"WkdWek5Xb3hZekIwY0cweFlYSjNkOXlDWWQ1U2IlMmI1RjR0VEVXVzdRbk93JTNkX2xvYW5fWkdWek5Xb3hZekIwY0cweFlYSjNkMDNZNyUyZlZtSHJMVlFvcE5ycHZrdHo0JTNk","iban":"GR4301720110005011022626108","statusDescription":"Ανενεργό","productName":"Καθυστέρησης/Εξυπηρέτησης
      Ομολογιακών Δανείων","startDate":"2005-03-04 00:00:00.0","endDate":"9999-12-31
      00:00:00.0","capital":{"amount":0},"productTypeDescription":"Καθυστέρησης/Εξυπηρέτησης
      Ομολογιακών Δανείων","amounts":[{"amount":0,"currency":"EUR","amountType":"Διαθέσιμο"},{"amount":0,"currency":"EUR","amountType":"Λογιστικό"}],"isOpenLoan":true,"loanType":0,"loanRejection":[]}'
  LoanList_Array:
    type: array
    items:
      $ref: '#/definitions/LoanList_Definition'
  Amount_Definition:
    properties:
      amount:
        type: number
        format: double
      currency:
        type: string
      amountType:
        type: string
    additionalProperties: false
  Amount_Array:
    type: array
    items:
      $ref: '#/definitions/Amount_Definition'
  Error_Output:
    properties:
      message:
        type: string
    additionalProperties: false
  SessionExpired_Output:
    properties:
      errorCode:
        type: string
        description: ""
        example: API-006
      errorICode:
        type: string
        example: SESSION_EXPIRED
      errorMessage:
        type: string
        example: SessionExpired
    additionalProperties: false
  Capital_Definition:
    properties:
      Amount:
        type: number
        format: double
    additionalProperties: false
  LoanRejection_Array:
    type: array
    items:
      $ref: '#/definitions/LoanRejection_Definition'
  LoanRejection_Definition:
    properties:
      Code:
        type: string
      Description:
        type: string
    additionalProperties: false
  Characteristics_Array:
    type: array
    items:
      $ref: '#/definitions/Characteristics_Definition'
  Characteristics_Definition:
    properties:
      Name:
        type: string
        example: Rate
      Value:
        type: string
        example: 4.13%
    additionalProperties: false
  Asset_Loan_Details_Output:
    properties:
      LoanId:
        type: string
        description: Unique id of the loan
      AssetNumber:
        type: string
        example: "5011099999999"
      IBAN:
        type: string
        example: GR4301720110005011099999999
      StatusDescription:
        type: string
        example: Ανενεργό
      LinkedAccount:
        type: string
      ProductName:
        type: string
        example: Καθυστέρησης/Εξυπηρέτησης Ομολογιακών Δανείων
      ArrangementRelation:
        type: string
        example: D01
      RelationDescription:
        type: string
        example: Beneficiary
      StartDate:
        type: string
        format: date-time
        example: "2005-03-04 00:00:00.0"
      EndDate:
        type: string
        format: date-time
        example: "2015-03-04 00:00:00.0"
      Capital:
        $ref: '#/definitions/Capital_Definition'
      ProductTypeDescription:
        type: string
        example: Καθυστέρησης/Εξυπηρέτησης Ομολογιακών Δανείων
      Address:
        type: string
        example: ΒΑΣΙΛΙΣΣΗΣ ΑΜΑΛΙΑΣ ΛΕΩΦ. 26Α,10557,ΑΘΗΝΑ
      BranchName:
        type: string
        example: STADIOU & AMERIKIS
      Beneficiaries:
        $ref: '#/definitions/Beneficiaries_Array'
      Guarantors:
        $ref: '#/definitions/Guarantors_Array'
      Characteristics:
        $ref: '#/definitions/Characteristics_Array'
      Amounts:
        $ref: '#/definitions/Amount_Array'
      IsOpenLoan:
        type: boolean
      LoanType:
        type: integer
        format: int32
        example: "0"
      LoanRejection:
        $ref: '#/definitions/LoanRejection_Array'
      ConnectedAccount:
        type: string
      Disclaimers:
        type: string
    additionalProperties: false
  Beneficiaries_Array:
    type: array
    items:
      $ref: '#/definitions/Beneficiaries_Definition'
  Beneficiaries_Definition:
    properties:
      Name:
        type: string
        example: ATHANASIOS ATHANASIOU
      Address:
        type: string
      Type:
        type: string
        example: Beneficiary
      DateTimeLastModified:
        type: string
        format: date-time
        example: "2017-10-19 17:17:17.0"
    additionalProperties: false
  Guarantors_Array:
    type: array
    items:
      $ref: '#/definitions/Guarantors_Definition'
  Guarantors_Definition:
    properties:
      Name:
        type: string
      Address:
        type: string
      Type:
        type: string
      DateTimeLastModified:
        type: string
        format: date-time
    additionalProperties: false
  LoanTransactions_Array:
    type: array
    items:
      $ref: '#/definitions/LoanTransactions_Definition'
  LoanTransactions_Definition:
    properties:
      transactionDate:
        type: string
        description: Date of transaction
        example: "2009-10-29 00:00:00.0"
        format: date-time
      valueDate:
        type: string
        format: date-time
        example: "2009-10-29 00:00:00.0"
      description:
        type: string
        example: Ολική Αποπληρωμή
      amount:
        $ref: '#/definitions/Amount_Definition'
      capitalAmount:
        $ref: '#/definitions/Amount_Definition'
      interestAmount:
        $ref: '#/definitions/Amount_Definition'
      withHoldInterestAmount:
        $ref: '#/definitions/Amount_Definition'
      progressiveBalance:
        $ref: '#/definitions/Amount_Definition'
      deferredPaymentInterest:
        $ref: '#/definitions/Amount_Definition'
      narratives:
        type: string
      transactionCode:
        type: string
        example: "970"
      taxType:
        type: integer
        format: int32
        example: "0"
      loanAmount:
        $ref: '#/definitions/Amount_Definition'
      rate:
        type: number
        format: double
      totalInterest:
        $ref: '#/definitions/Amount_Definition'
      taxPaymentDate:
        type: string
        format: date-time
    additionalProperties: false
  FinanceTransactions_Array:
    type: array
    items:
      $ref: '#/definitions/FinanceTransactions_Definition'
  FinanceTransactions_Definition:
    properties:
      uniqueReference:
        type: string
        example: "103"
      transactionId:
        type: string
        example: "103"
      transactionCode:
        type: string
        example: ΣΥΓ101
      transactionType:
        type: string
      postDate:
        type: string
        format: date-time
      valueDate:
        type: string
        format: date-time
      description:
        type: string
        example: ΤΟΚOI
      amount:
        $ref: '#/definitions/Amount_Definition'
      runningBalance:
        $ref: '#/definitions/Amount_Definition'
    additionalProperties: false
  PagingInfo_Definition:
    properties:
      pageSize:
        type: integer
        format: int32
        example: "5"
      rowIndex:
        type: string
        example: "0"
    additionalProperties: false
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
  loanId:
    name: loanId
    type: string
    required: true
    in: path
    description: Id of the loan
x-ibm-endpoints:
- endpointUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production
  description: Base Gateway API Endpoint
  type:
  - production
  - development
...