Skip to main content
POST
Initiate an onramp transaction

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.