Sign in

v1

latestOpenAPI 3.0.32026-07-26184851.6 MB
Transactions

Trigger Asset Sweep

Trigger Asset Sweep

This endpoint is used to initiate a sweep of assets for a specific transaction within a wallet

post/v1/wallets/{walletId}/transactions/sweep/assets

Headers

x-api-keystring
Example:ochXKmSkc2kbz+6baHxf6FRgcbK9iHItOtWl80uJBVXfZnmHCNKLzeYHaoV2pPmlMmcrh+tNkkKpxslc2FAIxA==

Request body

forceSweepstring
transactionIdstring

Example request

{
  "forceSweep": "OPTIONAL_BOOLEAN",
  "transactionId": "92d9542b-9522-4a5d-917f-c0786627b061"
}

Response

200

messagestring
statusCodenumber

Example response

{
  "message": "Sweep initiated successfully",
  "statusCode": 200
}