YUyuvexpay
Splits

List split partners

Changed on

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.

get/v1/splits/partners

Request

Query parameters

status'PENDING' | 'ACCEPTED' | 'REVOKED' | 'DECLINED' | 'CANCELLED'

Return only partners in this state.

direction'OUTGOING' | 'INCOMING'

OUTGOING lists companies you may split to; INCOMING lists companies that split to you.

limitinteger

Maximum number of relationships read for this page. A page can carry fewer partners than limit. Omit it to get every partner in one response. When cursor is sent without limit, a page reads up to 100 relationships.

cursorstring uuid

The nextCursor of the previous page. Omit it for the first page.

Response

Partners listed.

nextCursorstring uuid nullable required

Send it as cursor to read the next page. null on the last page, and whenever the whole list was returned.

Example response

{
  "partners": [
    {
      "feeCap": "4.00"
    }
  ]
}

Changes

  • 994865a1723cRevision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

  • 99d0c77cc3eeRevision changes
    • info

      endpoint added