---
title: "List split partners"
method: GET
path: "/v1/splits/partners"
tags: ["Splits"]
---

# List split partners

`GET /v1/splits/partners`

## Request

- Base URL: `https://api.yuvexpay.com`
- URL: `https://api.yuvexpay.com/v1/splits/partners`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/yuvexpay/apis/yuvexpay-api/docs/v1/splits/partners/get.ts> (a function with typed inputs; its response is checked against the schema)

Return the companies your account may split payments with, in both directions, for the environment of the API key. A pair is created in the dashboard: the originating company invites the recipient by company ID and the recipient accepts. There is no API to invite, accept, decline or revoke — accepting is a human act. The one exception is an approved split platform, which connects a seller on the seller's first payment by sending `X-Split-Platform-Key` on `POST /v1/payments`, in production and in sandbox. Use this endpoint to discover which `companyId` values you may send as `recipientCompanyId` in `splits[]`: only a partner whose `status` is `ACCEPTED` is usable. The list carries the live row for each pair, plus the most recent answered row for a pair that has no live one, so a rejected or revoked pair is still visible. Every partner is returned in one response, newest first, unless `limit` is sent: then at most `limit` relationships are read per call, a page can carry fewer partners than `limit`, and you pass `nextCursor` back as `cursor` until it is `null`. Requires the `payments:read` scope.

## Query parameters

- `status` 'PENDING' | 'ACCEPTED' | 'REVOKED' | 'DECLINED' | 'CANCELLED'
- `direction` 'OUTGOING' | 'INCOMING'
- `limit` integer
- `cursor` string, uuid

## Response `200`

Partners listed.

- object
  - `nextCursor` string, uuid, nullable, required: Send it as `cursor` to read the next page. `null` on the last page, and whenever the whole list was returned.
  - `partners` SplitPartner[], required
    - `id` string, uuid, required: Identifier of the relationship, not of the company.
    - `companyId` string, uuid, required: Company ID of the counterparty. This is the value to send as `recipientCompanyId` in `splits[]`.
    - `tradeName` string, required: Trade name of the counterparty.
    - `direction` 'OUTGOING' | 'INCOMING', required: `OUTGOING` when your company originates the split, `INCOMING` when it receives one.
    - `status` 'PENDING' | 'ACCEPTED' | 'REVOKED' | 'DECLINED' | 'CANCELLED', required: Only `ACCEPTED` can be named in `splits[]`. `ACCEPTED` is the active state.
    - `feeCap` string, nullable, required: Fee cap recorded on the relationship when the recipient is an approved split platform: the most it may take of each payment, in percent of `amount`, as a string with two decimal places. `null` for an ordinary partner. The cap applied to a payment can be lower than this value: see the Split platforms guide.
    - `requestedAt` string, date-time, required
    - `acceptedAt` string, date-time, nullable, required

## Other responses

- `401`: Missing or invalid authentication token.
- `403`: The API key is valid but does not have the required scope for this endpoint.
- `429`: Rate limit exceeded.

## Changes

- **2026-10-10** `994865a1723c`: 4 info
  - added the new optional `query` request parameter `cursor`
  - added the new optional `query` request parameter `limit`
  - added the required property `nextCursor` to the response with the `200` status
  - added the required property `partners/items/feeCap` to the response with the `200` status
- **2026-09-19** `99d0c77cc3ee`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/yuvexpay/apis/yuvexpay-api/changes/v1/splits/partners/get.md)

---

[API](https://skmtc.dev/yuvexpay/apis/yuvexpay-api.md) - [All operations](https://skmtc.dev/yuvexpay/apis/yuvexpay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yuvexpay/apis/yuvexpay-api/revisions/a5e417a542bc?raw)