List deposits of a sub-account

GET

https://api.t-dx.com/api/rest/v1/deposits/by-sub-account/:subAccountId

GET

/api/rest/v1/deposits/by-sub-account/:subAccountId

curl -G https://api.t-dx.com/api/rest/v1/deposits/by-sub-account/7376524e-6b6b-4137-9719-7e07a7709804 \
     -H "Authorization: Bearer <token>" \
     -d cursor=eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ \
     -d fields=instrument \
     -d query=instrument_id \
     -d query=status

{
  "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"
    }
  ],
  "pagination": {
    "cursors": {
      "self": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "first": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "last": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "next": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "previous": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ=="
    }
  },
  "sortingKeys": [
    {
      "key": "created_at-asc",
      "dir": "asc",
      "label": "key.deposits.sorts.created_at-asc",
      "fieldKey": "created_at"
    }
  ],
  "filters": [
    {
      "key": "instrument_id",
      "label": "key.deposits.filters.instrument_id",
      "filterType": "FILTER_TYPE_VALUES",
      "valueType": "VALUE_TYPE_UUID"
    }
  ],
  "query": [
    "string"
  ]
}

It returns the deposits that belong to the sub-account. The authenticateduser must have access to the sub-account.

The reply is an array of the deposits.

Authentication

AuthorizationBearer

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

Path parameters

subAccountIdstringRequiredformat: "uuid"

Identifier of the sub-account that will be credited.

Query parameters

sortstringOptionalformat: "(created_at-asc|created_at-desc)"Defaults to created_at-asc

Optionally sort the results

limitstringOptionalformat: "uint64"Defaults to 20

Optionally limit the number of results (between 1 and 500)

querylist of stringsOptional

Optionally filter the results

cursorstringOptionalformat: "base64"

Optionally provide a cursor to paginate over pages of results

fieldslist of stringsOptional

Optionally load some sub-resources

Response

A successful response.

resultlist of objects

paginationobject

sortingKeyslist of objects

filterslist of objects

List of filters available for that endpoint.

querylist of stringsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error