Sign in
Partner Allocations & Deallocations

Update Partner Deallocations

This API call allows partners to inform the OES system about an update to a deallocation made to one of their connections. This endpoint is only relevant to OES partners that have async deallocations 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).

Requires access token scopes: settlement_network_read, settlement_network_write

put/api/network/v1/enterprises/{enterpriseId}/partners/deallocations

Path parameters

enterpriseIdstring required

Request body

deallocationIdstring required

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

clientIdstring required

The unique identifier of the client which initiated the deallocation. This UUID uniquely identifies the client within the BitGo system.

connectionIdstring required

The unique identifier of the connection to deallocate from. This UUID uniquely identifies the connection between a client and a partner.

partnersClientIdstring required

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

partnersConnectionIdstring 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.

partnersDeallocationIdstring required

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

evaluationIdstring

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

pendingApprovalIdstring

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

policyResult'approved' | 'rejected'

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.
status'cleared' | 'released' required
noncestring 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.
rejectReasonstring

The reason for releasing the deallocation.

payloadstring required

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

This includes:

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

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

signaturestring 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.

Response

OK

deallocationIdstring required

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

clientIdstring required

The unique identifier of the client which initiated the deallocation. This UUID uniquely identifies the client within the BitGo system.

connectionIdstring required

The unique identifier of the connection to deallocate from. This UUID uniquely identifies the connection between a client and a partner.

partnersClientIdstring required

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

partnersConnectionIdstring 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.

partnersDeallocationIdstring required

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

evaluationIdstring

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

pendingApprovalIdstring

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

policyResult'approved' | 'rejected'

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.

Changes

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