> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yuvexpay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List split partners

> 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. 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. Requires the `payments:read` scope.



## OpenAPI

````yaml GET /v1/splits/partners
openapi: 3.1.0
info:
  title: YuvexPay API
  description: >-
    The YuvexPay API allows you to accept payments, process withdrawals, manage
    products and customers programmatically. All API access is over HTTPS and
    uses JSON request/response bodies.
  version: 1.0.0
  contact:
    name: YuvexPay Support
    email: support@yuvexpay.com
    url: https://docs.yuvexpay.com
servers:
  - url: https://api.yuvexpay.com
    description: >-
      Same base URL serves both sandbox and production. Send a `ypk_test_*` key
      for sandbox or a `ypk_live_*` key for production.
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Inspect the API key in use
  - name: Payments
    description: Create and manage payments
  - name: Withdrawals
    description: Create and manage withdrawals
  - name: Products
    description: Manage product catalog
  - name: Customers
    description: Manage customer records
  - name: Documents
    description: Generate receipts and statements
  - name: Balance
    description: Inspect the current account balance
  - name: Splits
    description: Inspect the split partners of the account
paths:
  /v1/splits/partners:
    get:
      tags:
        - Splits
      summary: List split partners
      description: >-
        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. 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.
        Requires the `payments:read` scope.
      operationId: listSplitPartners
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - PENDING
              - ACCEPTED
              - REVOKED
              - DECLINED
              - CANCELLED
          description: Return only partners in this state.
        - name: direction
          in: query
          required: false
          schema:
            type: string
            enum:
              - OUTGOING
              - INCOMING
          description: >-
            `OUTGOING` lists companies you may split to; `INCOMING` lists
            companies that split to you.
      responses:
        '200':
          description: Partners listed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  partners:
                    type: array
                    items:
                      $ref: '#/components/schemas/SplitPartner'
                required:
                  - partners
              examples:
                mixed:
                  summary: One usable partner and one that revoked
                  value:
                    partners:
                      - id: 0f0e1f5e-1d6a-4a77-9c1b-1c1a9f2a44c1
                        companyId: 7b1f2a2c-5f0b-4a3a-9b62-2e9a1f0c3d55
                        tradeName: Ateliê Norte
                        direction: OUTGOING
                        status: ACCEPTED
                        requestedAt: '2026-09-10T12:00:00.000Z'
                        acceptedAt: '2026-09-10T18:22:41.000Z'
                      - id: 3c5c5d61-9a21-4f65-b2a1-8a0e5d2c7b90
                        companyId: a41c0f22-6e2d-4a10-8f3b-5d77cbb0a912
                        tradeName: Studio Sul
                        direction: OUTGOING
                        status: REVOKED
                        requestedAt: '2026-08-02T09:14:00.000Z'
                        acceptedAt: '2026-08-02T10:01:12.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    SplitPartner:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identifier of the relationship, not of the company.
        companyId:
          type: string
          format: uuid
          description: >-
            Company ID of the counterparty. This is the value to send as
            `recipientCompanyId` in `splits[]`.
        tradeName:
          type: string
          description: Trade name of the counterparty.
        direction:
          type: string
          enum:
            - OUTGOING
            - INCOMING
          description: >-
            `OUTGOING` when your company originates the split, `INCOMING` when
            it receives one.
        status:
          type: string
          enum:
            - PENDING
            - ACCEPTED
            - REVOKED
            - DECLINED
            - CANCELLED
          description: >-
            Only `ACCEPTED` can be named in `splits[]`. `ACCEPTED` is the active
            state.
        requestedAt:
          type: string
          format: date-time
        acceptedAt:
          type: string
          format: date-time
          nullable: true
      required:
        - id
        - companyId
        - tradeName
        - direction
        - status
        - requestedAt
        - acceptedAt
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
            details:
              type: object
              description: Additional error context.
  responses:
    Unauthorized:
      description: Missing or invalid authentication token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_API_KEY
              message: Invalid or revoked API key
    Forbidden:
      description: >-
        The API key is valid but does not have the required scope for this
        endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INSUFFICIENT_SCOPE
              message: 'Required scope missing: balance:read'
    RateLimited:
      description: Rate limit exceeded.
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Request limit per window.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Remaining requests in window.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Seconds until the window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMIT_EXCEEDED
              message: Too many requests
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        YuvexPay API key. Include as `Authorization: Bearer
        ypk_<env>_<kid>_<secret>` where `<env>` is `test` (sandbox) or `live`
        (production). Create and manage keys in the dashboard under **Settings >
        API Keys**.

````