Sign in
Client Allocations & Deallocations

Get client allocation or deallocation

Returns an allocation or deallocation. For use only by OES clients.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or incomplete.

  • Examples: Invalid UUID format for allocationId, invalid enterpriseId format.

  • 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 requested allocation does not exist for this client

  • Examples: Allocation with specified ID doesn't exist, allocation exists but belongs to different client

  • 500: Internal Server Error

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

  • Examples: Database connection failure, currency mapping error, error transforming allocation data for response

Requires access token scope: settlement_network_read

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

Path parameters

allocationIdstring required

The unique identifier of the allocation to retrieve. This is a UUID that uniquely identifies the allocation record.

enterpriseIdstring required

The enterprise identifier of the client. This identifies the client enterprise that owns the allocation.

Response

OK

Changes

No recorded changes to this endpoint across all 18 revisions of this API.