Ctrl+K

List Partners

get/api/network/v1/enterprises/{enterpriseId}/partners

Lists all OES Partners associated with the specified enterprise. Returns a collection of partners with information required to connect to them.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or incomplete.

  • Examples: Empty string supplied for enterpriseId.

  • 401: Authentication Error

  • Occurs when the request is not authorized.

  • Examples: Caller is not a member of the enterprise.

  • 403: Permission Denied Error

  • Occurs when the authenticated partner doesn't have access to create a partner.

  • Examples: Enterprise does not have OES license.

  • 500: Internal Server Error

  • Occurs when there's an unexpected error processing the request

  • Examples: Database connection failure, transient network error.

Path Parameters

  • enterpriseIdstringRequired
    The enterprise ID of the client making the request.
    Min length: >= 1 characters

Query Parameters

  • pageNumberstring<integer>
    The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.
  • pageSizestring
    The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.
  • idsarray[string]
    Filter by specific partner IDs. When provided, only partners with these IDs will be returned.
  • namesarray[string]
    Filter by partner names. When provided, only partners with these names will be returned.
    Min length: >= 1 characters
  • institutionIdsarray[string]
    Filter by institution IDs. When provided, only partners linked to these institutions will be returned.
  • institutionIdentifiersarray[string]
    Filter by institution identifiers. When provided, only partners with these institution identifiers will be returned.
    Min length: >= 1 characters
  • activeboolean
    Filter by active status. When true, only active partners will be returned. When false, only inactive partners will be returned. When not provided, partners of any status will be returned.

200 Response

partners array[object] required
Array of partner objects with limited properties and stability indicators.
id string required
Unique identifier for the partner.
name string required
Display name of the partner.
Min length: >= 1 characters
institutionId string
Optional identifier linking the partner to an institution in external systems.
institutionIdentifier string
Optional string identifier for the institution.
connectionKeySchema string required
Schema defining which connection request schema is required for this partner. Can be 'token', 'tokenAndSignature', 'apiKeyAndSecret', or 'clearloop'.
Allowed values: token tokenAndSignature apiKeyAndSecret clearloop
active boolean required
Boolean flag indicating whether the partner is currently active in the system.
settlementTransactionRouteId string
Optional identifier for the settlement transaction route associated with this partner.
publicKey string
Optional RSA public key used for secure communication with the partner.
enterpriseId string
Enterprise ID associated with this partner, if any.
clientDisputeWindowMinutes number
Time window in minutes during which clients can dispute transactions.
topUpWindowMinutes number
Time window in minutes after which dispute window ends for processing top-up operations.
stablePartner boolean required
Flag indicating whether the partner has demonstrated operational stability. Used when partner is initially launched to demonstrate that the partner is still in beta and not yet stable.

400 Response

401 Response

error string required

403 Response

error string required

500 Response

error string required