1. Counterparties management

On this page you can see how you should work with counterparties.

Working with counterparties you have the following features:

Create counterparty

Update counterparty attributes

1. Counterparties management

Show counterparty attributes

Create counterparty

A counterparty is created together with 2 accounts: emission account and processing account.

Create counterparty

post

Create counterparty

Body

application/json

asset_codestringOptional

AssetCode first emission account

asset_issuerstringOptional

AssetIssuer first emission account

descriptionstringOptional

optional

guidstringOptional

GUID if guid is zero, generate new random guid if guid exist return error

holding_namestringOptional

optional

namestringOptional

Name unique counterparty name

user_auth_urlstringOptional

UserAuthURL url where we can request user authorization on counterparty side

user_id_urlstringOptional

UserIDURL url where we can request user id on counterparty side

user_key_urlstringOptional

UserKeyURL url where we can request user key on counterparty side

Responses

200

OK

application/json

400

json with error msg

application/json

post

/counterparties

HTTPcURLJavaScriptPython

POST /api/v1/counterparties HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "asset_code": "text",
  "asset_issuer": "text",
  "description": "text",
  "guid": "text",
  "holding_name": "text",
  "name": "text",
  "user_auth_url": "text",
  "user_id_url": "text",
  "user_key_url": "text"
}

{
  "emission_account_guid": "text",
  "guid": "text",
  "processing_account_guid": "text"
}

Update counterparty attributes

Update counterparty

put

Update counterparty fields by guid

Body

application/json

descriptionstringOptional

Counterparty's description

holding_namestringOptional

Counterparty's holding name

namestringOptional

Counterparty's unique name

user_auth_urlstringOptional

URL where DCM can request user authorization on the counterparty's side

user_id_urlstringOptional

URL where DCM can request a user ID on the counterparty's side

user_key_urlstringOptional

URL where DCM can request a user key on the counterparty's side

Responses

200

OK

application/json

Responseobject

400

json with error msg

application/json

put

/counterparties/{counterparty_guid}

HTTPcURLJavaScriptPython

PUT /api/v1/counterparties/{counterparty_guid} HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "description": "text",
  "holding_name": "text",
  "name": "text",
  "user_auth_url": "text",
  "user_id_url": "text",
  "user_key_url": "text"
}

{}

Get the list of counterparties

Get counterparties list

get

Get counterparties list

Query parameters

guidsstring[]Optional

Counterparty's GUIDs

namesstring[]Optional

Counterparty's names

holding_namesstring[]Optional

Counterparty's holding names

offsetintegerOptional

Offset

limitintegerOptional

Limit

orderingstring · enumOptional

Ordering by created_at

Possible values:

Responses

200

OK

application/json

400

json with error msg

application/json

get

/counterparties

HTTPcURLJavaScriptPython

GET /api/v1/counterparties HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Accept: */*

{
  "counterparties": [
    {
      "created_at": "text",
      "description": "text",
      "guid": "text",
      "holding_name": "text",
      "name": "text",
      "updated_at": "text",
      "user_auth_url": "text",
      "user_id_url": "text",
      "user_key_url": "text"
    }
  ],
  "total": 1
}

Show counterparty attributes

To show a counterparty attributes you should do the previuos request and to find the counterparty you need with an appropriate guid.