Initialize a digital asset withdrawal

POST 
/v1/digital/withdrawal

Starts the digital asset withdrawal process. This endpoint:

• Validates withdrawal details and user membership
• Creates a withdrawal record
• Calculates and charges appropriate fees
• Initiates transaction within appropriate Blockchain Network
• Returns withdrawal initial data
• Supports various digital assets
• Transaction will trigger following webhooks, if underlaying statuses are met: WITHDRAW_TRANSACTION_INITIALIZED, WITHDRAW_TRANSACTION_FAILED and WITHDRAW_TRANSACTION_SUCCEEDED

Request

application/json

Body

required

Digital asset withdrawal initialization data

userId stringrequired

User ID

walletId stringrequired

Unique identifier for the wallet

amount stringrequired

Amount to withdraw

assetId stringrequired

Asset identifier (UUID, type string like BTC, or ISO 4217 code)

destinationAddress stringrequired

Destination digital address

details stringrequired

Description or details of the withdrawal

referenceNumber string

Reference number for the withdrawal (optional)

destinationMemo string

Destination memo/tag for supported cryptocurrencies

externalTxId string

External transaction ID for tracking purposes

amountIsGross boolean

Whether the amount includes fees (gross amount)

Responses

201

The digital asset withdrawal process was started successfully.

application/json

Schema

Schema

traceId string
message string

data

object

id stringrequired

endToEndId stringrequired

externalDestination stringrequired

externalSource stringrequired

type stringrequired

status stringrequired

amount stringrequired

currencyCode stringrequired

platform stringrequired

referenceNumber stringrequired

note stringrequired

sourceWallet

object

required

accountNumber stringrequired

address stringrequired

nickname stringrequired

archived booleanrequired

destinationWallet

object

required

accountNumber stringrequired

address stringrequired

nickname stringrequired

archived booleanrequired

asset stringrequired

createdAt date-timerequired

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": {
    "id": "string",
    "endToEndId": "string",
    "externalDestination": "string",
    "externalSource": "string",
    "type": "string",
    "status": "string",
    "amount": "string",
    "currencyCode": "string",
    "platform": "string",
    "referenceNumber": "string",
    "note": "string",
    "sourceWallet": {
      "accountNumber": "string",
      "address": "string",
      "nickname": "string",
      "archived": true
    },
    "destinationWallet": {
      "accountNumber": "string",
      "address": "string",
      "nickname": "string",
      "archived": true
    },
    "asset": "string",
    "createdAt": "2024-07-29T15:51:28.071Z"
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...