Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Query Parameters

status
enum<string>

Filter by payout status.

Available options:
in_process,
sent,
paid,
failed,
rejected
currency
string

Filter by the alpha-3 ISO 4217 currency code of the payout. The alpha-3 ISO 4217 currency code of the related entity, in upper case.

Pattern: ^[A-Z]{3}$
Example:

"EUR"

external_payout_id
string

Filter by your own reference number for the payout. Partner's own reference number for this payout.

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

"inv_2026_001"

external_vendor_id
string

Filter by your own reference id for the vendor. Partner's own reference ID for the vendor.

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

"vendor_001"

from_date
string

Earliest payout date to include, in YYYY-MM-DD format.

to_date
string

Latest payout date to include, in YYYY-MM-DD format.

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

Response

Payouts found

A paginated list of payouts.

payouts
object[]
required

A list of payouts matching the search criteria.

pagination
object
required

Pagination parameters of the returned results.