Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Client Allocations & Deallocations

List client allocations and deallocations

This API call allows clients to get a list of allocations and deallocations for any connected network account. or "deallocation" to view deallocations.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed.

  • Examples: Empty string provided for enterpriseId, invalid UUID format for allocationId. invalid date format for createdOnOrAfter/createdBefore, 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 partner doesn't have access to the requested allocation.

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

  • 500: Internal Server Error

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

  • Examples: Database connection issues, error retrieving allocations data, error transforming allocation data for response.

Requires access token scope: settlement_network_read

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

Path parameters

enterpriseIdstring required

Query parameters

allocationIdsstring[]

Optional array of allocationIds. If provided will only return allocations/deallocations with those ids. allocationIds are unique identifiers (UUIDs) for allocations. UUIDs must be submitted as a comma-separated string.

typesstring[]

Optional array of types. If provided will only return allocations/deallocations with those types. Types must be submitted as a comma-separated string. allocation = records for allocations to connections. deallocation = records for deallocations from connections.

statusesstring[]

Optional array of statuses. If provided will only return allocations/deallocations with those statuses. Statuses must be submitted as a comma-separated string. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.

currenciesstring[]

Optional array of currencies. If provided will only return allocations/deallocations with those currencies. Currencies must be submitted as a comma-separated string.

connectionIdsstring[]

Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds. ConnectionIds must be submitted as a comma-separated string.

partnerIdsstring[]

Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds. PartnerIds must be submitted as a comma-separated string.

createdOnOrAfterstring date-time

Optional date start range filter for createdAt (ISO Date). If provided will only return allocations/deallocations created on or after this date. This date should be in ISO 8601 format (e.g., 2023-01-01T00:00:00Z).

createdBeforestring date-time

Optional date end range filter for createdAt (ISO Date). If provided will only return allocations/deallocations created on or before this date. This date should be in ISO 8601 format (e.g., 2023-01-01T00:00:00Z).

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.

sortField'id' | 'updatedAt' | 'quantity' | 'currency'

The field to sort results on.

Possible values:

  • id: Sort by allocation ID.
  • updatedAt: Sort by the last updated timestamp.
  • quantity: Sort by the allocation amount quantity.
  • currency: Sort by the allocation currency code.

Note: A finals sort is always applied on createdAt ascending and id ascending, regardless of the specified sortField. This ensures consistent ordering for items with the same primary sort value.

sortDirection'ASC' | 'DESC'

The direction to sort results.

Possible values:

  • ASC: Ascending order (lowest to highest, A to Z, oldest to newest).
  • DESC: Descending order (highest to lowest, Z to A, newest to oldest).

If not specified, defaults to ASC (ascending).

Response

OK