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

vendorId
string<uuid>
required

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

Vendor found

A Vendor represents a payee that payouts can be sent to. Returned by POST /v1/vendors, GET /v1/vendors/{vendorId}, and GET /v1/vendors.

vendorId
string<uuid>
required

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

"1b0ada1e-fa1b-4cfe-a553-01b340c5650e"

externalVendorId
string
required

The vendor id, as identified within your system.

Pattern: ^[A-Za-z0-9_.\-]{1,64}$
Example:

"vendor_001"

contact
object
required

The contact details of the vendor.

payoutMethods
object[]
required

The payout methods registered for the vendor.

createdAt
string<date-time>
required

When the vendor was created, as an ISO-8601 date-time in UTC.

Example:

"2026-05-15T09:12:28.000Z"

updatedAt
string<date-time>
required

When the vendor was last updated, as an ISO-8601 date-time in UTC.

Example:

"2026-05-15T09:12:28.000Z"