Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Client Activation

List 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.

Requires access token scope: settlement_network_read

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

Path parameters

enterpriseIdstring required

The enterprise ID of the client making the request.

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.

idsstring[]

Filter by specific partner IDs. When provided, only partners with these IDs will be returned.

namesstring[]

Filter by partner names. When provided, only partners with these names will be returned.

institutionIdsstring[]

Filter by institution IDs. When provided, only partners linked to these institutions will be returned.

institutionIdentifiersstring[]

Filter by institution identifiers. When provided, only partners with these institution identifiers will be returned.

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.

filterByTrustOrgboolean

Filter by trust organization. When provided, only partners belonging to this trust organization will be returned.

allocationPoliciesEnabledboolean

Filter by allocation policies enabled. When true, only partners with allocation policies enabled will be returned. When false, only partners with allocation policies disabled will be returned. When not provided, partners with any allocation policies status will be returned.

Response

OK