API References

Update Partner Allocations

put
https://app.bitgo-test.com/api/network/v1/enterprises//partners/allocations

This API call allows partners to inform the OES system about an update to an allocation made to one of their connections. This endpoint is only relevant to OES partners that have async allocations enabled.

A successful response indicates that the allocation was successfully updated in the OES system and the funds are cleared (if cleared is passed for status) or released (if released is passed for status).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1
Body Params
string
required

The unique identifier of the allocation to update. This UUID uniquely identifies the allocation record.

amount
object
required

The currency/quantity the allocation was made in. This is a base unit amount. The exact base units depend on the currency (e.g., satoshis for BTC, wei for ETH).

string
required

The unique identifier of the client associated with the allocation. This UUID uniquely identifies the client within the BitGo system.

string
required

The unique identifier of the connection associated with the allocation. This UUID uniquely identifies the connection between a client and a partner.

string
required
length ≥ 1

The unique identifier of the client in the partner system. This value uniquely identifies the client within the partner's system.

string
required
length ≥ 1

The unique identifier of the connection in the partner system. This value uniquely identifies the connection between a client and a partner in the partner's system.

string
required
length ≥ 1

The unique identifier of the allocation in the partner system. This value uniquely identifies the allocation record within the partner's system.

string
length ≥ 1

The unique identifier of the policy evaluation for this deallocation. Present when policy evaluation was performed as part of the deallocation update flow.

string
length ≥ 1

The unique identifier of the pending approval for this deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.

string
enum

The result of the policy evaluation for this deallocation.

  • APPROVED: Policy evaluation passed and the operation was allowed
  • REJECTED: Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.
Allowed:
string
enum
required

The status to update the allocation to. The status can be either 'cleared' or 'released'. If the status is 'released', a reason for the release must be provided in the form of a non-empty string.

Allowed:
string
required
length ≥ 1

Unique nonce to prevent replay attacks.

This value:

  • Must be unique for each request requiring a nonce.
  • Should be a cryptographically strong random value.
  • Is used as part of the request signing process.
  • Helps ensure the signature can only be used once.
string
length ≥ 1

The reason for releasing the allocation.

string
required
length ≥ 1

Payload formed by stringifying the object containing all other request properties.

This includes:

  • status
  • rejectReason (only if status is 'released')
  • allocationId
  • amount
  • clientId
  • connectionId
  • partnersClientId
  • partnersConnectionId
  • partnersAllocationId
  • nonce

The payload must be signed using your BitGo account's private key to create the signature parameter.

string
required
length ≥ 1

Digital signature of the payload parameter.

This signature:

  • Must be created using your BitGo account's private key.
  • Verifies that the request is authentic and hasn't been tampered with.
  • Provides non-repudiation for the allocation request.
Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago