Get Yield Profile by ID

This method returns full details about a specific yield profile (which is identified by the yield offering id) including list of customers configured for the profile. To know your yield profiles and retrieve the IDs, call the Get All Yield Profiles API

HTTP Method : GET
API Endpoint : {{baseurl}}/api/v1/configuration/yield-offering/{{yieldOfferingID}}

Sample cURL Request

curl --location --request GET 'https://api.ovalfi-app.com/api/v1/configuration/yield-offering/325d9c03-c708-4556-8725-b6a0842fdf3a' \
--header 'Authorization: Bearer eyJidXNpbmVzc0lEIjoiZTY2NWJkYWUtNWE0ZC00ODNiLTk2NTQtZTk0NzViMzRjY2ViIiwidXNlcklEIjoiYTY4NjE1ZGMtMjY5MS00ZmI1LTkyZmMtNTQ1NmRlN2M3YjllIiwia2V5Ijoia3JwIn0='

Response

{
    "status": 200,
    "data": {
        "yield_offering_id": "325d9c03-c708-4556-8725-b6a0842fdf3a",
        "name": "aave yield",
        "description": "for aave",
        "apy_rate": 10,
        "currency": "usd",
        "deposit_lock_day": 2,
        "minimum_deposit_allowed": 100,
        "maximum_deposit_allowed": 3000,
        "yieldable_after_day": 1,
        "withdrawal_limit_rate": 900,
        "portfolio_id": "0ff9e20b-66ab-4f67-8d2a-32dcd21b7f85",
        "reference": "ref87579724"
    },
    "message": "get yield offering successfully",
    "error": null
}