{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"fromCurrency": "MXN",
"toCurrency": "USD",
"fromCurrencyAmount": 8040.43,
"toCurrencyAmount": 390,
"collateralAmountReleased": 402.02,
"quote": 20.6165,
"endAt": "2023-01-25",
"settlementAt": "2023-01-26",
"validUntilTs": 1659625098,
"beforeHedgeState": {
"fromCurrencyAmount": 32161.8,
"toCurrencyAmount": 1560,
"quote": 20.6165,
"endAt": "2023-02-23",
"settlementAt": "2023-02-24",
"collateralAmount": 1608.09
},
"afterHedgeState": {
"fromCurrencyAmount": 24121.37,
"toCurrencyAmount": 1170,
"quote": 20.6165,
"endAt": "2023-02-23",
"settlementAt": "2023-02-24",
"collateralAmount": 1206.07
}
}{
"message": "Can't perform this action",
"reason": "Supplied object is in *Cancelled* state, which prevents performing this action"
}{
"message": "Can't perform this action",
"reason": "Supplied object is in *Cancelled* state, which prevents performing this action"
}{
"message": "Can't perform this action",
"reason": "Supplied object is in *Cancelled* state, which prevents performing this action"
}{
"message": "Can't perform this action",
"reason": "Supplied object is in *Cancelled* state, which prevents performing this action"
}{
"message": "Could not parse IP address (v4 or v6) for ip"
}Drawdown Quote
Generates a rate proposal for drawing down part of a flexible hedge. The drawdown executes today and settles on the next business day. Once accepted, this proposal becomes a confirmed drawdown.
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"fromCurrency": "MXN",
"toCurrency": "USD",
"fromCurrencyAmount": 8040.43,
"toCurrencyAmount": 390,
"collateralAmountReleased": 402.02,
"quote": 20.6165,
"endAt": "2023-01-25",
"settlementAt": "2023-01-26",
"validUntilTs": 1659625098,
"beforeHedgeState": {
"fromCurrencyAmount": 32161.8,
"toCurrencyAmount": 1560,
"quote": 20.6165,
"endAt": "2023-02-23",
"settlementAt": "2023-02-24",
"collateralAmount": 1608.09
},
"afterHedgeState": {
"fromCurrencyAmount": 24121.37,
"toCurrencyAmount": 1170,
"quote": 20.6165,
"endAt": "2023-02-23",
"settlementAt": "2023-02-24",
"collateralAmount": 1206.07
}
}{
"message": "Can't perform this action",
"reason": "Supplied object is in *Cancelled* state, which prevents performing this action"
}{
"message": "Can't perform this action",
"reason": "Supplied object is in *Cancelled* state, which prevents performing this action"
}{
"message": "Can't perform this action",
"reason": "Supplied object is in *Cancelled* state, which prevents performing this action"
}{
"message": "Can't perform this action",
"reason": "Supplied object is in *Cancelled* state, which prevents performing this action"
}{
"message": "Could not parse IP address (v4 or v6) for ip"
}Authorizations
Basic authentication using the partner API keys from https://console.grainfinance.co/keys
Headers
The IPv4 address of the browser from which the customer contacts your platform.
example: 192.158.1.38
((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}Path Parameters
The id of the customer within the Grain platform.
[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}The id of the hedge within the Grain platform.
[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}Body
Information required by Grain in order to generate a drawdown proposal.
The drawdown executes on the next business day, so no endAt is accepted.
Specifies the amount to draw down in the fromCurrency. Exactly one of fromCurrencyAmount or toCurrencyAmount may be provided, matching the hedge's fixed side. Must be at least 10 in the fixed side's currency and not exceed the hedge's remaining amount. A drawdown must either use the full remaining amount or leave at least 10 remaining.
8040.43
Specifies the amount to draw down in the toCurrency. Exactly one of fromCurrencyAmount or toCurrencyAmount may be provided, matching the hedge's fixed side. Must be at least 10 in the fixed side's currency and not exceed the hedge's remaining amount. A drawdown must either use the full remaining amount or leave at least 10 remaining.
390
Response
Drawdown Proposal Created
A drawdown proposal returned by the drawdown-quote call.
The id of this drawdown proposal, to be passed to the drawdown-accept call.
[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}"497f6eca-6276-4993-bfeb-53cbbbba6f08"
The currency in which the transaction should be paid at by your customer.
"MXN"
The currency in which the inventory item is listed at on your platform.
"USD"
The amount to draw down in the fromCurrency.
If toCurrencyAmount is provided, then fromCurrencyAmount calculated as:
fromCurrencyAmount = toCurrencyAmount * quote
8040.43
The amount to draw down in the toCurrency.
If fromCurrencyAmount is provided, then toCurrencyAmount calculated as:
toCurrencyAmount = fromCurrencyAmount / quote
390
The collateral amount released back to the customer as a result of this drawdown, in the fromCurrency.
402.02
The rate at which this drawdown settles - the rate locked by the hedge.
20.6165
The date in which this drawdown executes, denoted in YYYY-MM-DD format.
\d{4}-\d{2}-\d{2}"2023-01-25"
The date in which this drawdown settles (next business day after endAt), denoted in YYYY-MM-DD format.
\d{4}-\d{2}-\d{2}"2023-01-26"
The unix timestamp until which this drawdown proposal is valid.
1659625098
The hedge's state immediately before this drawdown.
Show child attributes
Show child attributes
The hedge's remaining state immediately after this drawdown.
Show child attributes
Show child attributes