Skip to main content
POST
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}
hedgeId
string<uuid>
required

The id of the 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

Early Settlement Proposal Created

The response when requesting an early settlement quote for a hedge.

id
string<uuid>
required

The unique identifier of the early settlement proposal.

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:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

hedgeId
string<uuid>
required

The unique identifier of the hedge associated with this proposal.

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:

"8173b9a7-ee61-413e-b9e3-7c04b2a067c5"

toCurrencyAmount
number<double>
required

The amount in the target currency (toCurrency).

Example:

10000

fromCurrencyAmount
number<double>
required

The amount in the source currency (fromCurrency).

Example:

10825

quote
number<double>
required

The exchange rate quote for the early settlement.

Example:

1.0825

validUntilTs
number<double>
required

The unix timestamp until which the early settlement proposal is valid.

Example:

1710510600