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}

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>[]

Filter hedges by one or more statuses.

Available options:
Active,
Cancelled,
Completed,
InProcess,
Overdue
external_transaction_id
string

Filter hedges by the external transaction id of their linked transaction (exact match).

Response

Hedges List for Customer

A response containing a list of hedges matching the search criteria.

hedges
object[]
required

A list of hedges matching the search criteria.

Hedge objects represent transactions which are currently hedged.

pagination
object
required

Pagination parameters of the returned results.