List pending operations

GET

https://api.t-dx.com/api/rest/v1/pending-operations

GET

/api/rest/v1/pending-operations

curl -G https://api.t-dx.com/api/rest/v1/pending-operations \
     -H "Authorization: Bearer <token>" \
     -d fields=approvals \
     -d query=status \
     -d query=entity_type \
     -d query=entity_id \
     -d subAccountId=7376524e-6b6b-4137-9719-7e07a7709804

{
  "result": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "clientAccountId": "4fd06c61-827d-4a00-a862-f526accef318",
      "subAccountId": "7376524e-6b6b-4137-9719-7e07a7709804",
      "creatorUserId": "6055e243-84e0-4e00-8007-90fed5b5d01b",
      "entityType": "ENTITY_TYPE_WITHDRAWAL",
      "entityId": "e8e080f7-46c5-44f6-9fdb-644a7ed725c0",
      "status": "STATUS_PENDING",
      "requiredNumApproval": 1,
      "currentNumApproval": 0,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "approvals": [
        {
          "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          "pendingOperationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "userId": "6055e243-84e0-4e00-8007-90fed5b5d01b",
          "decision": "DECISION_APPROVED",
          "createdAt": "2024-01-15T09:30:00Z",
          "message": "string"
        }
      ]
    }
  ],
  "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",
      "range": {
        "min": "1",
        "max": "5000"
      },
      "values": [
        {
          "key": "STATUS_NEW",
          "label": "key.deposits.filters.status.fields.new"
        }
      ],
      "filterType": "FILTER_TYPE_VALUES",
      "valueType": "VALUE_TYPE_STRING"
    }
  ],
  "query": [
    "string"
  ]
}

This endpoint returns the list of pending operations for the authenticated user's client account.

Authentication

AuthorizationBearer

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

Query parameters

subAccountIdstringOptionalformat: "uuid"

Optionally filter by sub-account impacted by the pending operation.

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

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