Create a withdrawal

POST

https://api.t-dx.com/api/rest/v1/withdrawals

POST

/api/rest/v1/withdrawals

curl -X POST https://api.t-dx.com/api/rest/v1/withdrawals \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "subAccountId": "7376524e-6b6b-4137-9719-7e07a7709804",
  "instrumentId": "5321bef2-155d-40c7-aa63-5d18f5f6dc29",
  "quantity": "5000.0"
}'

{
  "result": {
    "id": "e8e080f7-46c5-44f6-9fdb-644a7ed725c0",
    "clientAccountId": "4fd06c61-827d-4a00-a862-f526accef318",
    "subAccountId": "7376524e-6b6b-4137-9719-7e07a7709804",
    "userId": "6055e243-84e0-4e00-8007-90fed5b5d01b",
    "instrumentId": "5321bef2-155d-40c7-aa63-5d18f5f6dc29",
    "quantity": "5000.0",
    "status": "STATUS_ACTIVE",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "externalId": "string",
    "fee": "10.0",
    "messageId": "string",
    "valuedAt": "2024-01-15T09:30:00Z",
    "externalAddressId": "8cd637a8-bd4b-4c86-9fdc-5019614d4e13",
    "feeInstrumentId": "5321bef2-155d-40c7-aa63-5d18f5f6dc29",
    "instrument": {
      "id": "797a9b93-66ac-48a1-b81a-214ad3e6216e",
      "fullName": "Bitcoin",
      "shortName": "BTC",
      "symbol": "BTC",
      "decimals": 8
    },
    "type": "TYPE_BANK_TRANSFER",
    "bankAccountId": "ab18b3b6-cb3e-437c-99aa-50226234474f",
    "attributes": [
      {
        "id": "5c18d726-542e-4128-9f64-d6d0755ad972",
        "owner": "owner",
        "type": "type",
        "subType": "sub-type",
        "key": "key",
        "value": "value",
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "withdrawalId": "e8e080f7-46c5-44f6-9fdb-644a7ed725c0",
        "subAccountId": "865cf287-9f6f-41cd-a8c7-34f7d5f9f511",
        "clientAccountId": "3f23fe65-5d42-4142-b18a-b85a2d7c4549"
      }
    ],
    "externalAddress": {
      "id": "797a9b93-66ac-48a1-b81a-214ad3e6216e",
      "address": "0xb794f5ea0ba39494ce839613fffba74279579268",
      "label": "Address label"
    }
  }
}

This endpoint creates a withdrawal for a instrument that will be sent either to a bank account or a cryptocurrency address depending on the type of the instrument. It returns the details about the withdrawal when it has successfully been created, otherwise it returns an error message.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

subAccountIdstringRequiredformat: "uuid"

Identifier of the sub-account that will be debited.

instrumentIdstringRequiredformat: "uuid"

Identifier of the instrument of the withdrawal.

quantitystringRequiredformat: "decimal"

Quantity of the withdrawal. Must be greater than zero.

bankAccountIdstringOptionalformat: "uuid"

The unique identifier of a bank account of the account.

externalAddressIdstringOptionalformat: "uuid"

The unique identifier of a whitelisted external address.

Response

A successful response.

resultobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error