Skip to main content
POST
/
v2
/
wallets
/
{id}
/
withdrawals
/
{withdrawalId}
/
cancel
Cancel a withdrawal
curl --request POST \
  --url https://sandbox.groundtech.co/v2/wallets/{id}/withdrawals/{withdrawalId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "amountUsd": "<string>", "feeUsd": "<string>", "destinationChain": "<string>", "destinationAddress": "<string>", "status": "pending", "txHash": "<string>", "failureReason": "<string>", "createdAt": "2023-11-07T05:31:56Z", "completedAt": "2023-11-07T05:31:56Z" }

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Wallet ID

​
withdrawalId
string<uuid>
required

Withdrawal ID

Body

application/json
​
requestId
string<uuid>
required

Idempotency key for the cancellation request.

Response

Withdrawal cancelled

​
id
string<uuid>
​
amountUsd
string

Withdrawal amount in USD as a formatted string.

​
feeUsd
string | null

Fee charged for the withdrawal as a formatted string.

​
destinationChain
string
​
destinationAddress
string
​
status
enum<string>

Simplified withdrawal status.

Available options:
pending,
processing,
completed,
failed,
cancelled
​
txHash
string | null

On-chain transaction hash once the withdrawal is broadcast.

​
failureReason
string | null

Human-readable reason for failure (only present when status is failed).

​
createdAt
string<date-time>
​
completedAt
string<date-time> | null