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

# Ask the user to approve a transfer, without spending funds.



## OpenAPI

````yaml /openapi.json post /api/v1/apps/transfer/request
openapi: 3.1.0
info:
  title: HEVN API
  description: Backend API for HEVN mobile neobank
  version: 0.1.2
servers: []
security: []
paths:
  /api/v1/apps/transfer/request:
    post:
      tags:
        - apps
        - apps-transfer
      summary: Ask the user to approve a transfer, without spending funds.
      operationId: request_transfer_api_v1_apps_transfer_request_post
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Idempotency-Key
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferTargetContext'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferRequestResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    TransferTargetContext:
      properties:
        contactId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Contactid
        quoteId:
          anyOf:
            - type: string
            - type: 'null'
          title: Quoteid
        invoiceId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Invoiceid
        amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Amount
        memo:
          anyOf:
            - type: string
            - type: 'null'
          title: Memo
      type: object
      title: TransferTargetContext
      description: >-
        What is being sent, and to whom.


        Exactly one of ``contactId`` / ``quoteId`` / ``invoiceId`` must be set

        (mirrors the /mcp/transfer body). ``amount`` is required when
        ``contactId``

        is the dispatch path; otherwise it is derived from the referenced
        invoice

        or quote.
    TransferRequestResponse:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        status:
          anyOf:
            - $ref: '#/components/schemas/TransferRequestStatus'
            - type: 'null'
        txHash:
          anyOf:
            - type: string
            - type: 'null'
          title: Txhash
        transactionId:
          anyOf:
            - type: string
            - type: 'null'
          title: Transactionid
        accountId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Accountid
        appId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Appid
        requestedByUserId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Requestedbyuserid
        contactId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Contactid
        quoteId:
          anyOf:
            - type: string
            - type: 'null'
          title: Quoteid
        invoiceId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Invoiceid
        amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Amount
        memo:
          anyOf:
            - type: string
            - type: 'null'
          title: Memo
        requestedTime:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Requestedtime
        chatId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Chatid
        approvalUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Approvalurl
      type: object
      title: TransferRequestResponse
      description: >-
        One outcome shape for both ways a transfer attempt can end.


        Spent straight away: ``txHash`` only. Needs approval: the request that
        was

        filed, with the deep link to approve it. ``transactionId`` appears once
        an

        approved transfer has been reported back. A decline reason is not a
        field —

        it is a message in ``chatId``, the request's thread.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TransferRequestStatus:
      type: string
      enum:
        - requested
        - approved
        - declined
        - failed
      title: TransferRequestStatus
      description: >-
        Client-facing status of a ``transfer_request`` proposal.


        The record is a proposal (seven statuses); this is the short vocabulary
        the

        API keeps for the agent and the web app, mapped from `ProposalStatus` by

        :meth:`from_proposal`.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````