Skip to main content
GET
/
customers
/
{customerId}
/
dual-hedges
/
{dualHedgeId}
cURL
curl --request GET \
  --url https://api.grainfinance.co/v1/customers/{customerId}/dual-hedges/{dualHedgeId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "bf77890b-17e2-48a1-9198-707df23eb127",
  "issuedAt": "2023-01-18",
  "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  "functionalCurrency": "EUR",
  "fromCurrency": "MXN",
  "toCurrency": "USD",
  "quote": 20.616512,
  "hedges": [
    {
      "id": "8173b9a7-ee61-413e-b9e3-7c04b2a067c5",
      "customerId": "1b0ada1e-fa1b-4cfe-a553-01b340c5650e",
      "status": "Active",
      "transactionId": "4d78ac65-2c3f-47e2-8bf3-3f76124e9d27",
      "externalTransactionId": "780231b3ae0d7e9e5097nd89",
      "fromCurrency": "MXN",
      "toCurrency": "USD",
      "externalCustomerId": "630231b3ae0d7e9e5097ad35",
      "toCurrencyAmount": 1560,
      "fromCurrencyAmount": 32161.8,
      "fixedSide": "toCurrencyAmount",
      "initialCollateralAmount": 1608.09,
      "quote": 20.6165,
      "externalMarkupPct": 1,
      "acceptedAtTs": 1659625088,
      "issuedAt": "2023-01-18",
      "endAt": "2023-02-23",
      "updatedAt": "2023-02-23",
      "cancelledAt": "2023-02-23",
      "initialCollateralReceivedAt": "2023-01-20",
      "fundsReceivedAt": "2023-02-23",
      "completedAt": "2023-02-23",
      "completedAtTs": 1659625090,
      "overdueAt": "2023-02-23",
      "settlementAt": "2023-02-23",
      "settlementType": "full",
      "adjustedMtmChangePct": 0.0125,
      "adjustedMtmChangeTs": 1674057600,
      "spotRate": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.grainfinance.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
customerId
string
required

The id of the customer within the Grain platform.

​
dualHedgeId
string
required

The id of the dual hedge within the Grain platform.

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"

​
quote
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.