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

# Initiate onramp

> Triggers an onramp to the specified recipient blockchain address, returns the bank deposit instructions



## OpenAPI

````yaml post /v1/users/{user_id}/fiat/onramp
openapi: 3.1.0
info:
  version: 0.0.1
  title: Privy API
  description: >-
    REST API for Privy's wallet infrastructure — provision and manage wallets
    across EVM, Solana, and Bitcoin, authenticate users, sign transactions, and
    configure programmable policies and authorization intents.
  contact:
    name: Privy
    url: https://www.privy.io/
    email: support@privy.io
servers:
  - url: https://api.privy.io
security: []
tags:
  - name: Accounts
    description: Operations related to asset accounts
  - name: Aggregations
    description: Operations related to aggregations for tracking and measuring metrics
  - name: Apps
    description: Operations related to app settings and allowlist management
  - name: Client Auth
    description: OAuth token exchange and device authorization operations
  - name: Condition Sets
    description: Operations related to condition sets
  - name: Embedded wallets
    description: Operations related to embedded wallet creation and authentication
  - name: Fiat
    description: Operations related to fiat onramping and offramping
  - name: Intents
    description: Operations related to authorization intents for wallet actions
  - name: Key quorums
    description: Operations related to key quorums
  - name: Kraken Embed
    description: >-
      Operations for Kraken Embed integration, including quotes, trades, user
      management, and portfolio operations
  - name: OAuth
    description: >-
      OAuth 2.0 endpoints including Device Authorization Grant (RFC 8628) for
      CLI and limited-input device login flows
  - name: Organizations
    description: Operations related to organization secret management
  - name: Policies
    description: Operations related to policies
  - name: Shared
    description: Common schemas shared across resources
  - name: Swaps
    description: Operations for swapping tokens within wallets
  - name: Transactions
    description: Operations related to transactions
  - name: User signers
    description: Operations related to user signers
  - name: Users
    description: Operations related to users
  - name: Wallet Actions
    description: Operations related to wallet actions
  - name: Wallets
    description: Operations related to wallets
  - name: Webhooks
    description: >-
      Webhook events that Privy sends to your configured endpoint when specific
      actions occur in your app
  - name: Yield
    description: >-
      Operations for depositing and withdrawing funds from ERC-4626 yield vaults
      (Morpho, Aave)
paths:
  /v1/users/{user_id}/fiat/onramp:
    post:
      tags:
        - Fiat
      summary: Initiate an onramp transaction
      description: >-
        Triggers an onramp to the specified recipient blockchain address,
        returns the bank deposit instructions
      operationId: initiateFiatOnramp
      parameters:
        - schema:
            type: string
            description: The ID of the user initiating the onramp
          required: true
          name: user_id
          in: path
        - schema:
            type: string
            description: ID of your Privy app.
          required: true
          name: privy-app-id
          in: header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: string
                  minLength: 1
                provider:
                  $ref: '#/components/schemas/OnrampProvider'
                source:
                  type: object
                  properties:
                    payment_rail:
                      $ref: '#/components/schemas/FiatPaymentRail'
                    currency:
                      $ref: '#/components/schemas/FiatCurrency'
                  required:
                    - payment_rail
                    - currency
                destination:
                  type: object
                  properties:
                    chain:
                      $ref: '#/components/schemas/OnrampChain'
                    currency:
                      $ref: '#/components/schemas/OnrampAsset'
                    to_address:
                      type: string
                  required:
                    - chain
                    - currency
                    - to_address
              required:
                - amount
                - provider
                - source
                - destination
              example:
                amount: '100.00'
                provider: bridge-sandbox
                source:
                  currency: usd
                  payment_rail: ach_push
                destination:
                  currency: usdc
                  chain: base
                  to_address: '0x38Bc05d7b69F63D05337829fA5Dc4896F179B5fA'
      responses:
        '200':
          description: Bank deposit instructions for the onramp
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/OnrampResponse'
                  - example:
                      id: 3a61a69a-1f20-4113-85f5-997078166729
                      status: awaiting_funds
                      deposit_instructions:
                        payment_rail: ach_push
                        currency: usd
                        amount: '100.0'
                        deposit_message: BRGFU2Z9TJPJXCS7ZZK2
                        bank_account_number: '11223344556677'
                        bank_routing_number: '123456789'
                        bank_beneficiary_name: Bridge Ventures Inc
                        bank_beneficiary_address: 1234 Elm St, Springfield, IL 12345
                        bank_name: Bank of Nowhere
                        bank_address: 1800 North Pole St., Orlando, FL 32801
      security:
        - appSecretAuth: []
components:
  schemas:
    OnrampProvider:
      type: string
      enum:
        - bridge
        - bridge-sandbox
      description: Valid set of onramp providers
      title: OnrampProvider
      example: bridge
      x-stainless-model: client_auth.onramp_provider
    FiatPaymentRail:
      type: string
      enum:
        - sepa
        - ach_push
        - wire
      description: Supported fiat payment rails.
      title: FiatPaymentRail
      x-stainless-model: fiat.fiat_payment_rail
    FiatCurrency:
      type: string
      enum:
        - usd
        - eur
      description: Supported fiat currencies.
      title: FiatCurrency
      x-stainless-model: fiat.fiat_currency
    OnrampChain:
      type: string
      enum:
        - ethereum
        - base
        - arbitrum
        - polygon
        - optimism
      description: Supported blockchain chains for onramp and offramp.
      title: OnrampChain
      x-stainless-model: fiat.onramp_chain
    OnrampAsset:
      type: string
      enum:
        - usdc
      description: Supported crypto assets for onramp and offramp.
      title: OnrampAsset
      x-stainless-model: fiat.onramp_asset
    OnrampResponse:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: '#/components/schemas/OnrampTransferStatus'
        deposit_instructions:
          $ref: '#/components/schemas/OnrampDepositInstructions'
      required:
        - id
        - status
        - deposit_instructions
      description: Response for an onramp transfer initiation.
      title: OnrampResponse
      x-stainless-model: fiat.onramp_response
    OnrampTransferStatus:
      type: string
      enum:
        - awaiting_funds
        - in_review
        - funds_received
        - payment_submitted
        - payment_processed
        - canceled
        - error
        - undeliverable
        - returned
        - refunded
      description: Status of an onramp or offramp transfer.
      title: OnrampTransferStatus
      x-stainless-model: fiat.onramp_transfer_status
    OnrampDepositInstructions:
      type: object
      properties:
        amount:
          type: string
        currency:
          $ref: '#/components/schemas/FiatCurrency'
        payment_rail:
          $ref: '#/components/schemas/FiatPaymentRail'
        deposit_message:
          type: string
        bank_name:
          type: string
        bank_account_number:
          type: string
        bank_routing_number:
          type: string
        bank_beneficiary_name:
          type: string
        bank_beneficiary_address:
          type: string
        bank_address:
          type: string
        iban:
          type: string
        bic:
          type: string
        account_holder_name:
          type: string
      required:
        - amount
        - currency
        - payment_rail
      description: Bank deposit instructions for an onramp transfer.
      title: OnrampDepositInstructions
      x-stainless-model: fiat.onramp_deposit_instructions
  securitySchemes:
    appSecretAuth:
      type: http
      scheme: basic
      description: >-
        Basic Auth header with your app ID as the username and your app secret
        as the password.

````