GET
/
payees
List payees
curl --request GET \
  --url https://api.balansas.com/functions/v1/customer-api/payees \
  --header 'x-api-key: <api-key>'
{
  "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
    }
  }
}

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