Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Partner Activation

List Partner Connections

Returns all your OES connections. For use only by OES partners.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed.

  • Examples: Empty string provided for enterpriseId. Invalid query values.

  • 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 necessary permissions.

  • Examples: Enterprise does not have OES license.

  • 404: Not Found Error

  • Occurs when the specified enterprise cannot be found.

  • Examples: Enterprise ID doesn't exist or doesn't belong to the partner.

  • 500: Internal Server Error

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

  • Examples: Database connection issues, error retrieving connection data.

Requires access token scope: settlement_network_read

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

Path parameters

enterpriseIdstring required

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.

activeboolean
clientIdsstring[]
connectionIdsstring[]
partnersClientIdsstring[]
partnersConnectionIdsstring[]
partnerIdsstring[]

Response

OK