Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Client Settlements & Transfers

List Client Settlements

This API call allows clients to get a list of settlements that involve their accounts and their metadata. Results can be filtered by various parameters and are paginated.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed.

  • Examples: Invalid UUID format, invalid pagination parameters.

  • 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 client 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.

  • 500: Internal Server Error

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

  • Examples: Database connection issues, query errors.

Requires access token scope: settlement_network_read

get/api/network/v1/enterprises/{enterpriseId}/clients/settlements

Path parameters

enterpriseIdstring required

The enterprise identifier of the client. This identifies the client enterprise making the API 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.

settlementIdsstring[]

Filter by specific settlement IDs. When provided, only settlements matching these IDs will be returned.

onlyShowDisputedboolean

Filter to show only disputed settlements. When set to true, only settlements that have disputes will be returned. Setting to false will have no effect.

partnerIdsstring[]

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

partyConnectionIdsstring[]

Filter by specific party connection IDs. When provided, only settlements involving these connections as parties will be returned.

counterpartyConnectionIdsstring[]

Filter by specific counterparty connection IDs. When provided, only settlements involving these connections as counterparties will be returned.

statusesstring[]

Filter by settlement statuses. When provided, only settlements with these statuses will be returned.

Response

OK