Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Basic authentication using the partner API keys from https://console.grainfinance.co/keys

Path Parameters

customerId
string<uuid>
required

The id of the customer within the Grain platform.

Pattern: [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}
dualHedgeId
string<uuid>
required

The id of the dual hedge within the Grain platform.

Pattern: [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}

Response

Dual Hedge Retrieved

The response for retrieving a dual hedge.

id
string<uuid>
required

The id of the dual hedge within the Grain platform.

Pattern: [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}
Example:

"bf77890b-17e2-48a1-9198-707df23eb127"

issuedAt
string<YYYY-MM-DD>
required

The date in which the hedge was issued, denoted in YYYY-MM-DD format.

Pattern: \d{4}-\d{2}-\d{2}
Example:

"2023-01-18"

customerId
string<uuid>
required

The id of the customer within the Grain platform.

Pattern: [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}
Example:

"87d8e330-2878-4742-a86f-dbbb3bf522ac"

functionalCurrency
string
required

The functional currency of the customer.

Example:

"EUR"

fromCurrency
string
required

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

Example:

"MXN"

toCurrency
string
required

The currency you want to buy.

Example:

"USD"

rate
number<double>
required

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

Example:

20.616512

hedges
object[]
required

The individual hedges that make up this dual hedge.

Hedge objects represent transactions which are currently hedged.

Example: