Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Partner Allocations & Deallocations

List partner allocations and deallocations

Lists all allocations and deallocations. For use only by OES partners.

Requires access token scope: settlement_network_read

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

Path parameters

enterpriseIdstring required

Query parameters

allocationIdsstring[]

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

typesstring[]

Optional array of types. If types are provided, only allocations/deallocations with those types are returned. 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 statuses are provided, only allocations/deallocations with those statuses are returned. 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 partner mapped currencies. If currencies are provided, only allocations/deallocations with those currencies are returned. Currencies must be submitted as a comma-separated string.

connectionIdsstring[]

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

partnerIdsstring[]

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

clientIdsstring[]

Optional array of clientIds. If clientIds are provided, only allocations/deallocations for those clientIds are returned. ClientIds must be submitted as a comma-separated string.

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'

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.

Note: A final 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