OpenApi.yml

components:
  schemas:
    "": {}
    AcceptAuthenticatedQuoteRequest:
      properties:
        quoteHash:
          description: QuoteHash
          example: "0x0"
          type: string
        signature:
          description: Signature from a trusted account
          example: "0x0"
          type: string
      required:
      - quoteHash
      - signature
      type: object
    AcceptPeginRespose:
      properties:
        bitcoinDepositAddressHash:
          description: Hash of the deposit BTC address
          example: "0x0"
          type: string
        signature:
          description: Signature of the quote
          example: "0x0"
          type: string
      required:
      - signature
      - bitcoinDepositAddressHash
      type: object
    AcceptPegoutResponse:
      properties:
        lbcAddress:
          description: LBC address to execute depositPegout function
          example: "0x0"
          type: string
        signature:
          description: Signature of the quote
          example: "0x0"
          type: string
      required:
      - signature
      - lbcAddress
      type: object
    AcceptQuoteRequest:
      properties:
        quoteHash:
          description: QuoteHash
          example: "0x0"
          type: string
      required:
      - quoteHash
      type: object
    AddCollateralRequest:
      properties:
        amount:
          description: Amount to add to the collateral
          example: "100000000000"
      required:
      - amount
      type: object
    AddCollateralResponse:
      properties:
        newCollateralBalance:
          description: New Collateral Balance
          example: "100000000000"
      type: object
    AvailableLiquidityDTO:
      properties:
        peginLiquidityAmount:
          description: Available liquidity for PegIn operations in wei
          example: "5000000000000000000"
        pegoutLiquidityAmount:
          description: Available liquidity for PegOut operations in wei
          example: "5000000000000000000"
      required:
      - peginLiquidityAmount
      - pegoutLiquidityAmount
      type: object
    ChangeStatusRequest:
      properties:
        status:
          type: boolean
      type: object
    DepositEventDTO:
      properties:
        amount:
          description: Event Value
          example: "10000"
        from:
          description: From Address
          example: "0x0"
          type: string
        quoteHash:
          description: QuoteHash
          example: "0x0"
          type: string
        timestamp:
          description: Event Timestamp
          example: "10000"
          format: date-time
          type: string
      type: object
    GeneralConfigurationDTO:
      properties:
        btcConfirmations:
          properties:
            key:
              type: integer
          type: object
        publicLiquidityCheck:
          type: boolean
        rskConfirmations:
          properties:
            key:
              type: integer
          type: object
      type: object
    GeneralConfigurationRequest:
      properties:
        configuration:
          $ref: '#/components/schemas/GeneralConfigurationDTO'
          type: object
      type: object
    GetCollateralResponse:
      properties:
        collateral:
          $ref: '#/components/schemas/'
      required:
      - collateral
      type: object
    GetPeginQuoteResponse:
      properties:
        quote:
          $ref: '#/components/schemas/PeginQuoteDTO'
          description: Detail of the quote
          type: object
        quoteHash:
          description: This is a 64 digit number that derives from a quote object
          type: string
      required:
      - quote
      - quoteHash
      type: object
    GetPegoutQuoteResponse:
      properties:
        quote:
          $ref: '#/components/schemas/PegoutQuoteDTO'
          description: Detail of the quote
          type: object
        quoteHash:
          description: This is a 64 digit number that derives from a quote object
          type: string
      required:
      - quote
      - quoteHash
      type: object
    GetTransactionsItem:
      properties:
        amount:
          $ref: '#/components/schemas/'
        callFee:
          $ref: '#/components/schemas/'
        gasFee:
          $ref: '#/components/schemas/'
        quoteHash:
          type: string
        status:
          type: string
      type: object
    GetTransactionsResponse:
      properties:
        data:
          items:
            properties:
              amount:
                $ref: '#/components/schemas/'
              callFee:
                $ref: '#/components/schemas/'
              gasFee:
                $ref: '#/components/schemas/'
              quoteHash:
                type: string
              status:
                type: string
            type: object
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationMetadata'
          type: object
      type: object
    HealthResponse:
      properties:
        services:
          description: LPS Services Status
          example:
            btc: ok
            db: ok
            rsk: ok
          type: object
        status:
          description: Overall LPS Health Status
          example: ok
          type: string
      required:
      - status
      - services
      type: object
    LiquidityProvider:
      properties:
        apiBaseUrl:
          description: API base URL
          example: https://api.example.com
          type: string
        id:
          description: Provider Id
          example: 1
          type: integer
        name:
          description: Provider Name
          example: New Provider
          type: string
        provider:
          description: Provider Address
          example: "0x0"
          type: string
        providerType:
          description: Provider type
          example: pegin
          type: string
        status:
          description: Provider status
          example: true
          type: boolean
      required:
      - id
      - provider
      - name
      - apiBaseUrl
      - status
      - providerType
      type: object
    PaginationMetadata:
      properties:
        page:
          type: integer
        perPage:
          type: integer
        total:
          type: integer
        totalPages:
          type: integer
      type: object
    PeginConfigurationDTO:
      properties:
        callTime:
          type: integer
        feePercentage:
          type: number
        fixedFee:
          type: string
        maxValue:
          type: string
        minValue:
          type: string
        penaltyFee:
          type: string
        timeForDeposit:
          type: integer
      type: object
    PeginConfigurationRequest:
      properties:
        configuration:
          $ref: '#/components/schemas/PeginConfigurationDTO'
          type: object
      type: object
    PeginCreationDataDTO:
      properties:
        feePercentage:
          description: The percentage fee used to compute the call fee
          type: number
        fixedFee:
          $ref: '#/components/schemas/'
          description: The fixed fee used to compute the call fee
        gasPrice:
          $ref: '#/components/schemas/'
          description: The gas price used to compute the gas fee
      required:
      - gasPrice
      - feePercentage
      - fixedFee
      type: object
    PeginQuoteDTO:
      properties:
        agreementTimestamp:
          description: The timestamp of the agreement
          type: integer
        btcRefundAddr:
          description: A User BTC refund address
          type: string
        callFee:
          $ref: '#/components/schemas/'
          description: The fee charged by the LP
        callOnRegister:
          description: A boolean value indicating whether the callForUser can be called
            on registerPegIn
          type: boolean
        confirmations:
          description: The number of confirmations that the LP requires before making
            the call
          type: integer
        contractAddr:
          description: The destination address of the peg-in
          type: string
        data:
          description: The arguments to send in the call
          type: string
        fedBTCAddr:
          description: The BTC address of the PowPeg
          type: string
        gasFee:
          $ref: '#/components/schemas/'
          description: Fee to pay for the gas of every call done during the pegin
            (call on behalf of the user and call to the dao fee collector)
        gasLimit:
          description: The gas limit
          type: integer
        lbcAddr:
          description: The address of the LBC
          type: string
        lpBTCAddr:
          description: The BTC address of the LP
          type: string
        lpCallTime:
          description: The time (in seconds) that the LP has to perform the call on
            behalf of the user after the deposit achieves the number of confirmations
          type: integer
        lpRSKAddr:
          description: The RSK address of the LP
          type: string
        nonce:
          description: A nonce that uniquely identifies this quote
          type: integer
        penaltyFee:
          $ref: '#/components/schemas/'
          description: The penalty fee that the LP pays if it fails to deliver the
            service
        productFeeAmount:
          $ref: '#/components/schemas/'
          description: The DAO Fee amount
        rskRefundAddr:
          description: A User RSK refund address
          type: string
        timeForDeposit:
          description: The time (in seconds) that the user has to achieve one confirmation
            on the BTC deposit
          type: integer
        value:
          $ref: '#/components/schemas/'
          description: The value to transfer in the call
      required:
      - fedBTCAddr
      - lbcAddr
      - lpRSKAddr
      - btcRefundAddr
      - rskRefundAddr
      - lpBTCAddr
      - callFee
      - penaltyFee
      - contractAddr
      - data
      - gasLimit
      - nonce
      - value
      - agreementTimestamp
      - timeForDeposit
      - lpCallTime
      - confirmations
      - callOnRegister
      - gasFee
      - productFeeAmount
      type: object
    PeginQuoteRequest:
      properties:
        callContractArguments:
          description: Contract data
          example: "0x0"
          type: string
        callEoaOrContractAddress:
          description: Contract address or EOA address
          example: "0x0"
          type: string
        rskRefundAddress:
          description: User RSK refund address
          example: "0x0"
          type: string
        valueToTransfer:
          description: Value to send in the call
          example: "0x0"
      required:
      - callEoaOrContractAddress
      - callContractArguments
      - valueToTransfer
      - rskRefundAddress
      type: object
    PeginQuoteStatusDTO:
      properties:
        creationData:
          $ref: '#/components/schemas/PeginCreationDataDTO'
          description: Values used to compute some fields of the quote
          type: object
        detail:
          $ref: '#/components/schemas/PeginQuoteDTO'
          description: Agreed specification of the quote
          type: object
        status:
          $ref: '#/components/schemas/RetainedPeginQuoteDTO'
          description: Current status of the quote
          type: object
      required:
      - detail
      - status
      - creationData
      type: object
    PegoutConfigurationDTO:
      properties:
        bridgeTransactionMin:
          type: string
        expireBlocks:
          type: integer
        expireTime:
          type: integer
        feePercentage:
          type: number
        fixedFee:
          type: string
        maxValue:
          type: string
        minValue:
          type: string
        penaltyFee:
          type: string
        timeForDeposit:
          type: integer
      type: object
    PegoutConfigurationRequest:
      properties:
        configuration:
          $ref: '#/components/schemas/PegoutConfigurationDTO'
          type: object
      type: object
    PegoutCreationDataDTO:
      properties:
        feePercentage:
          description: The percentage fee used to compute the call fee
          type: number
        feeRate:
          description: The fee rate used to compute the gas fee
          type: number
        fixedFee:
          $ref: '#/components/schemas/'
          description: The fixed fee used to compute the call fee
        gasPrice:
          $ref: '#/components/schemas/'
          description: The gas price used to compute the gas fee
      required:
      - gasPrice
      - feePercentage
      - fixedFee
      - feeRate
      type: object
    PegoutQuoteDTO:
      properties:
        agreementTimestamp:
          type: integer
        btcRefundAddress:
          type: string
        callFee:
          $ref: '#/components/schemas/'
        depositAddr:
          type: string
        depositConfirmations:
          type: integer
        depositDateLimit:
          type: integer
        expireBlocks:
          type: integer
        expireDate:
          type: integer
        gasFee:
          $ref: '#/components/schemas/'
          description: Fee to pay for the gas of every call done during the pegout
            (call on behalf of the user in Bitcoin network and call to the dao fee
            collector in Rootstock)
        lbcAddress:
          type: string
        liquidityProviderRskAddress:
          type: string
        lpBtcAddr:
          type: string
        nonce:
          type: integer
        penaltyFee:
          $ref: '#/components/schemas/'
        productFeeAmount:
          $ref: '#/components/schemas/'
          description: The DAO fee amount
        rskRefundAddress:
          type: string
        transferConfirmations:
          type: integer
        transferTime:
          type: integer
        value:
          $ref: '#/components/schemas/'
      required:
      - lbcAddress
      - liquidityProviderRskAddress
      - btcRefundAddress
      - rskRefundAddress
      - lpBtcAddr
      - callFee
      - penaltyFee
      - nonce
      - depositAddr
      - value
      - agreementTimestamp
      - depositDateLimit
      - depositConfirmations
      - transferConfirmations
      - transferTime
      - expireDate
      - expireBlocks
      - gasFee
      - productFeeAmount
      type: object
    PegoutQuoteRequest:
      properties:
        rskRefundAddress:
          description: RskRefundAddress
          example: "0x0"
          type: string
        to:
          description: Bitcoin address that will receive the BTC amount
          type: string
        valueToTransfer:
          description: ValueToTransfer
          example: "10000000000000"
      required:
      - to
      - valueToTransfer
      - rskRefundAddress
      type: object
    PegoutQuoteStatusDTO:
      properties:
        creationData:
          $ref: '#/components/schemas/PegoutCreationDataDTO'
          description: Values used to compute some fields of the quote
          type: object
        detail:
          $ref: '#/components/schemas/PegoutQuoteDTO'
          description: Agreed specification of the quote
          type: object
        status:
          $ref: '#/components/schemas/RetainedPegoutQuoteDTO'
          description: Current status of the quote
          type: object
      required:
      - detail
      - status
      - creationData
      type: object
    ProviderDetail:
      properties:
        fee:
          deprecated: true
          $ref: '#/components/schemas/'
        feePercentage:
          type: number
        fixedFee:
          $ref: '#/components/schemas/'
        maxTransactionValue:
          $ref: '#/components/schemas/'
        minTransactionValue:
          $ref: '#/components/schemas/'
        requiredConfirmations:
          type: integer
      required:
      - fee
      - fixedFee
      - feePercentage
      - minTransactionValue
      - maxTransactionValue
      - requiredConfirmations
      type: object
    ProviderDetailResponse:
      properties:
        liquidityCheckEnabled:
          type: boolean
        pegin:
          $ref: '#/components/schemas/ProviderDetail'
          type: object
        pegout:
          $ref: '#/components/schemas/ProviderDetail'
          type: object
        siteKey:
          type: string
      required:
      - siteKey
      - liquidityCheckEnabled
      - pegin
      - pegout
      type: object
    RecommendedOperationDTO:
      properties:
        estimatedCallFee:
          description: Estimated call fee if a quote is created with the recommended
            amount
          example: "100000"
        estimatedGasFee:
          description: Estimated gas fee if a quote is created with the recommended
            amount
          example: "100000"
        estimatedProductFee:
          description: Estimated product fee if a quote is created with the recommended
            amount
          example: "100000"
        recommendedQuoteValue:
          description: Recommended quote value for the input amount
          example: "100000"
      required:
      - recommendedQuoteValue
      - estimatedCallFee
      - estimatedGasFee
      - estimatedProductFee
      type: object
    RetainedPeginQuoteDTO:
      properties:
        callForUserTxHash:
          description: The hash of the RSK transaction to the address requested by
            the user
          type: string
        depositAddress:
          description: BTC derivation address where the user should send the BTC
          type: string
        quoteHash:
          description: 32-byte long hash of the quote that acts as a unique identifier
          type: string
        registerPeginTxHash:
          description: The hash of the RSK transaction where the LP gets his refund
            and fee
          type: string
        requiredLiquidity:
          $ref: '#/components/schemas/'
          description: RBTC liquidity that the LP locks to guarantee the service.
            It is different from the total amount that the user needs to pay.
        signature:
          description: Signature of the liquidity provider expressing commitment on
            the quote
          type: string
        state:
          description: |-
            Current state of the quote. Possible values are:
             - WaitingForDeposit
             - WaitingForDepositConfirmations
             - TimeForDepositElapsed
             - CallForUserSucceeded
             - CallForUserFailed
             - RegisterPegInSucceeded
             - RegisterPegInFailed
          type: string
        userBtcTxHash:
          description: The hash of the user's BTC transaction to the derivation address
          type: string
      required:
      - quoteHash
      - signature
      - depositAddress
      - requiredLiquidity
      - state
      - userBtcTxHash
      - callForUserTxHash
      - registerPeginTxHash
      type: object
    RetainedPegoutQuoteDTO:
      properties:
        bridgeRefundTxHash:
          description: The hash of the transaction from the LP to the bridge to convert
            the refunded RBTC into BTC
          type: string
        depositAddress:
          description: Address of the smart contract where the user should execute
            depositPegout function
          type: string
        lpBtcTxHash:
          description: The hash of the BTC transaction from the LP to the user
          type: string
        quoteHash:
          description: 32-byte long hash of the quote that acts as a unique identifier
          type: string
        refundPegoutTxHash:
          description: The hash of the transaction from the LP to the LBC where the
            LP got the refund in RBTC
          type: string
        requiredLiquidity:
          $ref: '#/components/schemas/'
          description: BTC liquidity that the LP locks to guarantee the service. It
            is different from the total amount that the user needs to pay.
        signature:
          description: Signature of the liquidity provider expressing commitment on
            the quote
          type: string
        state:
          description: |
            Current state of the quote. Possible values are:
             - WaitingForDeposit
             - WaitingForDepositConfirmations
             - TimeForDepositElapsed
             - SendPegoutSucceeded
             - SendPegoutFailed
             - RefundPegOutSucceeded
             - RefundPegOutFailed
             - BridgeTxSucceeded
             - BridgeTxFailed
          type: string
        userRskTxHash:
          description: The hash of the depositPegout transaction made by the user
          type: string
      required:
      - quoteHash
      - signature
      - depositAddress
      - requiredLiquidity
      - state
      - userRskTxHash
      - lpBtcTxHash
      - refundPegoutTxHash
      - bridgeRefundTxHash
      type: object
    ServerInfoDTO:
      properties:
        revision:
          description: Version commit hash
          example: b7bf393a2b1cedde8ee15b00780f44e6e5d2ba9d
          type: string
        version:
          description: Server version tag
          example: v1.0.0
          type: string
      required:
      - version
      - revision
      type: object
    Services:
      properties:
        btc:
          type: string
        db:
          type: string
        rsk:
          type: string
      type: object
    SummaryDataDTO:
      properties:
        acceptedQuotesCount:
          type: integer
        lpEarnings:
          $ref: '#/components/schemas/'
        paidQuotesAmount:
          $ref: '#/components/schemas/'
        paidQuotesCount:
          type: integer
        refundedQuotesCount:
          type: integer
        totalAcceptedQuotedAmount:
          $ref: '#/components/schemas/'
        totalFeesCollected:
          $ref: '#/components/schemas/'
        totalPenaltyAmount:
          $ref: '#/components/schemas/'
        totalQuotesCount:
          type: integer
      type: object
    SummaryResultDTO:
      properties:
        peginSummary:
          $ref: '#/components/schemas/SummaryDataDTO'
          type: object
        pegoutSummary:
          $ref: '#/components/schemas/SummaryDataDTO'
          type: object
      type: object
    TrustedAccountRequest:
      properties:
        address:
          type: string
        btcLockingCap:
          $ref: '#/components/schemas/'
        name:
          type: string
        rbtcLockingCap:
          $ref: '#/components/schemas/'
      type: object
    pkg.AcceptAuthenticatedQuoteRequest:
      properties:
        quoteHash:
          description: QuoteHash
          example: "0x0"
          type: string
        signature:
          description: Signature from a trusted account
          example: "0x0"
          type: string
      required:
      - quoteHash
      - signature
      type: object
    pkg.AcceptPeginRespose:
      properties:
        bitcoinDepositAddressHash:
          description: Hash of the deposit BTC address
          example: "0x0"
          type: string
        signature:
          description: Signature of the quote
          example: "0x0"
          type: string
      required:
      - signature
      - bitcoinDepositAddressHash
      type: object
    pkg.AcceptPegoutResponse:
      properties:
        lbcAddress:
          description: LBC address to execute depositPegout function
          example: "0x0"
          type: string
        signature:
          description: Signature of the quote
          example: "0x0"
          type: string
      required:
      - signature
      - lbcAddress
      type: object
    pkg.AcceptQuoteRequest:
      properties:
        quoteHash:
          description: QuoteHash
          example: "0x0"
          type: string
      required:
      - quoteHash
      type: object
    pkg.AddCollateralRequest:
      properties:
        amount:
          description: Amount to add to the collateral
          example: "100000000000"
      required:
      - amount
      type: object
    pkg.AddCollateralResponse:
      properties:
        newCollateralBalance:
          description: New Collateral Balance
          example: "100000000000"
      type: object
    pkg.GetCollateralResponse:
      properties:
        collateral:
          $ref: '#/components/schemas/'
      required:
      - collateral
      type: object
    pkg.RecommendedOperationDTO:
      properties:
        estimatedCallFee:
          description: Estimated call fee if a quote is created with the recommended
            amount
          example: "100000"
        estimatedGasFee:
          description: Estimated gas fee if a quote is created with the recommended
            amount
          example: "100000"
        estimatedProductFee:
          description: Estimated product fee if a quote is created with the recommended
            amount
          example: "100000"
        recommendedQuoteValue:
          description: Recommended quote value for the input amount
          example: "100000"
      required:
      - recommendedQuoteValue
      - estimatedCallFee
      - estimatedGasFee
      - estimatedProductFee
      type: object
    pkg.TrustedAccountRequest:
      properties:
        address:
          type: string
        btcLockingCap:
          $ref: '#/components/schemas/'
        name:
          type: string
        rbtcLockingCap:
          $ref: '#/components/schemas/'
      type: object
info:
  title: Liquidity Provider Server
  version: 1.2.1
openapi: 3.0.0
paths:
  /configuration:
    get:
      description: ' Get all the configurations for the liquidity provider. Included
        in the management API.'
      responses:
        "200":
          description: ""
      summary: Get configurations
    post:
      description: ' Set general configurations of the server. Included in the management
        API.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeneralConfigurationRequest'
        required: true
      responses:
        "204":
          description: ""
      summary: Set General Config
  /getProviders:
    get:
      description: ' Returns a list of providers.'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiquidityProvider'
          description: ""
      summary: Get Providers
  /health:
    get:
      description: ' Returns server health.'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
          description: ""
      summary: Health
  /management:
    get:
      description: ' Serves the static site for the Management UI'
      responses:
        "200":
          description: ""
      summary: Management Interface
  /management/credentials:
    post:
      description: ' Set new credentials to log into the Management API'
      responses:
        "200":
          description: ""
      summary: Set Login Credentials
  /management/login:
    post:
      description: ' Authenticate to start a Management API session'
      responses:
        "200":
          description: ""
      summary: Management Login
  /management/logout:
    post:
      description: ' Logout from the Management API session'
      responses:
        "204":
          description: ""
      summary: Management Logout
  /management/trusted-accounts:
    delete:
      description: ' Deletes a trusted account'
      parameters:
      - description: Address of the trusted account to delete
        in: query
        name: address
        required: true
        schema:
          description: Address of the trusted account to delete
          format: string
          type: string
      responses:
        "204":
          description: ""
      summary: Delete Trusted Account
    get:
      description: ' Returns all trusted accounts'
      responses:
        "200":
          description: ""
      summary: Get Trusted Accounts
    post:
      description: ' Adds a new trusted account'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedAccountRequest'
        required: true
      responses:
        "204":
          description: ""
      summary: Add Trusted Account
    put:
      description: ' Updates an existing trusted account'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedAccountRequest'
        required: true
      responses:
        "204":
          description: ""
      summary: Update Trusted Account
  /pegin/acceptAuthenticatedQuote:
    post:
      description: ' Accepts Quote with trusted account signature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptAuthenticatedQuoteRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptPeginRespose'
          description: ""
      summary: Accept authenticated quote
  /pegin/acceptQuote:
    post:
      description: ' Accepts Quote'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptQuoteRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptPeginRespose'
          description: ""
      summary: Accept Quote
  /pegin/addCollateral:
    post:
      description: ' Adds PegIn Collateral'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCollateralRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddCollateralResponse'
          description: ""
      summary: Add PegIn Collateral
  /pegin/collateral:
    get:
      description: ' Get PegIn Collateral'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollateralResponse'
          description: ""
      summary: Get PegIn Collateral
  /pegin/configuration:
    post:
      description: ' Set the configuration for the Pegin service. Included in the
        management API.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PeginConfigurationRequest'
        required: true
      responses:
        "204":
          description: ""
      summary: Set Pegin Config
  /pegin/getQuote:
    post:
      description: ' Gets Pegin Quote'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PeginQuoteRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPeginQuoteResponse'
          description: ""
      summary: Pegin GetQuote
  /pegin/recommended:
    get:
      description: ' Returns the recommended quote value to create a quote whose total
        payment is the input amount'
      parameters:
      - description: Amount in wei expected to use as total payment for the quote
        in: query
        name: amount
        required: true
        schema:
          description: Amount in wei expected to use as total payment for the quote
          format: string
          type: string
      - description: Destination address for the pegin. Is optional, but if provided,
          it will increase the estimation accuracy.
        in: query
        name: destination_address
        schema:
          description: Destination address for the pegin. Is optional, but if provided,
            it will increase the estimation accuracy.
          format: string
          type: string
      - description: Hex-encoded data payload to include in the pegin transaction.
          Is optional, but if provided, it will increase the estimation accuracy.
        in: query
        name: data
        schema:
          description: Hex-encoded data payload to include in the pegin transaction.
            Is optional, but if provided, it will increase the estimation accuracy.
          format: string
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendedOperationDTO'
          description: Recommended operation object
      summary: Recommended pegin
  /pegin/status:
    get:
      description: ' Returns the status of an accepted pegin quote'
      parameters:
      - description: Hash of the quote
        in: query
        name: quoteHash
        required: true
        schema:
          description: Hash of the quote
          format: string
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PeginQuoteStatusDTO'
          description: Object containing the quote itself and its status
      summary: GetPeginStatus
  /pegout/acceptAuthenticatedQuote:
    post:
      description: ' Accepts Quote with trusted account signature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptAuthenticatedQuoteRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptPegoutResponse'
          description: ""
      summary: Accept authenticated quote
  /pegout/acceptQuote:
    post:
      description: ' Accepts Quote Pegout'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptQuoteRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptPegoutResponse'
          description: ""
      summary: Accept Quote Pegout
  /pegout/addCollateral:
    post:
      description: ' Adds PegOut Collateral'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCollateralRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddCollateralResponse'
          description: ""
      summary: Add PegOut Collateral
  /pegout/collateral:
    get:
      description: ' Get PegOut Collateral'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollateralResponse'
          description: ""
      summary: Get PegOut Collateral
  /pegout/configuration:
    post:
      description: ' Set the configuration for the Pegout service. Included in the
        management API.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PegoutConfigurationRequest'
        required: true
      responses:
        "204":
          description: ""
      summary: Set Pegout Config
  /pegout/getQuotes:
    post:
      description: ' Gets Pegout Quote'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PegoutQuoteRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPegoutQuoteResponse'
          description: ""
      summary: Pegout GetQuote
  /pegout/recommended:
    get:
      description: ' Returns the recommended quote value to create a quote whose total
        payment is the input amount'
      parameters:
      - description: Amount in wei expected to use as total payment for the quote
        in: query
        name: amount
        required: true
        schema:
          description: Amount in wei expected to use as total payment for the quote
          format: string
          type: string
      - description: 'Destination address type for the pegout. Is optional, but if
          provided, it will  increase the estimation accuracy. Must be one of: p2pkh,
          p2sh, p2wpkh, p2wsh, p2tr'
        in: query
        name: destination_type
        schema:
          description: 'Destination address type for the pegout. Is optional, but
            if provided, it will  increase the estimation accuracy. Must be one of:
            p2pkh, p2sh, p2wpkh, p2wsh, p2tr'
          format: string
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendedOperationDTO'
          description: Recommended operation object
      summary: Recommended pegout
  /pegout/status:
    get:
      description: ' Returns the status of an accepted pegout quote'
      parameters:
      - description: Hash of the quote
        in: query
        name: quoteHash
        required: true
        schema:
          description: Hash of the quote
          format: string
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PegoutQuoteStatusDTO'
          description: Object containing the quote itself and its status
      summary: GetPegoutStatus
  /providers/changeStatus:
    post:
      description: ' Changes the status of the provider'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeStatusRequest'
        required: true
      responses:
        "204":
          description: ""
      summary: Change Provider Status
  /providers/details:
    get:
      description: ' Returns the details of the provider that manages this instance
        of LPS'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderDetailResponse'
          description: Detail of the provider that manges this instance
      summary: Provider detail
  /providers/liquidity:
    get:
      description: ' Fetches the available liquidity for both PegIn and PegOut operations.'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableLiquidityDTO'
          description: ""
      summary: Fetch Available Liquidity
  /providers/resignation:
    post:
      description: ' Provider stops being a liquidity provider'
      responses:
        "204":
          description: ""
      summary: Provider resignation
  /providers/withdrawCollateral:
    post:
      description: ' Withdraw PegIn collateral of a resigned LP'
      responses:
        "204":
          description: ""
      summary: Withdraw PegIn Collateral
  /reports/assets:
    get:
      description: ' Get the asset information for the LPS.'
      responses:
        "200":
          description: ""
      summary: Get asset Reports
  /reports/pegin:
    get:
      description: ' Get the last pegins on the API. Included in the management API.'
      parameters:
      - description: Start date for the report. Supports YYYY-MM-DD (expands to full
          day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
        in: query
        name: startDate
        required: true
        schema:
          description: Start date for the report. Supports YYYY-MM-DD (expands to
            full day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
          format: string
          type: string
      - description: End date for the report. Supports YYYY-MM-DD (expands to end
          of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
        in: query
        name: endDate
        required: true
        schema:
          description: End date for the report. Supports YYYY-MM-DD (expands to end
            of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
          format: string
          type: string
      responses:
        "200":
          description: ""
      summary: Get Pegin Reports
  /reports/pegout:
    get:
      description: ' Get the last pegouts on the API. Included in the management API.'
      parameters:
      - description: Start date for the report. Supports YYYY-MM-DD (expands to full
          day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
        in: query
        name: startDate
        required: true
        schema:
          description: Start date for the report. Supports YYYY-MM-DD (expands to
            full day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
          format: string
          type: string
      - description: End date for the report. Supports YYYY-MM-DD (expands to end
          of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
        in: query
        name: endDate
        required: true
        schema:
          description: End date for the report. Supports YYYY-MM-DD (expands to end
            of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
          format: string
          type: string
      responses:
        "200":
          description: ""
      summary: Get Pegout Reports
  /reports/revenue:
    get:
      description: ' Get the revenue for the specified period.'
      parameters:
      - description: Start date for the report. Supports YYYY-MM-DD (expands to full
          day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
        in: query
        name: startDate
        required: true
        schema:
          description: Start date for the report. Supports YYYY-MM-DD (expands to
            full day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
          format: string
          type: string
      - description: End date for the report. Supports YYYY-MM-DD (expands to end
          of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
        in: query
        name: endDate
        required: true
        schema:
          description: End date for the report. Supports YYYY-MM-DD (expands to end
            of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
          format: string
          type: string
      responses:
        "200":
          description: ""
      summary: Get revenue Reports
  /reports/summaries:
    get:
      description: ' Returns financial data for a given period'
      parameters:
      - description: Start date in YYYY-MM-DD format
        in: query
        name: startDate
        required: true
        schema:
          description: Start date in YYYY-MM-DD format
          format: string
          type: string
      - description: End date in YYYY-MM-DD format
        in: query
        name: endDate
        required: true
        schema:
          description: End date in YYYY-MM-DD format
          format: string
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SummaryResultDTO'
          description: Financial data for the given period
      summary: Summaries
  /reports/transactions:
    get:
      description: ' Get a paginated list of individual transactions of a specific
        type processed by the liquidity provider within a specified time period'
      parameters:
      - description: 'Transaction type filter: ''pegin'' or ''pegout'''
        in: query
        name: type
        required: true
        schema:
          description: 'Transaction type filter: ''pegin'' or ''pegout'''
          format: string
          type: string
      - description: Start date for the report. Supports YYYY-MM-DD (expands to full
          day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
        in: query
        name: startDate
        schema:
          description: Start date for the report. Supports YYYY-MM-DD (expands to
            full day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
          format: string
          type: string
      - description: End date for the report. Supports YYYY-MM-DD (expands to end
          of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
        in: query
        name: endDate
        schema:
          description: End date for the report. Supports YYYY-MM-DD (expands to end
            of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
          format: string
          type: string
      - description: 'Page number to retrieve (1-indexed, default: 1)'
        in: query
        name: page
        schema:
          description: 'Page number to retrieve (1-indexed, default: 1)'
          format: int64
          type: integer
      - description: 'Number of transactions per page (max: 100, default: 10)'
        in: query
        name: perPage
        schema:
          description: 'Number of transactions per page (max: 100, default: 10)'
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTransactionsResponse'
          description: Paginated list of transactions with metadata
      summary: Get Transaction Reports
  /userQuotes:
    get:
      description: ' Returns user quotes for address.'
      parameters:
      - description: User Quote Request Details
        in: query
        name: address
        required: true
        schema:
          description: User Quote Request Details
          format: string
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositEventDTO'
          description: Successfully retrieved the user quotes
      summary: GetUserQuotes
  /version:
    get:
      description: ' Returns the server version and revision'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerInfoDTO'
          description: ""
      summary: Get server version
servers:
- description: ' Testnet'
  url: https://lps.testnet.flyover.rif.technology
- description: ' Mainnet'
  url: https://lps.flyover.rif.technology