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}
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}

Query Parameters

page
number<double>

page number indicating which set of items to return The page indicating which set of items are returned

Required range: x >= 1
per_page
number<double>

number of items in a page

Required range: 1 <= x <= 100
status
enum<string>

Status filter - only drawdowns in this status will be returned. The status of a drawdown as shown to partners. A drawdown is InProcess from acceptance until its settlement completes, Completed once settled, and Overdue when settlement is late.

Available options:
Active,
InProcess,
Completed,
Overdue

Response

Drawdowns List for Hedge

A response containing the chronological list of drawdowns for a hedge.

drawdowns
object[]
required
pagination
object
required

Pagination parameters of the returned results.