API Documentation
Offramps API
Offramps API
  • Guides
    • Getting Started
  • API Reference
    • Authentication
    • Agreements
      • Agreements#Show
    • Users
      • Users#Create
      • Users#Show
      • Users#Index
    • KYC Sessions
      • KYC#Create
    • Payment Details
      • PaymentDetails#Create
      • PaymentDetails#Index
      • PaymentDetails#Show
      • PaymentDetails#Validate
      • PaymentDetails#Deactivate
      • Rail Availability
      • Required Fields For Local Currency Payouts
      • Required Fields For Swift Currency Payouts
    • Quotes
      • How to make a payment
      • Quotes#Create
      • Quotes#Show
      • Quotes#Execute
      • Quote#Rate
    • Offramps
      • Offramps#Index
      • Offramps#Create
      • Offramps#Update
      • Offramps#Show
      • Limitations
    • Webhooks
      • KYC Webhook
      • Offramp Webhook
      • Payment Detail Webhook
      • Webhook Signatures
    • Errors
    • Conversions
      • Conversions#Create
  • Sandbox Only
    • Sandbox Special Moves
Powered by GitBook
On this page
  1. API Reference
  2. Quotes

Quotes#Create

Create a Quote that will tell you how much you need to send and to what address.

PreviousHow to make a paymentNextQuotes#Show

Last updated 3 months ago

Please read to understand how Quotes & Offramps work.

Example request

curl https://{{base_url}}/users/USER_ID/quotes
-X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-type: application/json" \
-d '{
       "quote": {
          "deposit_token": "usdc",
          "deposit_token_chain": "ethereum"
       }
}'

Endpoint Information

Create a quote

POST https://{{base_url}}/users/:user_id/quotes

Get the required information to create an offramp.

Path Parameters

Name
Type
Description

user_id*

UUID

The ID for the User who is making the payment.

Request Body

Name
Type
Description

deposit_token*

String

Symbol of the token to be liquidated. Can only be usdc.

deposit_token_chain*

String

Blockchain of the token to be liquidated. Can be polygon, ethereum, tron, solana, arbitrum.

{ 
  "quote":
    {
      "id": "1e99d470-dcc2-46f4-970c-bc35a9e13b84",
      "user_id": "a25a4274-8f50-4579-b476-8f35b297d4ad"
      "deposit_token": "usdc",
      "deposit_token_chain": "ethereum",
      "deposit_token_amount": 0,
      "fees": 0,
      "expiry": 1366762500
      "executed": false,
      "rates": {}
    },
    "deposit_address": {
      "adddress": "0x709c56AfDAdBDCAB4f7a6aAe99644C91C3eF67eF",
      "blockchain": "ethereum"
    },
    "offramps": []
}

How To Make a Payment