Generate a quote

This section will provide guidelines for fetching and providing quotation information via a custom integration.

Requirements

To integrate custom quoting in the Conversion Extension, you will need to:

• Create custom integration service that can receive a conversion.quote webhook event. The details for this webhook event are laid out in the Quote event section of this guide.
• Add the service as an integration in the Rehive Admin Dashboard.
• Configure a conversion.quote webhook on the integration in the dashboard.
  • Ensure that you use a unique, random value as the secret.
• Associate the integration to any conversion pairs that should use your custom integration to fetch quotes Rehive Conversion Extension.

Steps:

1. The user initiates a conversion transaction using the app.
2. The Rehive Conversion extension sends a conversion.quote webhook to the custom integration.
3. The custom integration verifies the secret sent in the headers and then:
   • Fetches applicable quote information (via the source of your choice).
   • If needed, performs any actions needed to ensure the funds/liquidity is available.
   • Returns a quote to the Rehive conversion extension in the response.
4. The Conversion extension uses the webhook response data to construct a conversion that gets returned to the user for approval.
5. The user approves the quote and processing proceeds to conversion execution.

Quote event

To integrate with the Conversion Extension, the custom integration requires an endpoint that can receive conversion.quote events. This endpoint url, along with a secret, is configured when setting up webhooks on a conversion extension integration.

The conversion.quote event is sent when a user requests a quote and it provides an opportunity for your integration to modify the quote to something suitable to your needs.

Request data

The request data sent by the Conversion Extension in the conversion.quote event looks like:

{
    "id": "<conversion_id>",
    "user": "<user_id>",
    "from_currency": "<currency_code>",
    "to_currency": "<currency_code>",
    "from_amount": 1000,
    "to_amount": null,
    "debit_account": "<account_reference>",
    "credit_account": "<account_reference>",
    "transaction_collection_id": "<collection_id>",
    "metadata": null
}

Either a from_amount or to_amount will be included. Your integration must be prepared to generate quotes from either direction.

Response data

Once you have verified the incoming webhook’s secret and performed any validation you can do anything else necessary to construct a quote that matches your business’s requirements.

Your response should be a 200 HTTP status with a JSON body formatted like:

{
    "from_amount": 1000,
    "to_amount": 1000,
    "from_fee": null,
    "to_fee": null,
    "expires": null,
    "rate": 0.01
}