> ## Documentation Index
> Fetch the complete documentation index at: https://docs.machines.cash/llms.txt
> Use this file to discover all available pages before exploring further.

# Estimate deposit receive amount

> Returns estimated collateral receive amount and routing details for a specific `{ currency, network, amount }` input.



## OpenAPI

````yaml openapi.yaml post /partner/v1/deposits/estimate
openapi: 3.1.0
info:
  title: Machines Cash API
  version: 0.3.0
  description: >
    API for KYC, cards, encryption, balances, deposits, transactions, and
    withdrawals.

    All responses use a consistent envelope by default: { ok, data, summary,
    errors[], next }.

    Set X-Open-Responses: 1 to receive Open Responses-style response objects.
servers:
  - url: https://api.machines.cash
    description: production
  - url: https://dev-api.machines.cash
    description: sandbox
security: []
tags:
  - name: users
  - name: sessions
  - name: kyc
  - name: kycValues
  - name: agreements
  - name: cards
  - name: encryption
  - name: balances
  - name: deposits
  - name: transactions
  - name: withdrawals
paths:
  /partner/v1/deposits/estimate:
    parameters:
      - $ref: '#/components/parameters/OpenResponses'
      - $ref: '#/components/parameters/OpenResponsesCallId'
    post:
      tags:
        - deposits
      summary: Estimate deposit receive amount
      description: >-
        Returns estimated collateral receive amount and routing details for a
        specific `{ currency, network, amount }` input.
      operationId: api.deposits.estimate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepositEstimateRequest'
      responses:
        '200':
          description: Deposit estimate
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositEstimateResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - Session: []
components:
  parameters:
    OpenResponses:
      name: X-Open-Responses
      in: header
      required: false
      schema:
        type: string
        enum:
          - '1'
          - 'true'
      description: >-
        Return Open Responses-compatible output when set (replaces the default
        response envelope).
    OpenResponsesCallId:
      name: X-Open-Responses-Call-Id
      in: header
      required: false
      schema:
        type: string
        minLength: 1
      description: >-
        Tool call id used for function_call_output items when Open Responses
        mode is enabled.
  schemas:
    DepositEstimateRequest:
      type: object
      additionalProperties: false
      required:
        - currency
        - network
        - amount
      properties:
        currency:
          type: string
          description: Token ticker from `GET /partner/v1/deposits/assets`.
          example: hbar
        network:
          type: string
          description: Network id from `GET /partner/v1/deposits/assets`.
          example: hbar
        amount:
          type: number
          exclusiveMinimum: 0
        amountCurrency:
          type: string
          enum:
            - crypto
            - usd
          description: Quote input amount mode. Defaults to `crypto`.
    DepositEstimateResponse:
      type: object
      additionalProperties: false
      required:
        - ok
        - data
        - summary
        - errors
      properties:
        ok:
          type: boolean
          const: true
        data:
          type: object
          additionalProperties: false
          required:
            - estimate
          properties:
            estimate:
              $ref: '#/components/schemas/DepositEstimate'
        summary:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
        next:
          $ref: '#/components/schemas/NextHint'
    DepositEstimate:
      type: object
      additionalProperties: false
      required:
        - fromCurrency
        - fromNetwork
        - toCurrency
        - toNetwork
        - contractId
        - payoutAddress
        - payoutChainId
        - quotedAmount
        - quotedAmountCurrency
        - estimatedToAmount
        - minAmount
        - maxAmount
        - rateId
      properties:
        fromCurrency:
          type: string
        fromNetwork:
          type: string
        toCurrency:
          type: string
        toNetwork:
          type: string
        contractId:
          type: string
        payoutAddress:
          type: string
        payoutChainId:
          type:
            - integer
            - 'null'
        quotedAmount:
          type: number
        quotedAmountCurrency:
          type: string
          enum:
            - crypto
            - usd
        estimatedToAmount:
          type:
            - number
            - 'null'
        minAmount:
          type:
            - number
            - 'null'
        maxAmount:
          type:
            - number
            - 'null'
        rateId:
          type:
            - string
            - 'null'
    ErrorDetail:
      type: object
      additionalProperties: false
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: invalid_request
        message:
          type: string
          example: missing required field
        field:
          type: string
          description: Optional field name that caused the error.
    NextHint:
      type: object
      additionalProperties: false
      properties:
        pollAfterMs:
          type: integer
          minimum: 0
        suggestedTool:
          type: string
        suggestedArgs:
          type: object
          additionalProperties: true
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - ok
        - summary
        - errors
      properties:
        ok:
          type: boolean
          const: false
        summary:
          type: string
          example: invalid request
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
        next:
          $ref: '#/components/schemas/NextHint'
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServiceUnavailable:
      description: Service unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    Session:
      type: http
      scheme: bearer
      bearerFormat: JWT

````