What You’ll Achieve:
- Understand why and when to retrieve quote information.
- Successfully make an API request to fetch a specific quote.
- Interpret the comprehensive Quote response, including pay_in and pay_out details.
Prerequisites
Before you begin, ensure that you have:- A Busha Business Account and Secret API Key (from the Quick Start Tutorial).
- An understanding of API Environments (Sandbox vs. Production) and their base URLs (from the Make Your First Request Guide).
-
A valid Quote ID from a previously created quote (e.g.,
QUO_uNiw1CDqGrdIlK15N0bu1from the Creating A Quote Guide).
For quote requests involving a customer, the X-BU-PROFILE-ID field should be
included in the request header, and its value should be set to the customer ID
for whom the request is performed on their behalf.
How to Retrieve a Quote
1
Understand the Get Quote API Endpoint
To retrieve quote information, you’ll use the GET method on the
/v1/quotes/{id} endpoint. This endpoint allows you to query the state and details of a specific quote by providing its unique ID.Why retrieve a Quote?- Check Expiration: Verify if the quote is still valid before attempting to use it for a transaction.
- Confirm Details: Double-check source_amount, target_amount, rate, and fees.
-
Retrieve Transfer Instructions: If the quote includes
pay_inorpay_outdetails (e.g., a deposit address or bank details), you can retrieve them here to present to your users. - Monitor Status: Although quotes typically stay pending until used or expired, checking its status can confirm its existence.
2
Make the Request to Get Quote Information
Use the GET request below, replacing the placeholders with your actual values.To retrieve quote information:Example:
- Open your terminal or command prompt
-
Construct a GET request to the
/v1/quotes/{id}endpoint. -
Replace
YOUR_BASE_URLwith your chosen environment’s URL (e.g.,https://api.sandbox.busha.so). -
Replace
{id}with the actual ID of the quote you wish to retrieve (e.g.,QUO_uNiw1CDqGrdIlK15N0bu1).
{YOUR_SECRET_API_KEY} with your actual Secret API Key.3
Interpret the Quote Response
Upon a successful request, the API will return the full Quote object, which is identical to the response you received when the quote was created.Expected Response:
Troubleshooting Common Issues:
-
404 Not Found: The provided
{id}does not correspond to an existing quote. Double-check the ID. -
401 Unauthorized: Ensure your Authorization: Bearer
{YOUR_SECRET_API_KEY}header is correct and includes a valid API key. - Expired Quote: If expires_at is in the past, the quote cannot be used. You will need to create a new quote.