PRprivy-io
Fiat

Initiate an onramp transaction

Changed on

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

post/v1/users/{user_id}/fiat/onramp

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/users/{user_id}/fiat/onramp
  • Auth
    HTTP basic

Path parameters

user_idstring required

The ID of the user initiating the onramp

Headers

privy-app-idstring required

ID of your Privy app.

Request body

amountstring required
provider'bridge' | 'bridge-sandbox' required

Valid set of onramp providers

Example request

{
  "amount": "100.00",
  "provider": "bridge-sandbox",
  "source": {
    "currency": "usd",
    "payment_rail": "ach_push"
  },
  "destination": {
    "currency": "usdc",
    "chain": "base",
    "to_address": "0x38Bc05d7b69F63D05337829fA5Dc4896F179B5fA"
  }
}

Response

Bank deposit instructions for the onramp

idstring required
status'awaiting_funds' | 'in_review' | 'funds_received' | 'payment_submitted' | 'payment_processed' | 'canceled' | 'error' | 'undeliverable' | 'returned' | 'refunded' required

Status of an onramp or offramp transfer.

Example response

{
  "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"
  }
}

Changes

  • 4facbfa7f9d4Revision changes
    • warning

      added the new faster_payments enum value to the // response property for the response status

    • warning

      added the new fednow enum value to the // response property for the response status

    • info

      added the new faster_payments enum value to the request property /

    • info

      added the new fednow enum value to the request property /