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

# Create a crypto deposit

> Returns a wallet address for one payment, on the network and token you ask for. When the transfer confirms, the amount (less fees) is added to your balance and you get `transaction.crypto.completed`.

Show your customer the address, the network and the token. Funds sent in another token, or on another network, may not be recoverable.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/merchant/transactions/crypto/initialize
openapi: 3.0.0
info:
  title: Flipeet Pay API
  version: '1.0'
  description: >-
    Accept and send stablecoin and local-currency payments. Authenticate with
    your secret key in the x-api-key header. Keys starting fpay_test_ use the
    sandbox; fpay_live_ moves real money. Guides: https://docs.flipeet.io
  contact:
    name: Flipeet Pay
    url: https://docs.flipeet.io
servers:
  - url: https://api.pay.flipeet.io
security:
  - x-api-key: []
tags:
  - name: Checkout
    description: >-
      Hosted payment pages: create a payment, send your customer to checkoutUrl,
      and get a webhook when they pay.
  - name: Deposits
    description: >-
      Collect stablecoins or local currency straight into your balance, with
      your own UI.
  - name: Balance
    description: What you hold, per asset.
  - name: Withdrawals
    description: Send funds from your balance to a wallet or a bank account.
  - name: Ramps
    description: >-
      Convert between local currency and stablecoins for your own customers,
      settled to their wallet or bank.
  - name: Webhooks
    description: Delivery history, resends and test events.
  - name: Sandbox
    description: 'Test-mode tools: simulate outcomes and add test funds. Sandbox keys only.'
paths:
  /api/v1/merchant/transactions/crypto/initialize:
    post:
      tags:
        - Deposits
      summary: Create a crypto deposit
      description: >-
        Returns a wallet address for one payment, on the network and token you
        ask for. When the transfer confirms, the amount (less fees) is added to
        your balance and you get `transaction.crypto.completed`.


        Show your customer the address, the network and the token. Funds sent in
        another token, or on another network, may not be recoverable.
      operationId: MerchantPaymentController_initializeCryptoTransaction
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitializeCryptoTransactionDto'
            example:
              network: base
              asset: usdc
              amount: 100
              reference: inv_2201
              metadata:
                customerId: cus_77
      responses:
        '201':
          description: Crypto transaction initialized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Crypto transaction initialized
                  status:
                    type: string
                    example: success
                  statusCode:
                    type: number
                    example: 201
                  data:
                    type: object
                    properties:
                      reference:
                        type: string
                        example: inv_2201
                      type:
                        type: string
                        example: crypto
                      network:
                        type: string
                        example: base
                      asset:
                        type: string
                        example: usdc
                      address:
                        type: string
                        example: '0x3c5b0e8d1f6a4b2c9e7d0a1b2c3d4e5f60718293'
                      expectedAmount:
                        type: number
                        example: 100
                      status:
                        type: string
                        example: pending
                      livemode:
                        type: boolean
                        example: true
              example:
                message: Crypto transaction initialized
                status: success
                statusCode: 201
                data:
                  reference: inv_2201
                  type: crypto
                  network: base
                  asset: usdc
                  address: '0x3c5b0e8d1f6a4b2c9e7d0a1b2c3d4e5f60718293'
                  expectedAmount: 100
                  status: pending
                  livemode: true
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '409':
          $ref: '#/components/responses/Error409'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
      security:
        - x-api-key: []
components:
  schemas:
    InitializeCryptoTransactionDto:
      type: object
      properties:
        network:
          type: string
          example: base
          description: The network the customer pays on.
        asset:
          type: string
          example: usdc
          description: The token the customer pays with.
          enum:
            - usdc
            - usdt
        amount:
          type: number
          example: 100
          description: >-
            The amount you expect, in `asset`. What we credit is what actually
            arrives, less fees.
        reference:
          type: string
          example: inv_2201
          description: >-
            Your unique ID for this payment. Sending the same one again returns
            `409`, so retries are safe. Generated if you leave it out.
        callbackUrl:
          type: string
          example: https://shop.example.com/hooks/flipeet
          description: Send this payment's webhooks here instead of your usual webhook URL.
        metadata:
          type: object
          example:
            customerId: cus_77
          description: Your own data, returned as-is in the webhook.
      required:
        - network
        - asset
  responses:
    Error400:
      description: The request is invalid. `details.errors` lists every problem.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: What went wrong, for people. May be reworded.
              status:
                type: string
                example: error
              statusCode:
                type: integer
                description: The HTTP status.
              code:
                type: string
                description: A stable code to branch on.
                enum:
                  - invalid_request
                  - authentication_failed
                  - permission_denied
                  - not_found
                  - conflict
                  - rate_limited
                  - internal_error
                  - provider_error
              details:
                type: object
                nullable: true
                description: For validation errors, `errors` lists every problem.
              requestId:
                type: string
                description: Quote it when you contact us.
              timestamp:
                type: string
                format: date-time
          example:
            message: Amount must be a positive number
            status: error
            statusCode: 400
            code: invalid_request
            details:
              errors:
                - Amount must be a positive number
            requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b
            timestamp: '2026-11-04T10:00:00.000Z'
    Error401:
      description: The API key is missing, mistyped or revoked.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: What went wrong, for people. May be reworded.
              status:
                type: string
                example: error
              statusCode:
                type: integer
                description: The HTTP status.
              code:
                type: string
                description: A stable code to branch on.
                enum:
                  - invalid_request
                  - authentication_failed
                  - permission_denied
                  - not_found
                  - conflict
                  - rate_limited
                  - internal_error
                  - provider_error
              details:
                type: object
                nullable: true
                description: For validation errors, `errors` lists every problem.
              requestId:
                type: string
                description: Quote it when you contact us.
              timestamp:
                type: string
                format: date-time
          example:
            message: Invalid or inactive API key
            status: error
            statusCode: 401
            code: authentication_failed
            details: null
            requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b
            timestamp: '2026-11-04T10:00:00.000Z'
    Error409:
      description: >-
        That reference was used before. Look up the existing one instead of
        creating another.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: What went wrong, for people. May be reworded.
              status:
                type: string
                example: error
              statusCode:
                type: integer
                description: The HTTP status.
              code:
                type: string
                description: A stable code to branch on.
                enum:
                  - invalid_request
                  - authentication_failed
                  - permission_denied
                  - not_found
                  - conflict
                  - rate_limited
                  - internal_error
                  - provider_error
              details:
                type: object
                nullable: true
                description: For validation errors, `errors` lists every problem.
              requestId:
                type: string
                description: Quote it when you contact us.
              timestamp:
                type: string
                format: date-time
          example:
            message: Reference payout_5510 already exists
            status: error
            statusCode: 409
            code: conflict
            details: null
            requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b
            timestamp: '2026-11-04T10:00:00.000Z'
    Error429:
      description: Too many requests. Each key can make 120 a minute.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: What went wrong, for people. May be reworded.
              status:
                type: string
                example: error
              statusCode:
                type: integer
                description: The HTTP status.
              code:
                type: string
                description: A stable code to branch on.
                enum:
                  - invalid_request
                  - authentication_failed
                  - permission_denied
                  - not_found
                  - conflict
                  - rate_limited
                  - internal_error
                  - provider_error
              details:
                type: object
                nullable: true
                description: For validation errors, `errors` lists every problem.
              requestId:
                type: string
                description: Quote it when you contact us.
              timestamp:
                type: string
                format: date-time
          example:
            message: Too many requests. Slow down and try again shortly.
            status: error
            statusCode: 429
            code: rate_limited
            details: null
            requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b
            timestamp: '2026-11-04T10:00:00.000Z'
    Error500:
      description: Something went wrong on our side. Retry with backoff.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: What went wrong, for people. May be reworded.
              status:
                type: string
                example: error
              statusCode:
                type: integer
                description: The HTTP status.
              code:
                type: string
                description: A stable code to branch on.
                enum:
                  - invalid_request
                  - authentication_failed
                  - permission_denied
                  - not_found
                  - conflict
                  - rate_limited
                  - internal_error
                  - provider_error
              details:
                type: object
                nullable: true
                description: For validation errors, `errors` lists every problem.
              requestId:
                type: string
                description: Quote it when you contact us.
              timestamp:
                type: string
                format: date-time
          example:
            message: Internal server error
            status: error
            statusCode: 500
            code: internal_error
            details: null
            requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b
            timestamp: '2026-11-04T10:00:00.000Z'
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your secret key. `fpay_test_…` keys use the sandbox; `fpay_live_…` keys
        move real money.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.