Skip to main content
POST
/
v1
/
users
/
{user_id}
/
fiat
/
onramp
Initiate an onramp transaction
curl --request POST \
  --url https://api.privy.io/v1/users/{user_id}/fiat/onramp \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'privy-app-id: <privy-app-id>' \
  --data '
{
  "amount": "100.00",
  "provider": "bridge-sandbox",
  "source": {
    "currency": "usd",
    "payment_rail": "ach_push"
  },
  "destination": {
    "currency": "usdc",
    "chain": "base",
    "to_address": "0x38Bc05d7b69F63D05337829fA5Dc4896F179B5fA"
  }
}
'
{
  "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"
  }
}

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.

Authorizations

​
Authorization
string
header
required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

​
privy-app-id
string
required

ID of your Privy app.

Path Parameters

​
user_id
string
required

The ID of the user initiating the onramp

Body

application/json
​
amount
string
required
Minimum string length: 1
​
provider
enum<string>
required

Valid set of onramp providers

Available options:
bridge,
bridge-sandbox
Example:

"bridge"

​
source
object
required
​
destination
object
required

Response

200 - application/json

Bank deposit instructions for the onramp

Response for an onramp transfer initiation.

​
id
string
required
​
status
enum<string>
required

Status of an onramp or offramp transfer.

Available options:
awaiting_funds,
in_review,
funds_received,
payment_submitted,
payment_processed,
canceled,
error,
undeliverable,
returned,
refunded
​
deposit_instructions
OnrampDepositInstructions · object
required

Bank deposit instructions for an onramp transfer.