Tradelink

Get Tradelink network instance

get

Get the materialized Tradelink Network configuration of workspace

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

or

nullOptional

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/tradelink/network

HTTPcURLJavaScriptPython

GET /v1/rest/tradelink/network HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "custodian": {
    "id": "text",
    "settlement": [
      {
        "quorum": 1,
        "userIds": [
          "text"
        ]
      }
    ],
    "withdraw": [
      {
        "quorum": 1,
        "userIds": [
          "text"
        ]
      }
    ],
    "arbitration": [
      {
        "quorum": 1,
        "userIds": [
          "text"
        ]
      }
    ]
  },
  "exchanges": [
    {
      "type": "ASSET_MANAGER",
      "id": "text",
      "tradelinkId": "text",
      "groups": [
        {
          "quorum": 1,
          "userIds": [
            "text"
          ]
        }
      ],
      "whitelist": [
        {
          "name": "text",
          "currency": "text",
          "address": "text"
        }
      ]
    }
  ],
  "assetManagers": [
    {
      "type": "ASSET_MANAGER",
      "id": "text",
      "tradelinkId": "text",
      "groups": [
        {
          "quorum": 1,
          "userIds": [
            "text"
          ]
        }
      ],
      "whitelist": [
        {
          "name": "text",
          "currency": "text",
          "address": "text"
        }
      ]
    }
  ]
}

Get Tradelink network blueprint

get

Get the Tradelink network blueprint with all available Network configuration options

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

or

nullOptional

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/tradelink/network/blueprint

HTTPcURLJavaScriptPython

GET /v1/rest/tradelink/network/blueprint HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tradelinkId": "text",
  "workspaceName": "text",
  "custodian": {
    "tradelinkId": "text",
    "name": "text",
    "code": "text",
    "logoUrl": "text"
  },
  "assetManagers": [
    {
      "tradelinkId": "text",
      "name": "text",
      "code": "text",
      "logoUrl": "text"
    }
  ],
  "exchanges": [
    {
      "tradelinkId": "text",
      "name": "text",
      "code": "text",
      "logoUrl": "text"
    }
  ]
}

Get Tradelink settlements

get

Get the Tradelink settlements for the workspace

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

pledgeIdstringOptional

accountIdstringOptional

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/tradelink/settlements

HTTPcURLJavaScriptPython

GET /v1/rest/tradelink/settlements HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "pledgeId": "text",
      "state": "REGISTERED",
      "outboundTransactionHash": "text",
      "accountId": "text",
      "exchangeId": "text"
    }
  ]
}

Get Tradelink settlement

get

Get a Tradelink settlement by its Id

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

settlementIdstringRequired

Responses

200

Successful response

application/json

idstringRequired

Settlement ID

pledgeIdstringRequired

Pledge ID associated with the settlement

statestring · enumRequired

State of the settlement

Possible values:

outboundTransactionHashany ofRequired

Outbound transaction hash of the settlement

stringOptional

or

nullOptional

accountIdstringRequired

Account ID associated with the settlement

exchangeIdstringRequired

Exchange ID associated with the settlement

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/tradelink/settlements/{settlementId}

HTTPcURLJavaScriptPython

GET /v1/rest/tradelink/settlements/{settlementId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "pledgeId": "text",
  "state": "REGISTERED",
  "outboundTransactionHash": "text",
  "accountId": "text",
  "exchangeId": "text"
}