Ctrl+K

Patch external deposits for an on-chain settlement

patch/api/network/v1/admin/settlements/onchain/deposits/removefrompolling

Admin route to eliminate unnecessary polling of external deposits tied to an on-chain settlement. This endpoint allows BitGo administrators to mark specific external deposits as no longer requiring polling, optimizing system performance by reducing unnecessary blockchain queries for deposits that have been finalized or are no longer relevant.

Query Parameters

  • trustOrgstringRequired
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1

Request Body

txId string required
Min length: >= 1 characters
currency string required

200 Response

deposit object required
The deposit object that was affected by the operation.
onChainTxId string required
Min length: >= 1 characters
transferId string
currency string required
quantity number
id string required
settlementId string required
createdAt string <date-time>required
ISO-formatted creation timestamp of the deposit record.
updatedAt string <date-time>required
ISO-formatted timestamp of the last update to the deposit record.

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

409 Response

error string required

500 Response

error string required