Skip to main content
GET
/
payouts
cURL
curl --request GET \
  --url https://api.grainfinance.co/v1/payouts \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api.grainfinance.co/v1/payouts"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.grainfinance.co/v1/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.grainfinance.co/v1/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.grainfinance.co/v1/payouts"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Basic <encoded-value>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.grainfinance.co/v1/payouts")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.grainfinance.co/v1/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "payouts": [
    {
      "id": "8173b9a7-ee61-413e-b9e3-7c04b2a067c5",
      "status": "in_process",
      "externalPayoutId": "inv_2026_001",
      "currency": "USD",
      "amount": 5000,
      "fee": 1.5,
      "totalAmount": 5001.5,
      "reason": 2,
      "description": "<string>",
      "payoutDate": "2026-05-15",
      "payoutMethod": "SEPA",
      "vendorDetails": {
        "vendorId": "1b0ada1e-fa1b-4cfe-a553-01b340c5650e",
        "vendorName": "Acme Supplies Ltd",
        "externalVendorId": "vendor_001",
        "bankDetails": {
          "accountHolderName": "Acme Payments Ltd",
          "accountNumber": "8290041523",
          "bankName": "JPMorgan Chase Bank, N.A.",
          "bankAddress": "383 Madison Avenue, New York, NY 10017",
          "bankCountry": "US",
          "bankState": "NY",
          "iban": "<string>",
          "bicSwift": "CHASUS33XXX",
          "routingCode": "<string>",
          "bankCode": "<string>",
          "branchCode": "<string>",
          "sortCode": "560036",
          "bsbCode": "082902"
        }
      }
    }
  ],
  "pagination": {
    "page": 2,
    "perPage": 50.5,
    "totalResults": 123
  }
}

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.

Pattern: ^[A-Za-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

200 - application/json

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.