Update Partner Allocations

Path Params

• enterpriseId string required

  at least 1 characters

Body Params

object

• allocationId 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).
  amount object

  • currency string required

    at least 1 characters
  • quantity string required
• clientId string required
  The unique identifier of the client associated with the allocation. This UUID uniquely identifies the client within the BitGo system.
• connectionId string required
  The unique identifier of the connection associated with the allocation. This UUID uniquely identifies the connection between a client and a partner.
• partnersClientId string required
  The unique identifier of the client in the partner system. This value uniquely identifies the client within the partner's system.

  at least 1 characters
• partnersConnectionId string required
  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.

  at least 1 characters
• partnersAllocationId string required
  The unique identifier of the allocation in the partner system. This value uniquely identifies the allocation record within the partner's system.

  at least 1 characters
• evaluationId string
  The unique identifier of the policy evaluation for this deallocation. Present when policy evaluation was performed as part of the deallocation update flow.

  at least 1 characters
• pendingApprovalId string
  The unique identifier of the pending approval for this deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.

  at least 1 characters
• policyResult 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.
  approvedrejected
  approvedrejected
• status 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.
  clearedreleased
  clearedreleased
• nonce string required

  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.

  at least 1 characters
• rejectReason string
  The reason for releasing the allocation.

  at least 1 characters
• payload string required

  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.

  at least 1 characters
• signature string required

  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.

  at least 1 characters

Responses