Documentation | Fiat › Onramp › Initiate An Onramp Transaction

API Reference

Fiat

fiat

Methods

Configure App For Fiat Onramping And Offramping -> { success }

post/v1/apps/{app_id}/fiat

Updates the app configuration for the specified onramp provider. This is used to set up the app for fiat onramping and offramping.

Get A KYC Link For A User -> { id, created_at, customer_id, 8 more... }

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

Returns a KYC link for a user

Get A List Of Fiat Transactions And Their Statuses -> { transactions }

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

Returns a list of fiat transactions and their statuses

Fiat

Accounts

fiat.accounts

Methods

Create A Fiat Account -> { id, account_type, currency, 2 more... }

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

Sets up external bank account object for the user through the configured default provider. Requires the user to already be KYC'ed.

Get User S Fiat Accounts -> { accounts }

get/v1/users/{user_id}/fiat/accounts

Returns the IDs of all external fiat accounts (used for offramping) for the user

Fiat

KYC

fiat.kyc

Methods

Initiate KYC Verification For A User -> { status, user_id, provider_user_id }

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

Initiates KYC verification process for a user with the configured provider

Get KYC Status For A User -> { status, user_id, provider_user_id }

get/v1/users/{user_id}/fiat/kyc

Get the current KYC verification status for a user from the configured provider

Update KYC Status For A User -> { status, user_id, provider_user_id }

patch/v1/users/{user_id}/fiat/kyc

Update the KYC verification status for a user from the configured provider

Fiat

Offramp

fiat.offramp

Methods

Initiate An Offramp Transaction -> { id, deposit_instructions, status }

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

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

Fiat

Onramp

fiat.onramp

Methods

Initiate An Onramp Transaction -> { id, deposit_instructions, status }

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

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

path Parameters

user_id: string

The ID of the user initiating the onramp

Response fields

id: string

deposit_instructions: { amount, currency, payment_rail, 10 more... }

status: "awaiting_funds" | "in_review" | "funds_received" | 7 more...

Request example

curl https://api.privy.io/v1/users/$USER_ID/fiat/onramp \
    -H 'Content-Type: application/json' \
    -H "Authorization: Basic $PRIVY_APP_ID:$PRIVY_APP_SECRET" \
    -d '{
      "amount": "100.00",
      "destination": {
        "chain": "base",
        "currency": "usdc",
        "to_address": "0x38Bc05d7b69F63D05337829fA5Dc4896F179B5fA"
      },
      "provider": "bridge-sandbox",
      "source": {
        "currency": "usd",
        "payment_rail": "ach_push"
      }
    }'

200Example

{
  "id": "3a61a69a-1f20-4113-85f5-997078166729",
  "deposit_instructions": {
    "amount": "100.0",
    "currency": "usd",
    "payment_rail": "ach_push",
    "account_holder_name": "account_holder_name",
    "bank_account_number": "11223344556677",
    "bank_address": "1800 North Pole St., Orlando, FL 32801",
    "bank_beneficiary_address": "1234 Elm St, Springfield, IL 12345",
    "bank_beneficiary_name": "Bridge Ventures Inc",
    "bank_name": "Bank of Nowhere",
    "bank_routing_number": "123456789",
    "bic": "bic",
    "deposit_message": "BRGFU2Z9TJPJXCS7ZZK2",
    "iban": "iban"
  },
  "status": "awaiting_funds"
}