GET
/
payees
List payees
curl --request GET \
  --url https://api.balansas.com/functions/v1/customer-api/payees \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.balansas.com/functions/v1/customer-api/payees"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.balansas.com/functions/v1/customer-api/payees', 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.balansas.com/functions/v1/customer-api/payees",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$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.balansas.com/functions/v1/customer-api/payees"

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

req.Header.Add("x-api-key", "<api-key>")

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.balansas.com/functions/v1/customer-api/payees")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.balansas.com/functions/v1/customer-api/payees")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "7c4e9a10-2b3d-4f56-8a90-1c2d3e4f5a6b",
      "fr_payee_id": "pay_8Hd2Km",
      "payee_name": "Jane Supplier Ltd",
      "currency": "GBP",
      "status": "active",
      "account_number": "GB29NWBK60161331926819",
      "sort_code": "04-00-04",
      "swift": "NWBKGB2L",
      "bank_name": "NatWest",
      "address_line1": "10 Downing St",
      "address_line2": "Floor 2",
      "city": "London",
      "state_region": "Greater London",
      "postal_code": "SW1A 2AA",
      "country_code": "GB",
      "end_user_id": "3f8a1c2d-4b5e-4f60-9a71-2b3c4d5e6f70",
      "requires_vop": false,
      "fr_owner_business_id": "busi_8Jh2KdLm5Qx",
      "created_at": "2026-05-28T11:02:09.456Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 25,
      "total": 100
    }
  }
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}

Authorizations

x-api-key
string
header
required

Customer API key. Send as x-api-key: sk_... or Authorization: Bearer sk_.... Write operations also require an X-CSRF-Token header (64-char hex).

Response

Success

data
object[]
required
meta
object
required