latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Payments

Create on-ramp quote

Creates a provider-specific on-ramp quote. Hosted providers return a hosted URL; instruction-based providers return manual funding instructions.

post/v1/payments/ramps/onramp/quote

Request body

Ramp provider identifier. Hosted providers return a URL, manual providers return funding instructions, and Stripe returns a session widget secret.

counterpartyIdstring required

SDP counterparty ID. Provider-native customer records may be resolved or created from this counterparty.

destinationWalletstring required

Destination wallet (walletId from GET /v1/wallets) or Solana address for purchased crypto.

cryptoTokenstring required

Crypto token symbol or provider currency code.

fiatCurrency'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' required

Fiat currency for on-ramp.

fiatAmountstring required

Fiat amount to on-ramp.

redirectUrlstring uri

Optional return URL after hosted provider flow completes.

rampsMemoobject

Optional key-value memo stored on the resulting transfer.

domainstring

Example request

{
  "provider": "moonpay",
  "counterpartyId": "counterparty_example",
  "destinationWallet": "privy_wallet_123",
  "cryptoToken": "USDC",
  "fiatCurrency": "USD",
  "fiatAmount": "100.00",
  "redirectUrl": "https://example.com/onramp/complete"
}

Response

On-ramp quote created

Example response

{
  "data": {
    "quote": {
      "id": "ramp_quote_example",
      "provider": "moonpay",
      "status": "pending",
      "deliveryMode": "hosted",
      "paymentInstructions": [
        {
          "provider": "lightspark",
          "kind": "crypto_deposit",
          "destinationAddress": "So11111111111111111111111111111111111111112",
          "cryptoCurrency": "USDC",
          "network": "SOLANA",
          "accountOrWalletInfo": {
            "accountType": "USD_ACCOUNT",
            "accountNumber": "0000000000000000",
            "routingNumber": "000000000",
            "paymentRails": [
              "ACH",
              "WIRE"
            ],
            "reference": "quote-reference-example",
            "bankName": "Example Bank",
            "address": "ExampleSolanaWalletAddress11111111111111111",
            "assetType": "USDC"
          }
        }
      ],
      "sendingCurrency": {
        "code": "USDC",
        "decimals": 2
      },
      "receivingCurrency": {
        "code": "USDC",
        "decimals": 2
      },
      "feeCurrency": {
        "code": "USDC",
        "decimals": 2
      },
      "expiresAt": "2025-01-01T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}