Grain API (1.0.0)

The currency in which the transaction should be paid at by your customer.

The currency in which the inventory item is listed at on your platform.

The amount of toCurrency to hedge, using this amount and the hedge rate will determine the fromCurrency amount of the hedge.

Optional external markup percentage to be applied to the hedge quote. This markup is applied on top of Grain's internal pricing and will be reflected in the final quote rate. Value must be between 0 and 100 (representing 0% to 100%). For example, 1.0 means a 1.0% markup, 0.5 means 0.5% markup, not basis points. If not provided, defaults to 0 (no external markup).

The id of the hedge proposal to accept.

The date format accepted by Grain's API. We accept dash separated ISO-8601 date-only strings.

The amount to hedge in the toCurrency, if amount was not specified on quote, it should be specified on Accept. This value is rounded up to two decimal places to ensure precision in the hedging process. For example, an input of 3052.1124 will be rounded to 3052.12.

The transaction id, as identified within your system - required when creating a new hedge.

The id of the revision that defines the accepted rate for the currency-pair and tenor.

The currency in which the transaction should be paid at by your customer.

the currency you want to buy.

The amount to hedge in the toCurrency.

The date format accepted by Grain's API. We accept dash separated ISO-8601 date-only strings.

Represents the exchange rate according to the offline map of currency pairs to tenor object.

The calculation of the tenor is based on the difference in calendar days between the 'tenorCalculationDate' and the 'endAt' date:

• If the number of calendar days from 'tenorCalculationDate' to endAt is less than or equal to 7, the tenor is 7 days.
• If the number of calendar days from 'tenorCalculationDate' to endAt is greater than 7 and less than or equal to 14, the tenor is 14 days.
• If the number of calendar days from 'tenorCalculationDate' to endAt is greater than 14 and less than or equal to 30, the tenor is 30 days.
• If the number of calendar days from 'tenorCalculationDate' to endAt is greater than 30 and less than or equal to 60, the tenor is 60 days.
• ...
• If the number of calendar days from 'tenorCalculationDate' to endAt is greater than 330 and less than or equal to 360, the tenor is 360 days.

When counting the difference in calendar days, every day is counted as one regardless of the duration of the day. This means that the calculation includes all days: weekends, holidays, and weekdays alike.

For example, if the 'endAt' date is 2023-12-16 and the 'tenorCalculationDate' is 2024-12-15, the result is 1 calendar day.

To calculate the difference in calendar days accurately, we recommend using a date manipulation library, such as date-fns and its differenceInCalendarDays function, or a similar feature provided by other date libraries.

Optional The transaction id, as identified within your system.

The id of the revision that defines the accepted rate for the currency-pair and tenor.

The currency in which the transaction should be paid by your customer.

The currency you want to buy.

The amount to hedge in the toCurrency for the customer.

The amount to hedge in the toCurrency for the vendor.

The date in which the customer hedge will be settled, denoted in YYYY-MM-DD format.

The date in which the vendor hedge will be settled, denoted in YYYY-MM-DD format.

Represents the offline hedge rate determined by a two-dimensional lookup based on the vendor and customer tenors.

Calculating Tenors:

Tenors are calculated from the calendar-day difference between the tenorCalculationDate and the vendor/customer end dates, then mapped into the nearest supported tenor bucket:

• 0 and ≤ 7 calendar days → 7-day tenor

• 7 and ≤ 14 calendar days → 14-day tenor

• 14 and ≤ 30 calendar days → 30-day tenor

• 30 and ≤ 60 calendar days → 60-day tenor

• 60 and ≤ 90 calendar days → 90-day tenor

• … continues in similar ranges up to 720 days

Note: All calendar days count — weekends and holidays included.

Rate Lookup Example:

The rate is retrieved from a two-dimensional map using both tenors:

"USDMXN": {
  "7": { "7": 1.1 },
  "14": { "7": 1.2, "14": 1.3 },
  "30": { "7": 1.1, "14": 1.1, "30": 1.1 },
  // ... and so on
}

In this example, if the vendor tenor is 14 days and the customer tenor is 7 days, the rate would be 1.2.

To calculate the difference in calendar days accurately, we recommend using a date manipulation library, such as date-fns and its differenceInCalendarDays function, or a similar feature provided by other date libraries.

The transaction id, as identified within your system.

The email address of the company's primary contact

The name of the company's primary contact

The phone number of the company's primary contact

The legal name of the customer's company

The address of the company

The city of the company

The state the company is in (US based)

The alpha-2 ISO 3166 country code of the entity's country.

The tax identification or registration number of the company

The id used to identify the customer within your platform

The email address of the company's primary contact

The name of the company's primary contact

The phone number of the company's primary contact

The legal name of the customer's company

The address of the company

The city of the company

The state the company is in (US based)

The alpha-2 ISO 3166 country code of the entity's country.

The tax identification or registration number of the company

The id used to identify the customer within your platform

The currency in which the transaction should be paid at by your customer.

The currency in which the inventory item is listed at on your platform.

The amount of toCurrency to hedge, using this amount and the hedge rate will determine the fromCurrency amount of the hedge.

The id of the spot proposal to accept.

the amount to transfer in the toCurrency. If amount was not specified on quote, it should be specified on Accept.