Fiat

Initiate an offramp transaction

Changed on

Triggers the offramp flow and gets the on-chain address to send funds to

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

Request

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

Path parameters

user_idstring required

The ID of the user initiating the offramp

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

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

Response

Deposit instructions for the offramp

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": "d220bcf7-4ad5-4687-8a61-e51c5875225e",
  "status": "awaiting_funds",
  "deposit_instructions": {
    "amount": "100.0",
    "currency": "usdc",
    "to_address": "0xdeadbeef2usdcbase",
    "from_address": "0xc24272abc794b973b896715db40a72714a030323",
    "chain": "base"
  }
}

Changes

  • 4facbfa7f9d4Revision changes
    • info

      added the new faster_payments enum value to the request property /

    • info

      added the new fednow enum value to the request property /