Create a deposit

POST

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

POST

/api/rest/v1/deposits

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

{
  "result": {
    "id": "29da2ce3-c2d8-4a13-b225-ce9e90ff5224",
    "clientAccountId": "3f23fe65-5d42-4142-b18a-b85a2d7c4549",
    "subAccountId": "865cf287-9f6f-41cd-a8c7-34f7d5f9f511",
    "userId": "6055e243-84e0-4e00-8007-90fed5b5d01b",
    "externalId": "string",
    "declaredQuantity": "5000.75",
    "status": "STATUS_NEW",
    "type": "TYPE_BANK_TRANSFER",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "sourceType": "SOURCE_TYPE_BANK_ACCOUNT",
    "instrumentId": "797a9b93-66ac-48a1-b81a-214ad3e6216e",
    "receivedQuantity": "4500.0",
    "messageId": "string",
    "referenceNumber": "string",
    "valuedAt": "2024-01-15T09:30:00Z",
    "cryptoTransactionId": "string",
    "externalAddressId": "1c3defe8-c1ce-44d7-8006-9a4e15326f0e",
    "thirdPartyExchange": "THIRD_PARTY_EXCHANGE_BITSTAMP",
    "fee": "10.0",
    "attributes": [
      {
        "id": "5c18d726-542e-4128-9f64-d6d0755ad972",
        "depositId": "29da2ce3-c2d8-4a13-b225-ce9e90ff5224",
        "subAccountId": "865cf287-9f6f-41cd-a8c7-34f7d5f9f511",
        "clientAccountId": "3f23fe65-5d42-4142-b18a-b85a2d7c4549",
        "owner": "owner",
        "type": "type",
        "subType": "sub-type",
        "key": "key",
        "value": "value",
        "contentType": "text/plain",
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "isFile": true
      }
    ],
    "instrument": {
      "id": "797a9b93-66ac-48a1-b81a-214ad3e6216e",
      "fullName": "Bitcoin",
      "shortName": "BTC",
      "symbol": "BTC",
      "decimals": 8
    },
    "externalAddress": {
      "id": "797a9b93-66ac-48a1-b81a-214ad3e6216e",
      "address": "0xb794f5ea0ba39494ce839613fffba74279579268",
      "label": "Address label"
    },
    "bankAccountId": "1c3defe8-c1ce-44d7-8006-9a4e15326f0e",
    "bankAccount": {
      "id": "797a9b93-66ac-48a1-b81a-214ad3e6216e",
      "label": "Bank account label"
    },
    "tax": "10.0"
  }
}

It creates a deposit either coming from a cryptocurrency external address or coming from a traditional bank transfer. In case of a deposit from an external exchange, you must provide the source. The reply contains the information about the new deposit when it has been created successfully.

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 credited.

instrumentIdstringRequiredformat: "uuid"

Identifier of the instrument of the deposit.

declaredQuantitystringRequiredformat: "decimal"

Quantity of the deposit. Must be greater than zero.

sourceTypeenumRequired

externalAddressIdstringOptionalformat: "uuid"

Optional identifier of one of the external address of the account.

thirdPartyExchangeenumOptional

Allowed values:

bankAccountIdstringOptionalformat: "uuid"

Optional identifier of one of the bank account of the account.

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