Skip to main content
POST
/
v1
/
users
/
{user_id}
/
fiat
/
offramp
Initiate an offramp transaction
curl --request POST \
  --url https://api.privy.io/v1/users/{user_id}/fiat/offramp \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'privy-app-id: <privy-app-id>' \
  --data '
{
  "provider": "bridge-sandbox",
  "amount": "100.00",
  "source": {
    "currency": "usdc",
    "chain": "base",
    "from_address": "0xc24272abc794b973b896715db40a72714a030323"
  },
  "destination": {
    "currency": "usd",
    "payment_rail": "ach_push",
    "external_account_id": "a068d2dd-743a-4011-9b62-8ad33cc7a7be"
  }
}
'
{
  "id": "d220bcf7-4ad5-4687-8a61-e51c5875225e",
  "status": "awaiting_funds",
  "deposit_instructions": {
    "amount": "100.0",
    "currency": "usdc",
    "to_address": "0xdeadbeef2usdcbase",
    "from_address": "0xc24272abc794b973b896715db40a72714a030323",
    "chain": "base"
  }
}

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 offramp

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

Deposit instructions for the offramp

Response for an offramp 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
OfframpDepositInstructions · object
required

Deposit instructions for an offramp transfer.